Send event
curl --request POST \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/send-event \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"phone": "<string>",
"event": {
"name": "<string>",
"dateTime": "<string>",
"description": "<string>",
"timeZone": "<string>",
"location": {
"name": "<string>"
},
"callLinkType": "<string>",
"canceled": true
}
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/send-event"
payload = {
"phone": "<string>",
"event": {
"name": "<string>",
"dateTime": "<string>",
"description": "<string>",
"timeZone": "<string>",
"location": { "name": "<string>" },
"callLinkType": "<string>",
"canceled": True
}
}
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>',
event: {
name: '<string>',
dateTime: '<string>',
description: '<string>',
timeZone: '<string>',
location: {name: '<string>'},
callLinkType: '<string>',
canceled: true
}
})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/send-event', 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-event",
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>',
'event' => [
'name' => '<string>',
'dateTime' => '<string>',
'description' => '<string>',
'timeZone' => '<string>',
'location' => [
'name' => '<string>'
],
'callLinkType' => '<string>',
'canceled' => true
]
]),
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-event"
payload := strings.NewReader("{\n \"phone\": \"<string>\",\n \"event\": {\n \"name\": \"<string>\",\n \"dateTime\": \"<string>\",\n \"description\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"location\": {\n \"name\": \"<string>\"\n },\n \"callLinkType\": \"<string>\",\n \"canceled\": true\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-event")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phone\": \"<string>\",\n \"event\": {\n \"name\": \"<string>\",\n \"dateTime\": \"<string>\",\n \"description\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"location\": {\n \"name\": \"<string>\"\n },\n \"callLinkType\": \"<string>\",\n \"canceled\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/send-event")
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 \"event\": {\n \"name\": \"<string>\",\n \"dateTime\": \"<string>\",\n \"description\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"location\": {\n \"name\": \"<string>\"\n },\n \"callLinkType\": \"<string>\",\n \"canceled\": true\n }\n}"
response = http.request(request)
puts response.read_bodyMessages
Send event
Send an event message to a group
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-event
Send event
curl --request POST \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/send-event \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"phone": "<string>",
"event": {
"name": "<string>",
"dateTime": "<string>",
"description": "<string>",
"timeZone": "<string>",
"location": {
"name": "<string>"
},
"callLinkType": "<string>",
"canceled": true
}
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/send-event"
payload = {
"phone": "<string>",
"event": {
"name": "<string>",
"dateTime": "<string>",
"description": "<string>",
"timeZone": "<string>",
"location": { "name": "<string>" },
"callLinkType": "<string>",
"canceled": True
}
}
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>',
event: {
name: '<string>',
dateTime: '<string>',
description: '<string>',
timeZone: '<string>',
location: {name: '<string>'},
callLinkType: '<string>',
canceled: true
}
})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/send-event', 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-event",
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>',
'event' => [
'name' => '<string>',
'dateTime' => '<string>',
'description' => '<string>',
'timeZone' => '<string>',
'location' => [
'name' => '<string>'
],
'callLinkType' => '<string>',
'canceled' => true
]
]),
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-event"
payload := strings.NewReader("{\n \"phone\": \"<string>\",\n \"event\": {\n \"name\": \"<string>\",\n \"dateTime\": \"<string>\",\n \"description\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"location\": {\n \"name\": \"<string>\"\n },\n \"callLinkType\": \"<string>\",\n \"canceled\": true\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-event")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phone\": \"<string>\",\n \"event\": {\n \"name\": \"<string>\",\n \"dateTime\": \"<string>\",\n \"description\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"location\": {\n \"name\": \"<string>\"\n },\n \"callLinkType\": \"<string>\",\n \"canceled\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/send-event")
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 \"event\": {\n \"name\": \"<string>\",\n \"dateTime\": \"<string>\",\n \"description\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"location\": {\n \"name\": \"<string>\"\n },\n \"callLinkType\": \"<string>\",\n \"canceled\": true\n }\n}"
response = http.request(request)
puts response.read_bodyOverview
With this method you can send Event type messages.This message type can only be sent to a group.
Example on WhatsApp

Attributes
Header
Your instance ID. Available in the Z-API panel under Instances.
Your Z-API instance token.
Required
Recipient group ID
Event data
Show Properties
Show Properties
Event name
Event date and time (without timezone). E.g.: 2024-04-29T09:30:53.309Z
Event description
Event UTC timezone. E.g.: UTC-3
Event call type:
voice or videoWhether the event is canceled
Request Body
{
"phone": "120363019502650977-group",
"event": {
"name": "Event name",
"description": "Event description",
"dateTime": "2024-04-29T09:30:53.309Z",
"timeZone": "UTC-3",
"location": {
"name": "Place name"
},
"callLinkType": "voice",
"canceled": false
}
}
Response
200
{
"zaapId": "3999984263738042930CD6ECDE9VDWSA",
"messageId": "D241XXXX732339502B68",
"id": "D241XXXX732339502B68"
}
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