Edit event
curl --request POST \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/send-edit-event \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"phone": "<string>",
"eventMessageId": "<string>",
"event": {
"name": "<string>",
"dateTime": "<string>",
"description": "<string>",
"location": {
"name": "<string>"
},
"callLinkType": "<string>",
"canceled": true
}
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/send-edit-event"
payload = {
"phone": "<string>",
"eventMessageId": "<string>",
"event": {
"name": "<string>",
"dateTime": "<string>",
"description": "<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>',
eventMessageId: '<string>',
event: {
name: '<string>',
dateTime: '<string>',
description: '<string>',
location: {name: '<string>'},
callLinkType: '<string>',
canceled: true
}
})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/send-edit-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-edit-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>',
'eventMessageId' => '<string>',
'event' => [
'name' => '<string>',
'dateTime' => '<string>',
'description' => '<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-edit-event"
payload := strings.NewReader("{\n \"phone\": \"<string>\",\n \"eventMessageId\": \"<string>\",\n \"event\": {\n \"name\": \"<string>\",\n \"dateTime\": \"<string>\",\n \"description\": \"<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-edit-event")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phone\": \"<string>\",\n \"eventMessageId\": \"<string>\",\n \"event\": {\n \"name\": \"<string>\",\n \"dateTime\": \"<string>\",\n \"description\": \"<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-edit-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 \"eventMessageId\": \"<string>\",\n \"event\": {\n \"name\": \"<string>\",\n \"dateTime\": \"<string>\",\n \"description\": \"<string>\",\n \"location\": {\n \"name\": \"<string>\"\n },\n \"callLinkType\": \"<string>\",\n \"canceled\": true\n }\n}"
response = http.request(request)
puts response.read_bodyMessages
Edit event
Edit an existing event in a group
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-edit-event
Edit event
curl --request POST \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/send-edit-event \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"phone": "<string>",
"eventMessageId": "<string>",
"event": {
"name": "<string>",
"dateTime": "<string>",
"description": "<string>",
"location": {
"name": "<string>"
},
"callLinkType": "<string>",
"canceled": true
}
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/send-edit-event"
payload = {
"phone": "<string>",
"eventMessageId": "<string>",
"event": {
"name": "<string>",
"dateTime": "<string>",
"description": "<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>',
eventMessageId: '<string>',
event: {
name: '<string>',
dateTime: '<string>',
description: '<string>',
location: {name: '<string>'},
callLinkType: '<string>',
canceled: true
}
})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/send-edit-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-edit-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>',
'eventMessageId' => '<string>',
'event' => [
'name' => '<string>',
'dateTime' => '<string>',
'description' => '<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-edit-event"
payload := strings.NewReader("{\n \"phone\": \"<string>\",\n \"eventMessageId\": \"<string>\",\n \"event\": {\n \"name\": \"<string>\",\n \"dateTime\": \"<string>\",\n \"description\": \"<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-edit-event")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phone\": \"<string>\",\n \"eventMessageId\": \"<string>\",\n \"event\": {\n \"name\": \"<string>\",\n \"dateTime\": \"<string>\",\n \"description\": \"<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-edit-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 \"eventMessageId\": \"<string>\",\n \"event\": {\n \"name\": \"<string>\",\n \"dateTime\": \"<string>\",\n \"description\": \"<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 edit messages.To edit the event, you must resend all data that is already configured in the event, even if they have no changes.
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
Original event message ID
Event data
Show Properties
Show Properties
Request Body
{
"phone": "120363019502650977-group",
"eventMessageId": "3EB058359730B7C2895C55",
"event": {
"name": "New event name",
"description": "Event description",
"dateTime": "2024-04-29T09:30:53.309Z",
"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