Add a ticket type or an extra to an event

POST https://api.app2email.com/v1/{number}/tickets/events/{id}/types
scope: tickets:manage sandbox: refused Idempotency-Key

Scope: tickets:manage. Not with a sandbox key. name is needed; everything else has a default (a free ticket that admits one person and has no limit of its own). role addon makes an extra such as parking, bought together with a ticket. price_mode choose lets the buyer name the amount, from min_price. pool_id, opens_after and needs point at a pool or another ticket type of the same event (0 = none). 409 ticket_limit_reached at 40 ticket types. 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
  • id string required

    The event: its id, its slug (eg summer-quiz) or its code (EV-XXXXX).

    e.g. summer-quiz

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

  • name string max 30 chars

    Needed for a new ticket type.

    e.g. Child
  • price number min 0

    In the event's currency, with at most its decimals. Default 0.

    e.g. 6
  • role string

    Default ticket.

    ticketaddon
  • description string max 300 chars
  • visibility string

    Default public.

    publichidden
  • price_mode string

    Default fixed.

    fixedchoose
  • min_price number min 0

    price_mode choose: the least amount. Default 0.

  • admits integer 1–20 default 1
  • quantity integer 0–100000 default 0

    0 = no limit of its own.

  • pool_id integer default 0

    A pool of the same event. 0 = none.

  • opens_after integer default 0

    Another ticket type of the same event. 0 = none.

  • needs integer default 0

    Another ticket type of the same event. 0 = none.

  • needs_each boolean default false
  • min_per_order integer 1–50 default 1
  • max_per_order integer 0–50 default 0

    0 = the event's order limit.

  • sales_start string | null

    Local time in the event's time zone (2026-12-12T19:30) or ISO 8601 with an offset (2026-12-12T19:30:00+11:00). null = with the event.

  • sales_end string | null

    Local time in the event's time zone (2026-12-12T19:30) or ISO 8601 with an offset (2026-12-12T19:30:00+11:00). null = with the event's rule.

  • sales_end_days integer 0–60 default 0
  • date_ids integer[]

    Dates of the same event. [] = every date.

  • door_note string max 80 chars
  • sort integer

    Default: last.

  • status string

    Only when changing a ticket type.

    activearchived

Responses

201 Added.
Fields
  • success boolean
  • request_id string
  • type object

    A ticket type (a named price) or an extra of an event.

    29 fields
    • id integer

      The ticket type's id.

      e.g. 44
    • event_id integer
      e.g. 12
    • name string
      e.g. Adult
    • description string
    • role string

      ticket: admits people. addon: an extra such as parking or a drink voucher, bought with a ticket.

      ticketaddon
    • status string

      archived: offered nowhere any more; the tickets sold stay valid.

      activearchived
    • visibility string

      hidden: buyers see it only with a code that unlocks it.

      publichidden
    • sort integer

      The place in the list, lowest first.

    • price_mode string

      choose: the buyer names the amount, from min_price.

      fixedchoose
    • price number

      The price as the organiser typed it, in the event's currency.

      e.g. 12
    • price_label string
      e.g. A$12.00
    • price_all_in number

      What a buyer pays for one, booking fee and tax included.

      e.g. 12
    • e.g. A$12.00
    • min_price number

      price_mode choose: the least amount. 0 otherwise.

    • admits integer

      How many people one ticket admits (1 to 20).

    • quantity integer

      How many can be sold per date. 0 = no limit of its own.

    • pool_id integer

      The shared capacity it draws from. 0 = none.

    • opens_after integer

      The ticket type that must sell out before this one goes on sale. 0 = none.

    • needs integer

      The ticket type that must be in the same order. 0 = none.

    • needs_each boolean

      true: one of needs for each of these.

    • min_per_order integer
    • max_per_order integer

      0 = the event's order limit.

    • sales_start string (date-time) | null

      When its sale opens. null = with the event.

    • sales_end string (date-time) | null

      When its sale ends. null = with the event's rule.

    • Its sale ends this many days before each date. 0 = not used.

    • date_ids integer[]

      The dates it is sold for. [] = every date.

    • door_note string

      A note the door sees, eg Check student card.

    • created string (date-time)
    • updated string (date-time)
  • 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.
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.