How do I use gapify-mcp-server?

1. Click on "Deploy Server". 2. Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state. 3. In the chat, type @ followed by the MCP server name and your instructions, e.g., "@gapify-mcp-server Reply to conversation 42: your order has shipped" That's it! The server will respond to your query, and you can continue using it as needed. Here is a step-by-step guide with screenshots.

gapify-mcp-server

by mh-zeynal

Overview Schema Source Related Servers Discussions Admin

TypeScript

Remote

gapify-mcp-server

MCP server that exposes the Gapify customer-support API (Chatwoot-compatible) as tools for Claude Code, Claude Desktop, or any other MCP client. Built on the official MCP TypeScript SDK. All 117 endpoints in Gapify-API.postman_collection.json are generated into tools, plus one gapify_raw_request escape hatch.

Tool descriptions are in English; tool inputs may be in Persian (Farsi). See Persian input.

راهنمای فارسی

Install

No clone needed; MCP clients run it with npx:

npx -y gapify-mcp-server

Requires Node.js 18 or newer.

Related MCP server: libredesk-mcp

Configuration

Set these as environment variables in the MCP client config:

Variable	Required	Where to get it
`GAPIFY_API_ACCESS_TOKEN`	yes, for `gapify_*` Application tools	Gapify -> Profile Settings -> Access Token
`GAPIFY_ACCOUNT_ID`	recommended	Number in the Gapify URL: `app.gapify.ai/app/accounts/<id>/...`
`GAPIFY_BASE_URL`	no	Defaults to `https://app.gapify.ai`
`GAPIFY_PLATFORM_APP_API_KEY`	only for `gapify_platform_*` tools	Super Admin -> Platform Apps
`GAPIFY_AGENT_BOT_API_KEY`	no	Fallback token for message endpoints

When running from a local clone, a .env next to package.json is also read (see .env.example); environment variables win over .env values.

Claude Code

claude mcp add --scope user gapify -e GAPIFY_API_ACCESS_TOKEN=your-token -e GAPIFY_ACCOUNT_ID=1 -- npx -y gapify-mcp-server

Then run /mcp inside Claude Code to confirm it connected.

Claude Desktop

Add to claude_desktop_config.json (%APPDATA%\Claude\ on Windows, ~/Library/Application Support/Claude/ on macOS):

{
  "mcpServers": {
    "gapify": {
      "command": "npx",
      "args": ["-y", "gapify-mcp-server"],
      "env": {
        "GAPIFY_API_ACCESS_TOKEN": "your-token",
        "GAPIFY_ACCOUNT_ID": "1"
      }
    }
  }
}

Usage

Once connected, ask your assistant in English or Persian; it picks the matching tool. For example:

"List my open conversations" / «گفتگوهای باز من را نشان بده»
"Find the contact with phone 09121234567" / «مخاطب با شماره ۰۹۱۲۱۲۳۴۵۶۷ را پیدا کن»
"Reply to conversation 42: your order has shipped" / «به گفتگوی ۴۲ پاسخ بده: سفارش شما ارسال شد»
"Resolve conversation 42 and add the label vip"
"Assign conversation 42 to the support team"
"How many conversations did we resolve last week?"

Tools that change data (create, update, delete) are marked in their annotations, so clients that ask for confirmation before write actions will do so. Delete tools are marked destructive.

If something fails, the tool returns the HTTP status with a hint, for example a 401 means GAPIFY_API_ACCESS_TOKEN is missing or wrong, and a 404 usually means a wrong ID or account_id.

Persian input

Free text (names, message content, notes, search terms, custom attribute values) is sent unchanged as UTF-8 JSON or URL-encoded query strings, so Persian text round-trips exactly. The server's instructions tell the model not to translate it.
IDs, page numbers, numeric fields and phone numbers accept Persian (۰-۹) and Arabic-Indic (٠-٩) digits and are converted to ASCII before the request. ۰۹۱۲ ۳۴۵ ۶۷۸۹ becomes 09123456789; +۹۸۹۱۲... becomes +98912....
Zero-width and bidi control marks that RTL keyboards insert around values are stripped from IDs.
Boolean fields accept true/false, "true"/"false" and "بله"/"خیر".
Enum values (e.g. conversation status open, resolved) stay English; each parameter description lists them.

The normalization lives in src/persian.ts.

Tool naming

