Create an Account [Accounts] POST /platform/api/v1/accounts Auth: Platform app API key (header api-access-token). Body fields: name. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Get the details of an account [Accounts] GET /platform/api/v1/accounts/{account_id} Auth: Platform app API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Update an account's attributes [Accounts] PATCH /platform/api/v1/accounts/{account_id} Auth: Platform app API key (header api-access-token). Body fields: name. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Delete an Account [Accounts] DELETE /platform/api/v1/accounts/{account_id} Auth: Platform app API key (header api-access-token). Destructive: this permanently deletes the resource. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

List all account users [Account Users] GET /platform/api/v1/accounts/{account_id}/account_users Auth: Platform app API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Create an Account User [Account Users] POST /platform/api/v1/accounts/{account_id}/account_users Auth: Platform app API key (header api-access-token). Body fields: user_id (required), role (required). Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Delete an Account User [Account Users] DELETE /platform/api/v1/accounts/{account_id}/account_users Auth: Platform app API key (header api-access-token). Body fields: user_id (required). Extra fields can be passed via extra_body. Destructive: this permanently deletes the resource. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

List all agent bots available [AgentBots] GET /platform/api/v1/agent_bots Auth: Platform app API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Create an agent bot [AgentBots] POST /platform/api/v1/agent_bots Auth: Platform app API key (header api-access-token). Body fields: name, description, outgoing_url. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Get the details of an agent bot [AgentBots] GET /platform/api/v1/agent_bots/{id} Auth: Platform app API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Update an agent bot's attributes [AgentBots] PATCH /platform/api/v1/agent_bots/{id} Auth: Platform app API key (header api-access-token). Body fields: name, description, outgoing_url. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Delete an agent bot [AgentBots] DELETE /platform/api/v1/agent_bots/{id} Auth: Platform app API key (header api-access-token). Destructive: this permanently deletes the resource. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Create a User [Users] POST /platform/api/v1/users Auth: Platform app API key (header api-access-token). Body fields: name, email, password, custom_attributes. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Get the details of a user [Users] GET /platform/api/v1/users/{id} Auth: Platform app API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Update a user's attributes [Users] PATCH /platform/api/v1/users/{id} Auth: Platform app API key (header api-access-token). Body fields: name, email, password, custom_attributes. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Delete a User [Users] DELETE /platform/api/v1/users/{id} Auth: Platform app API key (header api-access-token). Destructive: this permanently deletes the resource. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Get a single sign-on (SSO) login link for a user [Users] GET /platform/api/v1/users/{id}/login Auth: Platform app API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

List all agent bots available for the current account [Account AgentBots] GET /api/v1/accounts/{account_id}/agent_bots Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Create an agent bot in the account [Account AgentBots] POST /api/v1/accounts/{account_id}/agent_bots Auth: User API key (header api-access-token). Body fields: name, description, outgoing_url. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Get the details of an agent bot in the account [Account AgentBots] GET /api/v1/accounts/{account_id}/agent_bots/{id} Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Update an agent bot's attributes [Account AgentBots] PATCH /api/v1/accounts/{account_id}/agent_bots/{id} Auth: User API key (header api-access-token). Body fields: name, description, outgoing_url. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Delete an agent bot from the account [Account AgentBots] DELETE /api/v1/accounts/{account_id}/agent_bots/{id} Auth: User API key (header api-access-token). Destructive: this permanently deletes the resource. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

List all agents in the account [Agents] GET /api/v1/accounts/{account_id}/agents Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Add a new agent to the account [Agents] POST /api/v1/accounts/{account_id}/agents Auth: User API key (header api-access-token). Body fields: name (required), email (required), role, availability_status, auto_offline. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Update an agent in the account [Agents] PATCH /api/v1/accounts/{account_id}/agents/{id} Auth: User API key (header api-access-token). Body fields: role, availability, auto_offline. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Remove an agent from the account [Agents] DELETE /api/v1/accounts/{account_id}/agents/{id} Auth: User API key (header api-access-token). Destructive: this permanently deletes the resource. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

