Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
add-participant
Add participants
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/add-participant \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "autoInvite": true,
  "communityId": "<string>",
  "phones": [
    {}
  ]
}
'

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

This method is responsible for adding new participants to a community.
If unable to add directly, enabling autoInvite will have the API send private invites with the community link to participants who were not added.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Required

​
autoInvite
boolean
required
Sends community invitation link privately
​
communityId
string
required
Community ID
​
phones
array
required
Array with the phone numbers of participants to be added

​
Request Body

{
  "autoInvite": true,
  "communityId": "120363019502650977",
  "phones": ["5544999999999", "5544888888888"]
}

​
Response

​
200

{
  "value": true
}

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.