Inboxes: Remove an Agent from Inbox
gapify_remove_inbox_agentRemove specified agents from a Gapify inbox by permanently deleting their user IDs from the inbox membership.
Instructions
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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| inbox_id | Yes | The ID of the inbox | |
| user_ids | Yes | IDs of users to be deleted from the inbox Example: [1] | |
| 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). |