List all canned responses (saved reply templates) in the account [Canned Responses] GET /api/v1/accounts/{account_id}/canned_responses Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Add a new canned response to the account [Canned Responses] POST /api/v1/accounts/{account_id}/canned_responses Auth: User API key (header api-access-token). Body fields: content, short_code. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Update a canned response in the account [Canned Responses] PATCH /api/v1/accounts/{account_id}/canned_responses/{id} Auth: User API key (header api-access-token). Body fields: content, short_code. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Remove a canned response from the account [Canned Responses] DELETE /api/v1/accounts/{account_id}/canned_responses/{id} Auth: User API key (header api-access-token). Destructive: this permanently deletes the resource. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

List resolved contacts with pagination (15 per page). Resolved contacts are those with an identifier, email or phone number [Contacts] GET /api/v1/accounts/{account_id}/contacts Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Create a new contact in the account [Contacts] POST /api/v1/accounts/{account_id}/contacts Auth: User API key (header api-access-token). Body fields: inbox_id (required), name, email, phone_number, avatar, avatar_url, identifier, custom_attributes. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Get a contact by ID [Contacts] GET /api/v1/accounts/{account_id}/contacts/{id} Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Update a contact by ID [Contacts] PUT /api/v1/accounts/{account_id}/contacts/{id} Auth: User API key (header api-access-token). Body fields: name, email, phone_number, avatar, avatar_url, identifier, custom_attributes. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Delete a contact by ID [Contacts] DELETE /api/v1/accounts/{account_id}/contacts/{id} Auth: User API key (header api-access-token). Destructive: this permanently deletes the resource. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

List the conversations of a contact [Contacts] GET /api/v1/accounts/{account_id}/contacts/{id}/conversations Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Search resolved contacts by name, identifier, email or phone number (15 per page). Persian names and Persian-digit phone numbers are accepted [Contacts] GET /api/v1/accounts/{account_id}/contacts/search Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Filter contacts with custom filter options and pagination [Contacts] POST /api/v1/accounts/{account_id}/contacts/filter Auth: User API key or Agent bot API key (header api-access-token). Body fields: payload. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Create a contact inbox record for an inbox [Contacts] POST /api/v1/accounts/{account_id}/contacts/{id}/contact_inboxes Auth: User API key (header api-access-token). Body fields: inbox_id (required), source_id. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

List the inboxes through which a contact can be reached [Contacts] GET /api/v1/accounts/{account_id}/contacts/{id}/contactable_inboxes Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

List the labels of a contact [Contact Labels] GET /api/v1/accounts/{account_id}/contacts/{contact_identifier}/labels Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Set the labels of a contact. Replaces the contact's existing labels with the given list [Contact Labels] POST /api/v1/accounts/{account_id}/contacts/{contact_identifier}/labels Auth: User API key (header api-access-token). Body fields: labels. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Assign a conversation to an agent or a team [Conversation Assignment] POST /api/v1/accounts/{account_id}/conversations/{conversation_id}/assignments Auth: User API key (header api-access-token). Body fields: assignee_id, team_id. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

List the labels of a conversation [Conversation Labels] GET /api/v1/accounts/{account_id}/conversations/{conversation_id}/labels Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Set the labels of a conversation. Replaces the conversation's existing labels with the given list [Conversation Labels] POST /api/v1/accounts/{account_id}/conversations/{conversation_id}/labels Auth: User API key (header api-access-token). Body fields: labels. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Get conversation counts by assignment (mine, unassigned, assigned, all), with optional filters [Conversations] GET /api/v1/accounts/{account_id}/conversations/meta Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

