Create a promo or access code
https://api.app2email.com/v1/{number}/tickets/codes Scope: tickets:manage. Not with a sandbox key. code is 3 to 20 characters of A-Z, 0-9, _ and - (stored in upper case). kind percent takes a whole value from 1 to 100, kind amount an amount in currency (the default is the number's). event_ids and type_ids limit where it counts ([] = everywhere), unlocks lists hidden ticket types the code opens (then value may be 0), starts and ends are days, limit caps the uses per limit_unit. 409 ticket_not_allowed when a code with this name exists; 409 ticket_limit_reached at 1,000 codes. 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
- code string
Needed for a new code; it cannot be changed later. 3 to 20 characters of A-Z, 0-9, _ and -.
e.g.EARLY10 - kind string
Default percent.
percentamount - value number
kind percent: a whole number from 1 to 100. kind amount: an amount in currency. 0 only for a code that unlocks ticket types.
e.g.10 - currency string
kind amount. Default: the currency new events of the number start with.
- event_ids integer[]
Events of this number. Default []: every event.
- type_ids integer[]
Ticket types of this number. Default []: every ticket type.
- unlocks integer[]
Hidden ticket types of this number that the code opens.
- starts string
Empty or YYYY-MM-DD.
- ends string
Empty or YYYY-MM-DD.
e.g.2026-12-01 -
0 = no limit.
- limit_unit string
Default orders.
orderstickets
Responses
Fields
- success boolean
- request_id string
- code object
A promo code (a discount) or an access code (it unlocks hidden ticket types), with how often it was used.
17 fields
- id integere.g.
7 - code stringe.g.
EARLY10 - kind string
percentamount - value number
kind percent: 1 to 100. kind amount: an amount in currency.
- currency string
kind amount: the currency of value. The code only works for events in it.
- event_ids integer[]
[] = every event.
- type_ids integer[]
[] = every ticket type.
- unlocks integer[]
The hidden ticket types this code opens.
- starts string
Empty, or the first day it works (YYYY-MM-DD).
- ends string
Empty, or the last day it works (YYYY-MM-DD).
- limit integer
How often it can be used. 0 = no limit.
- limit_unit string
What limit counts.
orderstickets - enabled boolean
- batch string
The name of the batch, for codes made many at a time on the dashboard.
- uses object
The orders that used it and the tickets it was applied to.
- created string (date-time)
- updated string (date-time)
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.