gapify_<action> : Application API (/api/v1/accounts/{account_id}/...), user API key
gapify_platform_<action> : Platform API (/platform/api/v1/...), platform app key
gapify_client_<action> : Client/public API (/public/api/v1/inboxes/...), no auth
gapify_raw_request : any method + path, for endpoints missing from the collection

Run node scripts/generate-tools.mjs --list to print every tool with its method and path.

How it works

scripts/generate-tools.mjs walks the Postman collection and writes src/generated/tools.json: name, method, path, path/query params with descriptions, and body fields parsed from the request description and example body. SUMMARY_OVERRIDES and FIELD_DOCS supply precise English text where the collection is vague or silent. The generator fails if any parameter lacks a description or any description contains non-ASCII text.
src/index.ts registers one MCP tool per entry with a Zod schema. account_id becomes optional when GAPIFY_ACCOUNT_ID is set. extra_body lets you pass keys that are not in the example.
src/client.ts picks the right api-access-token header per endpoint and returns actionable error text for 401/403/404/422/429. Responses over 60k characters are truncated with a note.

Development

npm install
npm run build        # regenerates tools.json from the Postman collection, then compiles to dist/
npm run inspect      # opens MCP Inspector against dist/index.js

Available Tools

118 tools

gapify_account_conversation_metricsReports: Account Conversation MetricsB

Read-onlyIdempotent

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.

Inputs: account_id (required), type.

gapify_add_agentAgents: Add a New AgentA

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.

Inputs: name (required), email (required), account_id (required), role, +3 more.

gapify_add_articleHelp Center: Add a new articleA

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.

Inputs: portal_id (required), account_id (required), meta, slug, +10 more.

gapify_add_automation_ruleAutomation Rule: Add a new automation ruleA

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.

Inputs: account_id (required), name, active, actions, +4 more.

gapify_add_canned_responseCanned Responses: Add a New Canned ResponseA

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.

Inputs: account_id (required), content, extra_body, short_code.

gapify_add_categoryHelp Center: Add a new categoryA

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.

Inputs: portal_id (required), account_id (required), name, slug, +6 more.

gapify_add_custom_attributeCustom Attributes: Add a new custom attributeA

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.

Inputs: account_id (required), extra_body, attribute_key, attribute_model, +4 more.

gapify_add_inbox_agentsInboxes: Add a New AgentB

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.

Inputs: inbox_id (required), user_ids (required), account_id (required), extra_body.

gapify_add_portalHelp Center: Add a new portalA

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.

Inputs: account_id (required), name, slug, color, +7 more.

gapify_add_team_agentsTeams: Add a New AgentA

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.

Inputs: team_id (required), user_ids (required), account_id (required), extra_body.

gapify_add_webhookWebhooks: Add a webhookA

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.

Inputs: account_id (required), url, extra_body, subscriptions.

gapify_agent_conversation_metricsReports: Agent Conversation MetricsA

Read-onlyIdempotent

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.

Inputs: account_id (required), type, user_id.

gapify_assign_conversationConversation Assignment: Assign ConversationB

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.

Inputs: account_id (required), conversation_id (required), team_id, extra_body, +1 more.

gapify_client_create_contactContacts API: Create a contactB

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.

Inputs: inbox_identifier (required), name, email, avatar_url, +5 more.

gapify_client_create_conversationConversations API: Create a conversationB

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.

Inputs: inbox_identifier (required), contact_identifier (required), extra_body, custom_attributes.

gapify_client_create_messageMessages API: Create a messageB

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.

Inputs: conversation_id (required), inbox_identifier (required), contact_identifier (required), content, +2 more.

gapify_client_get_contactContacts API: Get a contactB

Read-onlyIdempotent

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.

Inputs: inbox_identifier (required), contact_identifier (required).

gapify_client_get_inboxInbox API: Inbox detailsB

Read-onlyIdempotent

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.

Inputs: inbox_identifier (required).

gapify_client_list_conversationsConversations API: List all conversationsA

Read-onlyIdempotent

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.

Inputs: inbox_identifier (required), contact_identifier (required).

gapify_client_list_messagesMessages API: List all messagesA

Read-onlyIdempotent

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.

Inputs: conversation_id (required), inbox_identifier (required), contact_identifier (required).

gapify_client_update_contactContacts API: Update a contactA

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.

Inputs: inbox_identifier (required), contact_identifier (required), name, email, +6 more.

gapify_client_update_messageMessages API: Update a messageB

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.

Inputs: message_id (required), conversation_id (required), inbox_identifier (required), contact_identifier (required), +2 more.