List conversations with filters and pagination [Conversations] GET /api/v1/accounts/{account_id}/conversations Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Create a conversation for a contact in an inbox. Requires the contact inbox source_id (see gapify_create_contact_inbox) [Conversations] POST /api/v1/accounts/{account_id}/conversations Auth: User API key or Agent bot API key (header api-access-token). Body fields: source_id (required), inbox_id (required), contact_id, additional_attributes, custom_attributes, status, assignee_id, team_id, message. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Filter conversations with custom filter options and pagination [Conversations] POST /api/v1/accounts/{account_id}/conversations/filter Auth: User API key or Agent bot API key (header api-access-token). Body fields: payload. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Get a conversation's details by its display ID [Conversations] GET /api/v1/accounts/{account_id}/conversations/{conversation_id} Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Change the status of a conversation (open, resolved, pending or snoozed) [Conversations] POST /api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_status Auth: User API key or Agent bot API key (header api-access-token). Body fields: status. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Set the priority of a conversation (urgent, high, medium, low or none) [Conversations] POST /api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_priority Auth: User API key or Agent bot API key (header api-access-token). Body fields: priority. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

List custom attribute definitions in the account [Custom Attributes] GET /api/v1/accounts/{account_id}/custom_attribute_definitions Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Add a new custom attribute to account [Custom Attributes] POST /api/v1/accounts/{account_id}/custom_attribute_definitions Auth: User API key (header api-access-token). Body fields: attribute_display_name, attribute_display_type, attribute_description, attribute_key, attribute_values, attribute_model. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Get a custom attribute definition by ID [Custom Attributes] GET /api/v1/accounts/{account_id}/custom_attribute_definitions/{id} Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Update a custom attribute in account [Custom Attributes] PATCH /api/v1/accounts/{account_id}/custom_attribute_definitions/{id} Auth: User API key (header api-access-token). Body fields: attribute_display_name, attribute_display_type, attribute_description, attribute_key, attribute_values, attribute_model. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Remove a custom attribute from account [Custom Attributes] DELETE /api/v1/accounts/{account_id}/custom_attribute_definitions/{id} Auth: User API key (header api-access-token). Destructive: this permanently deletes the resource. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

List the current user's saved custom filters of a given type [Custom Filters] GET /api/v1/accounts/{account_id}/custom_filters Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Create a custom filter in the account [Custom Filters] POST /api/v1/accounts/{account_id}/custom_filters Auth: User API key (header api-access-token). Body fields: name, type, query. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Get the details of a custom filter in the account [Custom Filters] GET /api/v1/accounts/{account_id}/custom_filters/{custom_filter_id} Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Update a custom filter's attributes [Custom Filters] PATCH /api/v1/accounts/{account_id}/custom_filters/{custom_filter_id} Auth: User API key (header api-access-token). Body fields: name, type, query. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Delete a custom filter from the account [Custom Filters] DELETE /api/v1/accounts/{account_id}/custom_filters/{custom_filter_id} Auth: User API key (header api-access-token). Destructive: this permanently deletes the resource. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

List all inboxes available in the current account [Inboxes] GET /api/v1/accounts/{account_id}/inboxes Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Get an inbox available in the current account [Inboxes] GET /api/v1/accounts/{account_id}/inboxes/{id}/ Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Create a new inbox (channel) in the account [Inboxes] POST /api/v1/accounts/{account_id}/inboxes/ Auth: User API key (header api-access-token). Body fields: name, avatar, channel. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Update an inbox's settings, such as name, avatar and auto assignment [Inboxes] PATCH /api/v1/accounts/{account_id}/inboxes/{id} Auth: User API key (header api-access-token). Body fields: name, enable_auto_assignment (required), avatar, channel. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Get the agent bot connected to an inbox, if any [Inboxes] GET /api/v1/accounts/{account_id}/inboxes/{id}/agent_bot Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Connect an agent bot to an inbox, or disconnect it by passing agent_bot as null [Inboxes] POST /api/v1/accounts/{account_id}/inboxes/{id}/set_agent_bot Auth: User API key (header api-access-token). Body fields: agent_bot (required). Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

