Check a ticket in (or out) by its code or id

POST https://api.app2email.com/v1/{number}/tickets/check-ins
scope: tickets:manage sandbox: refused Idempotency-Key MCP: check_in_ticket

Scope: tickets:manage. Not with a sandbox key. Send code (the text of the ticket's QR code; a link or other text around it is fine) with date_id, or ticket_id. The answer is always 200 when the request was understood: result ok and admitted true mean let the person in; any other result (already_in, not_inside, unknown, refunded, cancelled, transferred, blocked, wrong_event, wrong_date, wrong_gate, too_early, too_late) is a refusal with the reason in note, not an error. direction out checks out, for events that count people leaving; people admits a part of a group ticket; force admits although it is too early, too late or the wrong entrance. check_in.id is the handle for the undo. ticket.checked_in is sent the first time a ticket is admitted. The code of a whole order is not taken: 400 invalid_ticket_check_in. 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

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

  • code string max 300 chars

    The text of the ticket's QR code. A link or other text around it is fine. Needs date_id.

  • ticket_id integer

    The ticket's id, instead of code.

  • date_id integer

    The date the person is entering. Needed with code; with ticket_id it defaults to the ticket's own date.

  • direction string default in

    out: check out, for events that count people leaving.

    inout
  • people integer 0–20 default 0

    For a group ticket: how many people enter now. 0 = everyone who is not in yet.

  • gate string

    The id of the entrance, one of the event's settings.door.gates. Default: the first.

  • force boolean default false

    true: admit although it is too early, too late or the wrong entrance.

Responses

200 The result of the scan, admitted or refused.
Fields
  • success boolean
  • request_id string
  • result string

    ok: admitted (or checked out). Every other value is a refusal.

    okalready_innot_insideunknownrefundedcancelledtransferredblockedwrong_eventwrong_datewrong_gatetoo_earlytoo_late
  • admitted boolean

    result is ok.

  • people integer

    People admitted or checked out by this call.

  • check_in object
    5 fields
    • id integer

      The check-in's id: the handle for the undo. 0 when nothing was recorded.

    • at string (date-time) | null
    • direction string
      inout
    • gate string
    • forced boolean
  • ticket object

    The ticket after the scan. null for result unknown.

    29 fields
    • id integer

      The ticket's id.

      e.g. 501
    • order_id integer
      e.g. 8812
    • e.g. TK-7H3KQ9
    • event_id integer
      e.g. 12
    • date_id integer

      The date the ticket is for.

      e.g. 31
    • type_id integer
      e.g. 44
    • type_name string

      The ticket type's name as it was sold.

      e.g. Adult
    • role string
      ticketaddon
    • seq integer

      1..n inside the order.

    • status string

      valid and blocked tickets hold a place; refunded, cancelled and transferred (passed on) are final.

      validblockedrefundedcancelledtransferred
    • holder_name string
    • answers object any keys

      The answers given for this ticket: question id -> value.

    • seat object | null

      null without a seat.

      6 fields
      • key string

        The key of the seat in the seat plan.

      • label string
        e.g. Stalls, Row C, Seat 7
      • section string
      • row string
      • seat string
      • table string
    • admits integer
    • check_in object

      The check-in state of a ticket.

      7 fields
      • people integer

        People admitted so far (0 to admits). Above 0 = checked in.

      • inside integer

        People inside now, for events that count people leaving.

      • entries integer

        Accepted scans on the way in.

      • first_at string (date-time) | null
      • last_at string (date-time) | null
      • last_out_at string (date-time) | null
      • gate string

        The id of the entrance of the last scan.

    • currency string
    • price number

      What was paid for this ticket, all in: what a refund of it returns.

    • price_label string
    • face number

      The all-in list price before a discount.

    • refunded number
    • refunded_at string (date-time) | null
    • block_reason string

      Why staff blocked it. A disputed payment reads Payment disputed.

    • passed_on boolean

      true: the ticket was made when a holder passed a ticket on.

    • replaces_id integer

      The ticket this one replaced. 0 = none.

    • The ticket that replaced this one. 0 = none.

    • page_url string

      The ticket page of this ticket. Anyone who has the link can open the ticket: treat it like a password and give it only to the buyer. Empty in webhook events, for an erased order and for a ticket that is no longer valid.

    • created string (date-time)
    • updated string (date-time)
    • buyer object

      Only in the rows of GET /tickets/issued: who bought it.

      3 fields
  • first object | null

    result already_in: the earlier admission. null otherwise.

    3 fields
    • at string (date-time) | null
    • gate string
    • by string
  • 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.

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.