Cancel a calendar event already sent
cancel_calendar_eventCancel a calendar event this number already sent.
The event stays in the chat marked as canceled, and WhatsApp tells the
guests. Send the same name and start_at the event has, plus the
details you want the canceled card to still show (description,
end_at, join_link, location, has_reminder with
reminder_offset_sec, extra_guests_allowed): the canceled event is
shown with what you send here, and anything you leave out disappears
from it.
Cancel when the date, time or place change and the guests must accept
again: cancel the old event here, then send the new one with
send_calendar_event, because the old answer does not carry over to a
new event. To correct a mistake (a typo, the description, a link) use
edit_calendar_event instead, and the guests keep their answer. A
cancel does not change the entry a guest already added to their own
calendar with the card's "Add to calendar" button. It stays on the old
date, and adding again creates a second entry, which only the guest can
delete.
Only a calendar event can be canceled. Using this tool on any other
message answers invalid_request: message_not_editable; to take back a
message of another kind, use delete_message.
Only a message sent THROUGH Turbo Notify can be canceled. One typed on the phone itself belongs to the same number but cannot be canceled here, and neither can a message received from someone else.
The 15-minute limit for a text or a caption does not apply to a calendar event.
The cancel is accepted at once and the outcome arrives as an event:
message.edited when it worked, message.edit.failed when WhatsApp or
the platform could not apply it. Read them with list_events.
The number first appears online and its unread messages in that conversation are marked as read, then the cancel happens. Opening the conversation this way is automatic and uses no quota of its own.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The event's title, up to 200 characters. | |
| end_at | No | When the event ends. ISO 8601 with an offset, and later than `start_at`. | |
| location | No | Where the event takes place: a map pin with an optional name and address. | |
| start_at | Yes | When the event starts. ISO 8601 with an offset, for example `2026-09-10T14:00:00Z`. A time without an offset is rejected. | |
| join_link | No | A link guests can open to join, for example a video call. | |
| message_id | Yes | Message id (`msg_…`), as returned by a send or by `list_messages`. | |
| description | No | Details shown on the event, up to 2000 characters. | |
| has_reminder | No | Set to true to remind guests before the event. Off when left out. | |
| number_alias | No | Which of the organization's WhatsApp numbers this acts on: `main`, the alias of an extra number, or the number's `id` (`num_…`), which stays the same when the alias is renamed. Call `list_numbers` to see them. Defaults to the main number. | main |
| reminder_offset_sec | No | How many seconds before the event the reminder goes off, for example 600 for ten minutes. Only takes effect together with `has_reminder`. | |
| extra_guests_allowed | No | Set to true to let guests bring extra people. Off when left out. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||