v1

latestOpenAPI 3.0.02026-07-2483164186.3 KB

Collaborators

Remove chat collaborators

Removes collaborators from a chat using the same from, to, and agentNumbers rules as add. The success and failure lists show which numbers matched a team member; they do not indicate whether that user was already a collaborator.

post/collaborators/remove

Request body

fromstring required

WABA / WhatsApp Business number for the integration (matched against Integration.wabaNumber or credentials phone; digits only compared).

tostring required

Customer phone number (matched against Customer.phoneNumber; digits only compared).

agentNumbersstring[] required

Phone numbers of agents to add or remove. Each must resolve to an org team member via User.phone.

Example request

{
  "from": "919999999999",
  "to": "919999999999"
}

Response

Collaborators updated (partial success allowed).

Example response

{
  "success": [
    {
      "number": "+919999999999",
      "name": "Agent Name"
    }
  ],
  "failed": [
    {
      "number": "9999999999"
    }
  ]
}