Check a ticket in (or out) by its code or id
https://api.app2email.com/v1/{number}/tickets/check-ins 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
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270
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
-
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.
-
out: check out, for events that count people leaving.
inout -
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.
-
true: admit although it is too early, too late or the wrong entrance.
Responses
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
- ticket object
The ticket after the scan. null for result unknown.
29 fields
- id integer
The ticket's id.
e.g.501 - order_id integere.g.
8812 - order_reference stringe.g.
TK-7H3KQ9 - event_id integere.g.
12 - date_id integer
The date the ticket is for.
e.g.31 - type_id integere.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
-
The answers given for this ticket: question id -> value.
- seat object | null
null without a seat.
- 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.
- replaced_by_id integer
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.
- first object | null
result already_in: the earlier admission. null otherwise.
- 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.