{
  "info": {
    "name": "Axis Unified Inbox API — Contacts & Segments",
    "description": "# Axis Unified Inbox API\n\nContacts & Segments — 24 endpoints, generated from the Laravel route table on Tue, 04 Aug 2026 12:47:23 GMT.\n\n## Getting started\n\n1. Set the `baseUrl` collection variable if you are not using the default.\n2. Run **Authentication → `POST /user/login`** with your email and password.\n   A test script stores the returned JWT into `{{access_token}}` automatically.\n3. Every other request inherits that bearer token — just hit Send.\n\nRequests using an API key instead read `{{api_key}}` or `{{engage_key}}`; set those\nvariables if you need them.\n\n## Variables\n\n| Variable | Purpose |\n| --- | --- |\n| `baseUrl` | API host, e.g. `https://api.axis.im` |\n| `access_token` | JWT bearer token (auto-filled by the login request) |\n| `api_key` | Value for the `X-API-KEY` header |\n| `engage_key` | Value for the `X-Axis-Admin-API-Key` header |",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
    "_exporter_id": "axis-api-docs"
  },
  "auth": {
    "type": "bearer",
    "bearer": [
      {
        "key": "token",
        "value": "{{access_token}}",
        "type": "string"
      }
    ]
  },
  "item": [
    {
      "name": "GET /contacts",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/contacts",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "contacts"
          ]
        },
        "description": "**Authentication:** JWT (user)\n**Required permissions:** `viewAny` on `Contacts.Contact`\n**Handler:** `Contacts\\ContactController@index`\n**Route name:** `contacts.index`"
      },
      "response": []
    },
    {
      "name": "POST /contacts",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/contacts",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "contacts"
          ]
        },
        "description": "**Authentication:** JWT (user)\n**Required permissions:** `create` on `Contacts.Contact`\n**Handler:** `Contacts\\ContactController@store`\n**Route name:** `contacts.store`\n\n> This endpoint accepts a body, but no `FormRequest` class backs it — validation happens\n> inline in the controller, so the fields could not be derived automatically. An empty JSON\n> body is provided as a starting point.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      },
      "response": []
    },
    {
      "name": "DELETE /contacts/{contact}",
      "request": {
        "method": "DELETE",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/contacts/:contact",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "contacts",
            ":contact"
          ],
          "variable": [
            {
              "key": "contact",
              "value": "",
              "description": "contact identifier"
            }
          ]
        },
        "description": "**Authentication:** JWT (user)\n**Required permissions:** `delete` on `contact`\n**Handler:** `Contacts\\ContactController@destroy`\n**Route name:** `contacts.destroy`"
      },
      "response": []
    },
    {
      "name": "GET /contacts/{contact}",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/contacts/:contact",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "contacts",
            ":contact"
          ],
          "variable": [
            {
              "key": "contact",
              "value": "",
              "description": "contact identifier"
            }
          ]
        },
        "description": "**Authentication:** JWT (user)\n**Required permissions:** `view` on `contact`\n**Handler:** `Contacts\\ContactController@show`\n**Route name:** `contacts.show`"
      },
      "response": []
    },
    {
      "name": "PUT /contacts/{contact}",
      "request": {
        "method": "PUT",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/contacts/:contact",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "contacts",
            ":contact"
          ],
          "variable": [
            {
              "key": "contact",
              "value": "",
              "description": "contact identifier"
            }
          ]
        },
        "description": "**Authentication:** JWT (user)\n**Required permissions:** `update` on `contact`\n**Handler:** `Contacts\\ContactController@update`\n**Route name:** `contacts.update`\n\n> This endpoint accepts a body, but no `FormRequest` class backs it — validation happens\n> inline in the controller, so the fields could not be derived automatically. An empty JSON\n> body is provided as a starting point.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      },
      "response": []
    },
    {
      "name": "GET /contacts/{contact}/edit",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/contacts/:contact/edit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "contacts",
            ":contact",
            "edit"
          ],
          "variable": [
            {
              "key": "contact",
              "value": "",
              "description": "contact identifier"
            }
          ]
        },
        "description": "**Authentication:** JWT (user)\n**Required permissions:** `update` on `contact`\n**Handler:** `Contacts\\ContactController@edit`\n**Route name:** `contacts.edit`"
      },
      "response": []
    },
    {
      "name": "GET /contacts/create",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/contacts/create",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "contacts",
            "create"
          ]
        },
        "description": "**Authentication:** JWT (user)\n**Required permissions:** `create` on `Contacts.Contact`\n**Handler:** `Contacts\\ContactController@create`\n**Route name:** `contacts.create`"
      },
      "response": []
    },
    {
      "name": "GET /contacts/summary",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/contacts/summary",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "contacts",
            "summary"
          ]
        },
        "description": "**Authentication:** JWT (user)\n**Handler:** `Contacts\\ContactController@summary`"
      },
      "response": []
    },
    {
      "name": "POST /contacts/support",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/contacts/support",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "contacts",
            "support"
          ]
        },
        "description": "**Authentication:** JWT (user)\n**Handler:** `Contacts\\ContactController@contactSupport`\n\n> This endpoint accepts a body, but no `FormRequest` class backs it — validation happens\n> inline in the controller, so the fields could not be derived automatically. An empty JSON\n> body is provided as a starting point.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      },
      "response": []
    },
    {
      "name": "GET /contacts/template",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/contacts/template",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "contacts",
            "template"
          ]
        },
        "description": "**Authentication:** JWT (user)\n**Handler:** `Contacts\\ContactController@download_template`"
      },
      "response": []
    },
    {
      "name": "POST /contacts/upload",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/contacts/upload",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "contacts",
            "upload"
          ]
        },
        "description": "**Authentication:** JWT (user)\n**Handler:** `Contacts\\ContactController@upload_contacts`\n\n> This endpoint accepts a body, but no `FormRequest` class backs it — validation happens\n> inline in the controller, so the fields could not be derived automatically. An empty JSON\n> body is provided as a starting point.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      },
      "response": []
    },
    {
      "name": "POST /contactsleads",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/contactsleads",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "contactsleads"
          ]
        },
        "description": "**Authentication:** Optional JWT\n**Handler:** `Contacts\\ContactController@leads`\n\n> This endpoint accepts a body, but no `FormRequest` class backs it — validation happens\n> inline in the controller, so the fields could not be derived automatically. An empty JSON\n> body is provided as a starting point.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      },
      "response": []
    },
    {
      "name": "GET /segments",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/segments",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "segments"
          ]
        },
        "description": "**Authentication:** JWT (user)\n**Required permissions:** `viewAny` on `Contacts.Segment`\n**Handler:** `Contacts\\SegmentController@index`\n**Route name:** `segments.index`"
      },
      "response": []
    },
    {
      "name": "POST /segments",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/segments",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "segments"
          ]
        },
        "description": "**Authentication:** JWT (user)\n**Required permissions:** `create` on `Contacts.Segment`\n**Handler:** `Contacts\\SegmentController@store`\n**Route name:** `segments.store`\n\n> This endpoint accepts a body, but no `FormRequest` class backs it — validation happens\n> inline in the controller, so the fields could not be derived automatically. An empty JSON\n> body is provided as a starting point.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      },
      "response": []
    },
    {
      "name": "POST /segments/{id}/add_contact",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/segments/:id/add_contact",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "segments",
            ":id",
            "add_contact"
          ],
          "variable": [
            {
              "key": "id",
              "value": "",
              "description": "id identifier"
            }
          ]
        },
        "description": "**Authentication:** JWT (user)\n**Handler:** `Contacts\\SegmentController@add_contact`\n\n> This endpoint accepts a body, but no `FormRequest` class backs it — validation happens\n> inline in the controller, so the fields could not be derived automatically. An empty JSON\n> body is provided as a starting point.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      },
      "response": []
    },
    {
      "name": "POST /segments/{id}/add_contact/bulk",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/segments/:id/add_contact/bulk",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "segments",
            ":id",
            "add_contact",
            "bulk"
          ],
          "variable": [
            {
              "key": "id",
              "value": "",
              "description": "id identifier"
            }
          ]
        },
        "description": "**Authentication:** JWT (user)\n**Handler:** `Contacts\\SegmentController@bulkAddContacts`\n\n> This endpoint accepts a body, but no `FormRequest` class backs it — validation happens\n> inline in the controller, so the fields could not be derived automatically. An empty JSON\n> body is provided as a starting point.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      },
      "response": []
    },
    {
      "name": "POST /segments/{id}/upload",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/segments/:id/upload",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "segments",
            ":id",
            "upload"
          ],
          "variable": [
            {
              "key": "id",
              "value": "",
              "description": "id identifier"
            }
          ]
        },
        "description": "**Authentication:** JWT (user)\n**Handler:** `Contacts\\SegmentController@upload_contacts`\n\n> This endpoint accepts a body, but no `FormRequest` class backs it — validation happens\n> inline in the controller, so the fields could not be derived automatically. An empty JSON\n> body is provided as a starting point.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      },
      "response": []
    },
    {
      "name": "POST /segments/{segment_id}/remove_contact/{id}",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/segments/:segment_id/remove_contact/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "segments",
            ":segment_id",
            "remove_contact",
            ":id"
          ],
          "variable": [
            {
              "key": "segment_id",
              "value": "",
              "description": "segment_id identifier"
            },
            {
              "key": "id",
              "value": "",
              "description": "id identifier"
            }
          ]
        },
        "description": "**Authentication:** JWT (user)\n**Handler:** `Contacts\\SegmentController@remove_contact`\n\n> This endpoint accepts a body, but no `FormRequest` class backs it — validation happens\n> inline in the controller, so the fields could not be derived automatically. An empty JSON\n> body is provided as a starting point.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      },
      "response": []
    },
    {
      "name": "DELETE /segments/{segment}",
      "request": {
        "method": "DELETE",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/segments/:segment",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "segments",
            ":segment"
          ],
          "variable": [
            {
              "key": "segment",
              "value": "",
              "description": "segment identifier"
            }
          ]
        },
        "description": "**Authentication:** JWT (user)\n**Required permissions:** `delete` on `segment`\n**Handler:** `Contacts\\SegmentController@destroy`\n**Route name:** `segments.destroy`"
      },
      "response": []
    },
    {
      "name": "GET /segments/{segment}",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/segments/:segment",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "segments",
            ":segment"
          ],
          "variable": [
            {
              "key": "segment",
              "value": "",
              "description": "segment identifier"
            }
          ]
        },
        "description": "**Authentication:** JWT (user)\n**Required permissions:** `view` on `segment`\n**Handler:** `Contacts\\SegmentController@show`\n**Route name:** `segments.show`"
      },
      "response": []
    },
    {
      "name": "PUT /segments/{segment}",
      "request": {
        "method": "PUT",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/segments/:segment",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "segments",
            ":segment"
          ],
          "variable": [
            {
              "key": "segment",
              "value": "",
              "description": "segment identifier"
            }
          ]
        },
        "description": "**Authentication:** JWT (user)\n**Required permissions:** `update` on `segment`\n**Handler:** `Contacts\\SegmentController@update`\n**Route name:** `segments.update`\n\n> This endpoint accepts a body, but no `FormRequest` class backs it — validation happens\n> inline in the controller, so the fields could not be derived automatically. An empty JSON\n> body is provided as a starting point.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      },
      "response": []
    },
    {
      "name": "GET /segments/{segment}/edit",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/segments/:segment/edit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "segments",
            ":segment",
            "edit"
          ],
          "variable": [
            {
              "key": "segment",
              "value": "",
              "description": "segment identifier"
            }
          ]
        },
        "description": "**Authentication:** JWT (user)\n**Required permissions:** `update` on `segment`\n**Handler:** `Contacts\\SegmentController@edit`\n**Route name:** `segments.edit`"
      },
      "response": []
    },
    {
      "name": "GET /segments/create",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/segments/create",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "segments",
            "create"
          ]
        },
        "description": "**Authentication:** JWT (user)\n**Required permissions:** `create` on `Contacts.Segment`\n**Handler:** `Contacts\\SegmentController@create`\n**Route name:** `segments.create`"
      },
      "response": []
    },
    {
      "name": "GET /segments/for-campaign",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/segments/for-campaign",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "segments",
            "for-campaign"
          ]
        },
        "description": "**Authentication:** JWT (user)\n**Handler:** `Contacts\\SegmentController@campaignSegments`"
      },
      "response": []
    }
  ],
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://api.axis.im",
      "type": "string"
    },
    {
      "key": "access_token",
      "value": "",
      "type": "string"
    },
    {
      "key": "api_key",
      "value": "",
      "type": "string"
    },
    {
      "key": "engage_key",
      "value": "",
      "type": "string"
    }
  ]
}