The promo and access codes with their uses
https://api.app2email.com/v1/{number}/tickets/codes Scope: tickets:manage. The promo codes (a discount) and the access codes (they unlock hidden ticket types), by id, each with how many orders and tickets used it. q searches in the code, enabled filters. Page with next_cursor.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270
Query
- q string
Search in the code (2 to 80 characters).
e.g.EARLY - enabled boolean
true: only codes that are switched on. false: only the ones switched off.
-
How many (1 to 200, default 50).
- cursor string
The next_cursor of the previous answer, unchanged. Leave out for the first page.
Responses
Fields
- success boolean
- request_id string
- codes object[]
By id.
17 item 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)
- next_cursor string | null
Pass it as cursor for the next page. null on the last page.
- count integer
How many rows this answer has.
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.
- 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.