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": [
{}
]
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/add-participant"
payload = {
"autoInvite": True,
"communityId": "<string>",
"phones": [{}]
}
headers = {
"Client-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({autoInvite: true, communityId: '<string>', phones: [{}]})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/add-participant', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.z-api.io/instances/{instanceId}/token/{token}/add-participant",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'autoInvite' => true,
'communityId' => '<string>',
'phones' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Client-Token: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.z-api.io/instances/{instanceId}/token/{token}/add-participant"
payload := strings.NewReader("{\n \"autoInvite\": true,\n \"communityId\": \"<string>\",\n \"phones\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Client-Token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.z-api.io/instances/{instanceId}/token/{token}/add-participant")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"autoInvite\": true,\n \"communityId\": \"<string>\",\n \"phones\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/add-participant")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"autoInvite\": true,\n \"communityId\": \"<string>\",\n \"phones\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_bodyCommunities
Add participants
Add new participants to a community
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": [
{}
]
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/add-participant"
payload = {
"autoInvite": True,
"communityId": "<string>",
"phones": [{}]
}
headers = {
"Client-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({autoInvite: true, communityId: '<string>', phones: [{}]})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/add-participant', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.z-api.io/instances/{instanceId}/token/{token}/add-participant",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'autoInvite' => true,
'communityId' => '<string>',
'phones' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Client-Token: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.z-api.io/instances/{instanceId}/token/{token}/add-participant"
payload := strings.NewReader("{\n \"autoInvite\": true,\n \"communityId\": \"<string>\",\n \"phones\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Client-Token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.z-api.io/instances/{instanceId}/token/{token}/add-participant")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"autoInvite\": true,\n \"communityId\": \"<string>\",\n \"phones\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/add-participant")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"autoInvite\": true,\n \"communityId\": \"<string>\",\n \"phones\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_bodyOverview
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
Header
string
required
Your instance ID. Available in the Z-API panel under Instances.
string
required
Your Z-API instance token.
Required
boolean
required
Sends community invitation link privately
string
required
Community ID
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”.⌘I