gapify_create_agent_botAccount AgentBots: Create an Agent BotA

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.

Inputs: account_id (required), name, extra_body, description, +1 more.

gapify_create_contactContacts: Create ContactB

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.

Inputs: inbox_id (required), account_id (required), name, email, +6 more.

gapify_create_contact_inboxContacts: Create contact inboxA

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.

Inputs: id (required), inbox_id (required), account_id (required), source_id, +1 more.

gapify_create_conversationConversations: Create New ConversationA

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.

Inputs: inbox_id (required), source_id (required), account_id (required), status, +7 more.

gapify_create_custom_filterCustom Filters: Create a custom filterA

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.

Inputs: account_id (required), name, type, query, +2 more.

gapify_create_inboxInboxes: Create an inboxA

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.

Inputs: account_id (required), name, avatar, channel, +1 more.

gapify_create_integration_hookIntegrations: Create an integration hookA

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.

Inputs: account_id (required), app_id, inbox_id, settings, +1 more.

gapify_create_messageMessages: Create New MessageA

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.

Inputs: content (required), account_id (required), conversation_id (required), private, +5 more.

gapify_create_teamTeams: Create a teamA

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.

Inputs: account_id (required), name, extra_body, description, +1 more.

gapify_delete_agent_botAccount AgentBots: Delete an AgentBotA

DestructiveIdempotent

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.

Inputs: id (required), account_id (required).

gapify_delete_contactContacts: Delete ContactA

DestructiveIdempotent

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.

Inputs: id (required), account_id (required).

gapify_delete_custom_filterCustom Filters: Delete a custom filterA

DestructiveIdempotent

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.

Inputs: account_id (required), custom_filter_id (required).

gapify_delete_integration_hookIntegrations: Delete an Integration HookA

DestructiveIdempotent

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.

Inputs: hook_id (required), account_id (required).

gapify_delete_messageMessages: Delete a messageA

DestructiveIdempotent

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.

Inputs: account_id (required), message_id (required), conversation_id (required).

gapify_delete_teamTeams: Delete a teamA

DestructiveIdempotent

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.

Inputs: team_id (required), account_id (required).

gapify_delete_webhookWebhooks: Delete a webhookA

DestructiveIdempotent

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.

Inputs: account_id (required), webhook_id (required).

gapify_filter_contactsContacts: Contact FilterA

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.

Inputs: account_id (required), page, payload, extra_body.

gapify_filter_conversationsConversations: Conversations FilterA

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.

Inputs: account_id (required), page, payload, extra_body.

gapify_get_account_reportsReports: Get Account reportsA

Read-onlyIdempotent

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.

Inputs: account_id (required), id, type, since, +2 more.

gapify_get_account_reports_summaryReports: Get Account reports summaryA

Read-onlyIdempotent

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.

Inputs: account_id (required), id, type, since, +1 more.

gapify_get_agent_botAccount AgentBots: Get an agent bot detailsA

Read-onlyIdempotent

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.

Inputs: id (required), account_id (required).

gapify_get_automation_ruleAutomation Rule: Get a automation rule detailsA

Read-onlyIdempotent

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.

Inputs: id (required), account_id (required).

gapify_get_contactContacts: Show ContactA

Read-onlyIdempotent

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.

Inputs: id (required), account_id (required).

gapify_get_contactable_inboxesContacts: Get Contactable InboxesA

Read-onlyIdempotent

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.

Inputs: id (required), account_id (required).

gapify_get_conversationConversations: Conversation DetailsA

Read-onlyIdempotent

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.

Inputs: account_id (required), conversation_id (required).

gapify_get_conversation_countsConversations: Get Conversation CountsB

Read-onlyIdempotent

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.

Inputs: account_id (required), q, labels, status, +2 more.

gapify_get_csat_surveyCSAT Survey Page: Get CSAT survey pageB

Read-onlyIdempotent

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.

Inputs: conversation_uuid (required).

gapify_get_custom_attributeCustom Attributes: Get a custom attribute detailsB

Read-onlyIdempotent

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.

Inputs: id (required), account_id (required).

gapify_get_custom_filterCustom Filters: Get a custom filter detailsB

Read-onlyIdempotent

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.

Inputs: account_id (required), custom_filter_id (required).

gapify_get_inboxInboxes: Get an inboxA

Read-onlyIdempotent

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.

Inputs: id (required), account_id (required).

gapify_get_messagesMessages: Get messagesB

Read-onlyIdempotent

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.

Inputs: account_id (required), conversation_id (required).

