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.

Rate limited to 10 requests per minute, per organisation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

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

string
required

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

agentNumbers
array of strings
required
length ≥ 1

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

agentNumbers*
Responses

400

Bad request — invalid payload, chat could not be resolved, or validation failed.

401

Unauthorized

403

Forbidden

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json