The ticket settings and whether ticket sales are switched on
https://api.app2email.com/v1/{number}/settings/tickets Scope: tickets:manage. Works for every number, also before ticket sales are set up. available says whether ticket sales are open for this number at all (false: every other ticket call answers 403 tickets_not_enabled), configured whether the number has ticket settings, enabled and selling whether tickets are sold now, and why not (tables_missing, no_config, removed, off, plan). Also the address of the events page, the currency and the time zone new events start with, which of the business's payment providers can take a ticket payment, and config: the settings with every default filled in. Nothing is changed by this call.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270
Responses
Fields
- success boolean
- request_id string
- available boolean
false: ticket sales are not open for this number yet. Every other ticket call then answers 403 tickets_not_enabled.
- configured boolean
The number has ticket settings.
- enabled boolean
Ticket sales are switched on.
- selling boolean
Tickets are sold now: available, switched on, and in the plan.
- why string
Empty when selling, else why not.
tables_missingno_configremovedoffplan - events_url string
The page that lists the number's events.
- currency string
The currency new events start with.
- timezone string
The time zone new events start with.
- payments object
The business's own payment providers that can take a ticket payment.
-
The number's ticket settings with every default filled in. Sections: organiser {name, email, phone}, hold_minutes (5 to 30), notify {sale, email}, brand {logo, color, background, hide_powered}, ticket_style {layout, accent, background, text, image, image_as, logo, font, fields, footer}, wa {keywords, intro_text, cta, mine_keywords, send_pdf, texts}, privacy {retention_days, url}, texts. texts and wa.texts hold one wording per key (the sentences buyers read on the pages and in the chat); the example shows two of each.
- note string
What happened, in one sentence.
Errors
- 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.