gapify_get_profileProfile: Fetch user profileA

Read-onlyIdempotent

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.

Inputs: no named parameters.

gapify_get_teamTeams: Get a team detailsB

Read-onlyIdempotent

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.

Inputs: team_id (required), account_id (required).

gapify_list_agent_botsAccount AgentBots: List all AgentBotsB

Read-onlyIdempotent

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.

Inputs: account_id (required).

gapify_list_agentsAgents: List Agents in AccountB

Read-onlyIdempotent

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.

Inputs: account_id (required).

gapify_list_automation_rulesAutomation Rule: List all automation rules in an accountA

Read-onlyIdempotent

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.

Inputs: account_id (required), page.

gapify_list_canned_responsesCanned Responses: List all Canned Responses in an AccountA

Read-onlyIdempotent

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.

Inputs: account_id (required).

gapify_list_contact_conversationsContacts: Contact ConversationsB

Read-onlyIdempotent

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.

Inputs: id (required), account_id (required).

gapify_list_contact_labelsContact Labels: List LabelsA

Read-onlyIdempotent

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.

Inputs: account_id (required), contact_identifier (required).

gapify_list_contactsContacts: List ContactsA

Read-onlyIdempotent

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.

Inputs: account_id (required), page, sort.

gapify_list_conversation_labelsConversation Labels: List LabelsA

Read-onlyIdempotent

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.

Inputs: account_id (required), conversation_id (required).

gapify_list_conversationsConversations: Conversations ListA

Read-onlyIdempotent

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.

Inputs: account_id (required), q, page, labels, +4 more.

gapify_list_custom_attributesCustom Attributes: List all custom attributes in an accountB

Read-onlyIdempotent

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.

Inputs: account_id (required), attribute_model.

gapify_list_custom_filtersCustom Filters: List all custom filtersB

Read-onlyIdempotent

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.

Inputs: account_id (required), filter_type.

gapify_list_inbox_agentsInboxes: List Agents in InboxB

Read-onlyIdempotent

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.

Inputs: inbox_id (required), account_id (required).

gapify_list_inboxesInboxes: List all inboxesA

Read-onlyIdempotent

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.

Inputs: account_id (required).

gapify_list_integrationsIntegrations: List all the IntegrationsB

Read-onlyIdempotent

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.

Inputs: account_id (required).

gapify_list_portalsHelp Center: List all portals in an accountA

Read-onlyIdempotent

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.

Inputs: account_id (required).

gapify_list_team_agentsTeams: List Agents in TeamA

Read-onlyIdempotent

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.

Inputs: team_id (required), account_id (required).

gapify_list_teamsTeams: List all teamsA

Read-onlyIdempotent

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.

Inputs: account_id (required).

gapify_list_webhooksWebhooks: List all webhooksB

Read-onlyIdempotent

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.

Inputs: account_id (required).

gapify_platform_create_accountAccounts: Create an AccountA

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.

Inputs: name, extra_body.

gapify_platform_create_account_userAccount Users: Create an Account UserB

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.

Inputs: role (required), user_id (required), account_id (required), extra_body.

gapify_platform_create_agent_botAgentBots: Create an Agent BotA

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.

Inputs: name, extra_body, description, outgoing_url.

gapify_platform_create_userUsers: Create a UserA

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.

Inputs: name, email, password, extra_body, +1 more.

gapify_platform_delete_accountAccounts: Delete an AccountA

DestructiveIdempotent

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.

Inputs: account_id (required).

gapify_platform_delete_account_userAccount Users: Delete an Account UserB

DestructiveIdempotent

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.

Inputs: user_id (required), account_id (required), extra_body.

gapify_platform_delete_agent_botAgentBots: Delete an AgentBotA

DestructiveIdempotent

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.

Inputs: id (required).

gapify_platform_delete_userUsers: Delete a UserA

DestructiveIdempotent

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.

Inputs: id (required).

gapify_platform_get_accountAccounts: Get an account detailsA

Read-onlyIdempotent

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.

Inputs: account_id (required).

gapify_platform_get_agent_botAgentBots: Get an agent bot detailsA

Read-onlyIdempotent

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.

Inputs: id (required).

gapify_platform_get_userUsers: Get an user detailsA

Read-onlyIdempotent

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.

Inputs: id (required).

gapify_platform_get_user_sso_linkUsers: Get User SSO LinkA

Read-onlyIdempotent

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.

Inputs: id (required).

