Cancel one date and refund or void its tickets
https://api.app2email.com/v1/{number}/tickets/dates/{date_id}/cancel Scope: tickets:manage. Not with a sandbox key. Cancels this one date; the other dates of the event go on. refund: all = everything paid goes back, prices = the ticket prices without booking fees and donations, none = the tickets are voided and no money moves. confirm must be the word CANCEL. The answer comes at once (started true); the orders are refunded one by one in the background, the ticket holders are told unless notify is false, ticket.order.refunded is sent for each order and ticket.event.cancelled when it has finished. It cannot be undone. 409 ticket_not_allowed when the date is already cancelled or has ended. Send an Idempotency-Key header to retry safely: the same key and body within 24 hours gets the first answer again (an error does not use the key up).
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270 -
The date's id.
e.g.31
Headers
-
A unique value for this message or list (eg a UUID). The same request with the same key within 24 hours gets the first answer again, and nothing is sent twice. Ignored by dry runs.
e.g.order-1234-shipped
Body application/json required
-
all: everything paid goes back. prices: the ticket prices without booking fees and donations. none: the tickets are voided and no money moves.
allpricesnone -
Told to the ticket holders.
-
false: do not tell the ticket holders.
-
Must be the word CANCEL.
CANCEL
Responses
Fields
- success boolean
- request_id string
- date object
One date (session) of an event. A one-off event has exactly one. Also inside ticket.event.sold_out and ticket.event.cancelled.
18 fields
- id integer
The date's id.
e.g.31 - event_id integer
The event it belongs to.
e.g.12 - start string (date-time)
When it starts (UTC).
- end string (date-time)
When it ends (UTC).
- start_local string
The start as clock time in the event's time zone (yyyy-MM-ddTHH:mm).
e.g.2026-12-12T19:30 - end_local string
The end as clock time in the event's time zone.
e.g.2026-12-12T21:30 - label string
A short name of the date, eg Late show. Empty when it has none.
- capacity integer | null
How many people fit: the date's own limit, else the event's; with a seat plan the places of the plan. null = no limit.
- sales string
paused: nothing is sold for this date right now.
onpaused - status string
scheduledendedcancelled - sold integer | null
Valid tickets (extras not counted). The five counts sold, people, held, left and checked_in are null inside webhook events, in the door list and in next_date of the events list.
- people integer | null
The people those tickets admit (a group ticket admits several).
- held integer | null
People in baskets right now.
- left integer | null
People that can still be sold. null = no limit, or the counts were not read.
- checked_in integer | null
People admitted at the door.
- sold_out boolean
The date sold its last public ticket and no place has come back since.
- changed string (date-time) | null
When the time or the venue last changed and ticket holders were told.
- cancelled string (date-time) | null
When the date was cancelled.
- started boolean
Only after a cancel: the refunds run in the background.
- note string
What happened, in one sentence.
Errors
- 400 The request is malformed (missing or invalid fields, query parameters or times).
- 401 Missing, invalid, revoked or expired API key.
- 403 The key is valid but this call is not allowed: the key lacks the scope the call needs (insufficient_scope), the address is not allowed for the key (ip_not_allowed), the number or plan does not allow it, a recipient opted out or is not opted in, or a problem with the WhatsApp account.
- 404 The number, template, message, broadcast, webhook, delivery, opt-in, logged request, booking or Flow was not found.
- 409 Idempotency-Key: the first request with this key is still running, or did not finish. Or a conflict: the template name exists, the webhook URL is used by another webhook, the broadcast cannot be cancelled, the booking slot is taken or the booking is already cancelled, or the Flow is not published.
- 429 A monthly plan limit, the number's own monthly cap, the key's daily cap, a WhatsApp rate limit, the API rate limit (rate_limited), or the webhook test limit (too_many_tests) was reached. Retry-After and error.retry_after_seconds say how long to wait.
- 500 Unexpected error on app2email's side.
- 502 WhatsApp (Meta) returned an error or could not be reached.