Send channel admin invite
curl --request POST \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/send-newsletter-admin-invite \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"phone": "<string>",
"adminInviteMessage": {
"newsletterId": "<string>",
"caption": "<string>"
}
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/send-newsletter-admin-invite"
payload = {
"phone": "<string>",
"adminInviteMessage": {
"newsletterId": "<string>",
"caption": "<string>"
}
}
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({
phone: '<string>',
adminInviteMessage: {newsletterId: '<string>', caption: '<string>'}
})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/send-newsletter-admin-invite', 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}/send-newsletter-admin-invite",
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([
'phone' => '<string>',
'adminInviteMessage' => [
'newsletterId' => '<string>',
'caption' => '<string>'
]
]),
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}/send-newsletter-admin-invite"
payload := strings.NewReader("{\n \"phone\": \"<string>\",\n \"adminInviteMessage\": {\n \"newsletterId\": \"<string>\",\n \"caption\": \"<string>\"\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}/send-newsletter-admin-invite")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phone\": \"<string>\",\n \"adminInviteMessage\": {\n \"newsletterId\": \"<string>\",\n \"caption\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/send-newsletter-admin-invite")
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 \"phone\": \"<string>\",\n \"adminInviteMessage\": {\n \"newsletterId\": \"<string>\",\n \"caption\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_bodyMessages
Send channel admin invite
Send an invite to manage an application channel
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-newsletter-admin-invite
Send channel admin invite
curl --request POST \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/send-newsletter-admin-invite \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"phone": "<string>",
"adminInviteMessage": {
"newsletterId": "<string>",
"caption": "<string>"
}
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/send-newsletter-admin-invite"
payload = {
"phone": "<string>",
"adminInviteMessage": {
"newsletterId": "<string>",
"caption": "<string>"
}
}
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({
phone: '<string>',
adminInviteMessage: {newsletterId: '<string>', caption: '<string>'}
})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/send-newsletter-admin-invite', 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}/send-newsletter-admin-invite",
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([
'phone' => '<string>',
'adminInviteMessage' => [
'newsletterId' => '<string>',
'caption' => '<string>'
]
]),
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}/send-newsletter-admin-invite"
payload := strings.NewReader("{\n \"phone\": \"<string>\",\n \"adminInviteMessage\": {\n \"newsletterId\": \"<string>\",\n \"caption\": \"<string>\"\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}/send-newsletter-admin-invite")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phone\": \"<string>\",\n \"adminInviteMessage\": {\n \"newsletterId\": \"<string>\",\n \"caption\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/send-newsletter-admin-invite")
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 \"phone\": \"<string>\",\n \"adminInviteMessage\": {\n \"newsletterId\": \"<string>\",\n \"caption\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_bodyOverview
With this method you can send messages inviting people to become administrators of your application channels.Example on the application

Attributes
Header
Required
Recipient’s phone number in DDI DDD NUMBER format. E.g.: 551199999999. IMPORTANT Send only numbers, without formatting or masks
Request Body
{
"phone": "5511999999999",
"adminInviteMessage": {
"newsletterId": "120363166555745933@newsletter",
"caption": "I want to invite you to be an admin of my WhatsApp channel."
}
}
Response
200
{
"zaapId": "3999984263738042930CD6ECDE9VDWSA",
"messageId": "D241XXXX732339502B68",
"id": "D241XXXX732339502B68"
}