gapify_platform_list_account_usersAccount Users: List all Account UsersA

Read-onlyIdempotent

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.

Inputs: account_id (required).

gapify_platform_list_agent_botsAgentBots: List all AgentBotsA

Read-onlyIdempotent

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.

Inputs: no named parameters.

gapify_platform_update_accountAccounts: Update an accountA

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.

Inputs: account_id (required), name, extra_body.

gapify_platform_update_agent_botAgentBots: Update an agent botA

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.

Inputs: id (required), name, extra_body, description, +1 more.

gapify_platform_update_userUsers: Update a userA

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.

Inputs: id (required), name, email, password, +2 more.

gapify_raw_requestRaw Gapify API requestA

Destructive

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.

Inputs: path (required), method (required), auth, body, +1 more.

gapify_remove_agentAgents: Remove an Agent from AccountA

DestructiveIdempotent

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.

Inputs: id (required), account_id (required).

gapify_remove_automation_ruleAutomation Rule: Remove a automation rule from accountA

DestructiveIdempotent

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.

Inputs: id (required), account_id (required).

gapify_remove_canned_responseCanned Responses: Remove a Canned Response from AccountA

DestructiveIdempotent

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.

Inputs: id (required), account_id (required).

gapify_remove_custom_attributeCustom Attributes: Remove a custom attribute from accountB

DestructiveIdempotent

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.

Inputs: id (required), account_id (required).

gapify_remove_inbox_agentInboxes: Remove an Agent from InboxB

DestructiveIdempotent

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.

Inputs: inbox_id (required), user_ids (required), account_id (required), extra_body.

gapify_remove_team_agentTeams: Remove an Agent from TeamA

DestructiveIdempotent

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.

Inputs: team_id (required), user_ids (required), account_id (required), extra_body.

gapify_search_contactsContacts: Search ContactsA

Read-onlyIdempotent

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.

Inputs: account_id (required), q, page, sort.

gapify_set_contact_labelsContact Labels: Add LabelsA

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.

Inputs: account_id (required), contact_identifier (required), labels, extra_body.

gapify_set_conversation_labelsConversation Labels: Add LabelsA

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.

Inputs: account_id (required), conversation_id (required), labels, extra_body.

gapify_set_inbox_agent_botInboxes: Add or remove agent botA

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.

Inputs: id (required), agent_bot (required), account_id (required), extra_body.

gapify_show_inbox_agent_botInboxes: Show Inbox Agent BotA

Read-onlyIdempotent

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.

Inputs: id (required), account_id (required).

gapify_toggle_conversation_priorityConversations: Toggle PriorityA

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.

Inputs: account_id (required), conversation_id (required), priority, extra_body.

gapify_toggle_conversation_statusConversations: Toggle StatusA

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.

Inputs: account_id (required), conversation_id (required), status, extra_body.

gapify_update_agentAgents: Update Agent in AccountA

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.

Inputs: id (required), account_id (required), role, extra_body, +2 more.

gapify_update_agent_botAccount AgentBots: Update an agent botA

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.

Inputs: id (required), account_id (required), name, extra_body, +2 more.

gapify_update_automation_ruleAutomation Rule: Update automation rule in AccountA

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.

Inputs: id (required), account_id (required), name, active, +5 more.

gapify_update_canned_responseCanned Responses: Update Canned Response in AccountA

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.

Inputs: id (required), account_id (required), content, extra_body, +1 more.

gapify_update_contactContacts: Update ContactA

Idempotent

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.

Inputs: id (required), account_id (required), name, email, +6 more.

gapify_update_custom_attributeCustom Attributes: Update custom attribute in AccountA

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.

Inputs: id (required), account_id (required), extra_body, attribute_key, +5 more.

gapify_update_custom_filterCustom Filters: Update a custom filterA

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.

Inputs: account_id (required), custom_filter_id (required), name, type, +2 more.

gapify_update_inboxInboxes: Update InboxA

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.

Inputs: id (required), account_id (required), enable_auto_assignment (required), name, +3 more.

gapify_update_inbox_agentsInboxes: Update Agents in InboxA

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.

Inputs: inbox_id (required), user_ids (required), account_id (required), extra_body.

gapify_update_integration_hookIntegrations: Update an Integration HookA

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.

Inputs: hook_id (required), account_id (required), settings, extra_body.

gapify_update_portalHelp Center: update a new portalA

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.

Inputs: account_id (required), name, slug, color, +7 more.

gapify_update_teamTeams: Update a teamA

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.

