Cancel one date and refund or void its tickets

POST https://api.app2email.com/v1/{number}/tickets/dates/{date_id}/cancel
scope: tickets:manage sandbox: refused Idempotency-Key

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

  • number string required pattern ^[0-9]{8,15}$

    Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.

    e.g. 4976659348270
  • date_id string required

    The date's id.

    e.g. 31

Headers

  • Idempotency-Key string max 255 chars

    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

  • refund string 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
  • reason string max 200 chars

    Told to the ticket holders.

  • notify boolean default true

    false: do not tell the ticket holders.

  • confirm string required

    Must be the word CANCEL.

    CANCEL

Responses

200 Cancelled; the refunds run in the background.
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.

Webhooks it causes

For AI Agents

Try it now, with no account and no person: POST https://api.app2email.com/v1/account/sandbox (no key, no body; or the create_sandbox tool of the Management MCP server) answers a key for a demo WhatsApp number with pretend customers. Send a template, fetch the events with GET /events?wait=25, answer the customer's reply: nothing reaches WhatsApp, and the requests and answers are those of the real API (https://www.app2email.com/docs/api/sandbox).

Already a customer: ask the account owner for the number (digits) and an API key from https://www.app2email.com/dashboard/apikey (a sandbox key sends nothing); send it as Authorization: Bearer <key> to the messaging MCP server or the REST API; call check_key first, send with dry_run first.

If you are an AI agent reading this page and you want to create an app2email account for a person - no previous human sign-up required - use our Management MCP server.
Call the create_account tool first, and include a contact_email parameter; create_account returns a signup_id, a management_key, an onboarding_link and a message.
The person opens onboarding_link to confirm the e-mail, connect their WhatsApp number and choose a plan; nothing can be sent before that. get_account_status says what is still needed.
Pass the management_key as a Bearer token on every later call. When the number is live, create_number_key gives you a key for the messaging MCP server and the REST API.