List the agents assigned to an inbox [Inboxes] GET /api/v1/accounts/{account_id}/inbox_members/{inbox_id} Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Add agents to an inbox [Inboxes] POST /api/v1/accounts/{account_id}/inbox_members Auth: User API key (header api-access-token). Body fields: inbox_id (required), user_ids (required). Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Replace the agents of an inbox. Agents not in user_ids are removed from the inbox [Inboxes] PATCH /api/v1/accounts/{account_id}/inbox_members Auth: User API key (header api-access-token). Body fields: inbox_id (required), user_ids (required). Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Remove agents from an inbox [Inboxes] DELETE /api/v1/accounts/{account_id}/inbox_members Auth: User API key (header api-access-token). Body fields: inbox_id (required), user_ids (required). Extra fields can be passed via extra_body. Destructive: this permanently deletes the resource. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

List the integrations available for the account [Integrations] GET /api/v1/accounts/{account_id}/integrations/apps Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Create an integration hook [Integrations] POST /api/v1/accounts/{account_id}/integrations/hooks Auth: User API key (header api-access-token). Body fields: app_id, inbox_id, settings. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Update an Integration Hook [Integrations] PATCH /api/v1/accounts/{account_id}/integrations/hooks/{hook_id} Auth: User API key (header api-access-token). Body fields: settings. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Delete an Integration Hook [Integrations] DELETE /api/v1/accounts/{account_id}/integrations/hooks/{hook_id} Auth: User API key (header api-access-token). Destructive: this permanently deletes the resource. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

List the messages of a conversation [Messages] GET /api/v1/accounts/{account_id}/conversations/{conversation_id}/messages Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Send a new message or private note in a conversation [Messages] POST /api/v1/accounts/{account_id}/conversations/{conversation_id}/messages Auth: User API key or Agent bot API key (header api-access-token). Body fields: content (required), message_type, private, content_type, content_attributes, template_params. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Delete a message and its attachments from a conversation [Messages] DELETE /api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{message_id} Auth: User API key (header api-access-token). Destructive: this permanently deletes the resource. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Get the profile of the user who owns the API access token [Profile] GET /api/v1/profile Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Get time-series report data for a metric, report type and date range [Reports] GET /api/v2/accounts/{account_id}/reports Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Get summary report totals for a report type and date range [Reports] GET /api/v2/accounts/{account_id}/reports/summary Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Get conversation metrics for Account [Reports] GET /api/v2/accounts/{account_id}/reports/conversations Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Get conversation metrics for Agent [Reports] GET /api/v2/accounts/{account_id}/reports/conversations/ Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

List all teams available in the current account [Teams] GET /api/v1/accounts/{account_id}/teams Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Create a team in the account [Teams] POST /api/v1/accounts/{account_id}/teams Auth: User API key (header api-access-token). Body fields: name, description, allow_auto_assign. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Get the details of a team in the account [Teams] GET /api/v1/accounts/{account_id}/teams/{team_id} Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Update a team's attributes [Teams] PATCH /api/v1/accounts/{account_id}/teams/{team_id} Auth: User API key (header api-access-token). Body fields: name, description, allow_auto_assign. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Delete a team from the account [Teams] DELETE /api/v1/accounts/{account_id}/teams/{team_id} Auth: User API key (header api-access-token). Destructive: this permanently deletes the resource. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

List the agents in a team [Teams] GET /api/v1/accounts/{account_id}/teams/{team_id}/team_members Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Add agents to a team [Teams] POST /api/v1/accounts/{account_id}/teams/{team_id}/team_members Auth: User API key (header api-access-token). Body fields: user_ids (required). Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Replace the agents of a team. Agents not in user_ids are removed from the team [Teams] PATCH /api/v1/accounts/{account_id}/teams/{team_id}/team_members Auth: User API key (header api-access-token). Body fields: user_ids (required). Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Remove agents from a team [Teams] DELETE /api/v1/accounts/{account_id}/teams/{team_id}/team_members Auth: User API key (header api-access-token). Body fields: user_ids (required). Extra fields can be passed via extra_body. Destructive: this permanently deletes the resource. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

