Switch ticket sales on or off and change the settings
https://api.app2email.com/v1/{number}/settings/tickets Scope: tickets:manage. Not with a sandbox key. enabled switches ticket sales on or off; config holds whole sections of the settings (organiser, hold_minutes, notify, brand, ticket_style, wa, privacy, texts): a section sent replaces the stored section, the others stay. The first call makes the ticket settings of the number. Switching off never strands what was sold: the tickets, refunds and the door go on working. 403 tickets_not_enabled while ticket sales are not open for this number, 403 plan_not_allowed, 400 invalid_setting with details.problems, 400 nothing_to_change with neither key. The answer is the one of GET /settings/tickets plus note.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270
Body application/json required
- enabled boolean
Switch ticket sales on or off.
-
Whole sections of the settings: 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. A section sent replaces the stored section; the others stay.
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
- 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.