Inboxes: Add or remove agent bot
gapify_set_inbox_agent_botAttach or remove an agent bot for a specific inbox by passing an agent_bot ID, or null to disconnect it, via the Gapify API.
Instructions
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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ID of the inbox | |
| agent_bot | Yes | Agent bot ID Example: 0 | |
| account_id | Yes | The numeric ID of the account | |
| extra_body | No | Additional JSON body fields to merge into the request (for keys not listed above). |