List all webhooks in the account [Webhooks] GET /api/v1/accounts/{account_id}/webhooks Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Add a webhook subscription to the account [Webhooks] POST /api/v1/accounts/{account_id}/webhooks Auth: User API key (header api-access-token). Body fields: url, subscriptions. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Update a webhook object in the account [Webhooks] PATCH /api/v1/accounts/{account_id}/webhooks/{webhook_id} Auth: User API key (header api-access-token). Body fields: url, subscriptions. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Delete a webhook from the account [Webhooks] DELETE /api/v1/accounts/{account_id}/webhooks/{webhook_id} Auth: User API key (header api-access-token). Destructive: this permanently deletes the resource. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

List automation rules in the account [Automation Rule] GET /api/v1/accounts/{account_id}/automation_rules Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Add a new automation rule to account [Automation Rule] POST /api/v1/accounts/{account_id}/automation_rules Auth: User API key (header api-access-token). Body fields: name, description, event_name, active, actions, conditions. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Get an automation rule by ID [Automation Rule] GET /api/v1/accounts/{account_id}/automation_rules/{id} Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Update an automation rule in the account [Automation Rule] PATCH /api/v1/accounts/{account_id}/automation_rules/{id} Auth: User API key (header api-access-token). Body fields: name, description, event_name, active, actions, conditions. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Remove an automation rule from the account [Automation Rule] DELETE /api/v1/accounts/{account_id}/automation_rules/{id} Auth: User API key (header api-access-token). Destructive: this permanently deletes the resource. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Create a help center portal in the account [Help Center] POST /api/v1/accounts/{account_id}/portals Auth: User API key (header api-access-token). Body fields: archived, color, config, custom_domain, header_text, homepage_link, name, slug, page_title, account_id. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

List help center portals in the account [Help Center] GET /api/v1/accounts/{account_id}/portals Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Update a help center portal [Help Center] PATCH /api/v1/accounts/{account_id}/portals Auth: User API key (header api-access-token). Body fields: archived, color, config, custom_domain, header_text, homepage_link, name, slug, page_title, account_id. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Add a category to a help center portal [Help Center] POST /api/v1/accounts/{account_id}/portals/{portal_id}/categories Auth: User API key (header api-access-token). Body fields: description, locale, name, slug, position, portal_id, account_id, associated_category_id, parent_category_id. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Add an article to a help center portal [Help Center] POST /api/v1/accounts/{account_id}/portals/{portal_id}/articles Auth: User API key (header api-access-token). Body fields: content, meta, position, status, title, slug, views, portal_id, account_id, author_id, category_id, folder_id, associated_article_id. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Get the details of an inbox [Inbox API] GET /public/api/v1/inboxes/{inbox_identifier} Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Create a contact [Contacts API] POST /public/api/v1/inboxes/{inbox_identifier}/contacts Body fields: identifier, identifier_hash, email, name, phone_number, avatar_url, custom_attributes. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Get the details of a contact [Contacts API] GET /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier} Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Update a contact's attributes [Contacts API] PATCH /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier} Body fields: identifier, identifier_hash, email, name, phone_number, avatar_url, custom_attributes. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Create a conversation [Conversations API] POST /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations Body fields: custom_attributes. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

List all conversations for the contact [Conversations API] GET /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Create a message [Messages API] POST /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages Body fields: content, echo_id. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

List all messages in the conversation [Messages API] GET /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Update a message [Messages API] PATCH /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages/{message_id} Body fields: submitted_values. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Get the hosted CSAT (customer satisfaction) survey page for a conversation [CSAT Survey Page] GET /survey/responses/{conversation_uuid} Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Send an arbitrary request to the Gapify API for endpoints not covered by the generated tools. Path is relative to the base URL (e.g. /api/v1/accounts/1/labels). Uses the user API key unless auth is changed. Persian digits in the path are converted to ASCII; the body is sent as UTF-8 JSON, so Persian text is preserved.