Skip to main content
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
  }
}
'

​
Overview

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

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

​
Required

​
phone
string
required
Recipient group ID
​
eventMessageId
string
required
Original event message ID
​
event
object
required
Event data

​
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”.