Inputs: team_id (required), account_id (required), name, extra_body, +2 more.

gapify_update_team_agentsTeams: Update Agents in TeamA

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.

Inputs: team_id (required), user_ids (required), account_id (required), extra_body.

gapify_update_webhookWebhooks: Update a webhook objectA

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.

Inputs: account_id (required), webhook_id (required), url, extra_body, +1 more.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

Deploy Server

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

TDQS

B3.2/5.0

Scored 2026-10-20 09:45 across 118 tools

Disambiguation3/5

Descriptions indicate auth surface and path, but the set contains multiple near-duplicate pairs across platform, account, and client APIs (e.g., gapify_platform_list_agent_bots vs gapify_list_agent_bots; gapify_create_contact vs gapify_client_create_contact), so an agent can easily select the wrong variant. The descriptions help, but the sheer number of overlapping resources keeps ambiguity present.

Naming Consistency3/5

Names consistently use snake_case and a gapify_ prefix, but verb conventions vary across resources—create vs add (create_agent_bot vs add_agent), delete vs remove (delete_contact vs remove_agent), and set/toggle for state changes—making the pattern only partially predictable.

Tool Count1/5

118 tools is far beyond the recommended 3-15 range and exceeds the rubric's 50+ threshold for extreme mismatch. Even for a large platform API, this volume overwhelms tool selection and context handling.

Completeness4/5

The set covers CRUD for most major resources (accounts, users, agents, teams, inboxes, contacts, conversations, messages, labels, custom attributes, filters, webhooks, automation rules, help center, integrations, reports) and includes a raw_request escape hatch. Some lifecycle operations (e.g., updating or deleting conversations) are absent, but they are workable via raw requests.

Maintenance

ActivityMaintained

ResponsivenessNo recent community issues

Resources

Related MCP Connectors

HelpRabbit
org.helprabbit
Work your HelpRabbit help desk: tickets, replies, customers, the AI agent and its knowledge.
Customer Support Communication Knowledge & Memory
1
https://helprabbit.org/mcp
chatbase
co.chatbase
Manage Chatbase agents, sources, conversations and help-desk tickets.
Customer Support AI & Machine Learning
1
https://mcp.chatbase.co/api/mcp
AI Agent
io.github.supnim
Manage tickets, run agents and workflows, query tables, and search workspace knowledge.
Agent Orchestration Project Management Search
1
https://aiagent.app/mcp
Zono Support
support.zono
Work your Zono Support help desk from an AI client: tickets, customers, purchases and knowledge.
Customer Support CRM E-commerce & Retail
1
https://zono.support/mcp

Related MCP Servers

Gorgias MCP Server
Customer Support Communication
mattcoatsworth
F
license
Not graded
quality
D
maintenance
Enables interaction with the Gorgias helpdesk API, providing tools to manage tickets, customers, and other helpdesk functionalities through natural language.
Updated 2 years ago (2025-03-31 13:13 UTC)
4
-
libredesk-mcp
Customer Support Communication
metanmai
A
license
C
quality
D
maintenance
MCP server that exposes the complete Libredesk REST API (54 endpoints) as tools, enabling natural language management of conversations, contacts, agents, teams, and more for the open-source customer support desk.
Updated 5 months ago (2026-06-06 08:28 UTC)
54
9 npm
4
MIT
@indica-facil/mcp-chatwoot
Customer Support Communication
indicafacil-ai
A
license
Not graded
quality
D
maintenance
Exposes the full Chatwoot API as 129 tools for AI assistants, enabling account, contact, conversation, message, inbox, team, report, help center, automation, and custom attribute management, plus exclusive Kanban and scheduled message features.
Updated 3 months ago (2026-08-20 01:08 UTC)
7 npm
MIT
FirstReply MCP Serverofficial
Customer Support
FirstReply
A
license
B
quality
C
maintenance
Exposes FirstReply customer support operations as MCP tools, enabling AI assistants to browse conversations, draft replies, manage API keys, and access support statistics.
Updated 4 days ago (2026-11-06 12:37 UTC)
84
1
MIT

gapify-mcp-server

Install

Configuration

Claude Code

Claude Desktop

Usage

Persian input

Tool naming

How it works

Development

Available Tools

Tool Schema Changelog

TDQS

Maintenance

Resources

Related MCP Connectors

Related MCP Servers

Gorgias MCP Server

libredesk-mcp

@indica-facil/mcp-chatwoot

FirstReply MCP Serverofficial