v1

latestOpenAPI 3.0.02026-07-2483164186.3 KB

Collaborators

Add chat collaborators

Adds team members to a chat as collaborators. Identify the chat with from (your WhatsApp Business number) and to (the customer number). agentNumbers must be phone numbers of users in your organization; they are matched after normalizing format (e.g. stripping + and spaces). You must have access to read the chat. The response reports per-number success and failure.

post/collaborators/add

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"
    }
  ]
}