Switch Book-and-Pay on or off and change the settings
https://api.app2email.com/v1/{number}/settings/booking Scope: bookings:manage. Not with a sandbox key. config is partial: a section object is merged key by key into the stored section, a list (services, providers, schedule.overrides) or a single value replaces what is stored. The whole result is checked against the rules of every section (400 invalid_setting with details.problems; nothing is saved then). Switching Book-and-Pay on also creates the utility templates bookings send outside the 24 hour window (Meta reviews them).
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
-
The booking configuration, by section. trigger: the words that send the Flow, its intro text and button; schedule: timezone, opening hours per weekday (hours.mon ... [["09:00", "17:00"]]), slot_interval_min, buffers, min_notice_min, max_advance_days, max_per_slot, max_per_day (the most appointments on one day, per staff member when there is staff; 0 = no limit), cancel_notice_min (a customer may cancel or move only until this many minutes before the start; 0 = any time), overrides (closed days); services: id, name, duration_min, description, price, enabled, prep_text, aftercare_text, retail_links, payment_link, deposit_text; details: ask_email, ask_notes; messages: the texts the customer gets (placeholders {service} {date} {time} {duration} {business} {location} {reference} {name} {phone} {notes} {end_time} {provider} {prep} {booking_link}), web: see the web property, reminders, followup, rebook, notify_email; calendar: provider (builtin | google | microsoft | caldav | ics | calcom | calendly | acuity | square | msbookings | simplybook | setmore | zohobookings), write_calendar_id, busy_calendar_ids, event_title, event_description; providers: the staff members. GET /settings/booking shows every key with its value.
8 fields
-
The words that start a booking, and the message with the button.
other_words_limit(default 10, 0 to 100): a trigger word counts only when the message has fewer than this many other words, so a long message never starts a Flow; 0 = a message of any length.e.g.{"keywords":["book","appointment"],"other_words_limit":10,"intro_text":"Tap the… - e.g.
{"timezone":"Australia/Sydney","slot_interval_min":30,"min_notice_min":120,"max… - services object[]e.g.
[{"id":"haircut","name":"Haircut","duration_min":30,"price":"$40","enabled":tru… - e.g.
{"ask_email":true,"ask_notes":true} - e.g.
{"provider":"builtin"} -
The online booking page: enabled, slug (the public address /book/<slug>; unique, 5 to 40 characters of a-z 0-9 and - for a new or changed address), headline, intro, trigger_mode (flow | link | both), link_button, link_text, link_valid_days (1..60), hold_minutes (5..30), confirm_text (must contain {reference}), allow_manage.
e.g.{"enabled":true,"slug":"sample-salon","trigger_mode":"both","link_valid_days":7… - providers object[]
-
Responses
Fields
- success boolean
- request_id string
- enabled boolean
Book-and-Pay is switched on: the trigger words send the Flow.
- configured boolean
false: the number has never been set up (the config shown is the default).
-
The booking configuration, by section. trigger: the words that send the Flow, its intro text and button; schedule: timezone, opening hours per weekday (hours.mon ... [["09:00", "17:00"]]), slot_interval_min, buffers, min_notice_min, max_advance_days, max_per_slot, max_per_day (the most appointments on one day, per staff member when there is staff; 0 = no limit), cancel_notice_min (a customer may cancel or move only until this many minutes before the start; 0 = any time), overrides (closed days); services: id, name, duration_min, description, price, enabled, prep_text, aftercare_text, retail_links, payment_link, deposit_text; details: ask_email, ask_notes; messages: the texts the customer gets (placeholders {service} {date} {time} {duration} {business} {location} {reference} {name} {phone} {notes} {end_time} {provider} {prep} {booking_link}), web: see the web property, reminders, followup, rebook, notify_email; calendar: provider (builtin | google | microsoft | caldav | ics | calcom | calendly | acuity | square | msbookings | simplybook | setmore | zohobookings), write_calendar_id, busy_calendar_ids, event_title, event_description; providers: the staff members. GET /settings/booking shows every key with its value.
8 fields
-
The words that start a booking, and the message with the button.
other_words_limit(default 10, 0 to 100): a trigger word counts only when the message has fewer than this many other words, so a long message never starts a Flow; 0 = a message of any length.e.g.{"keywords":["book","appointment"],"other_words_limit":10,"intro_text":"Tap the… - e.g.
{"timezone":"Australia/Sydney","slot_interval_min":30,"min_notice_min":120,"max… - services object[]e.g.
[{"id":"haircut","name":"Haircut","duration_min":30,"price":"$40","enabled":tru… - e.g.
{"ask_email":true,"ask_notes":true} - e.g.
{"provider":"builtin"} -
The online booking page: enabled, slug (the public address /book/<slug>; unique, 5 to 40 characters of a-z 0-9 and - for a new or changed address), headline, intro, trigger_mode (flow | link | both), link_button, link_text, link_valid_days (1..60), hold_minutes (5..30), confirm_text (must contain {reference}), allow_manage.
e.g.{"enabled":true,"slug":"sample-salon","trigger_mode":"both","link_valid_days":7… - providers object[]
-
- flow object
The default Flow (the booking form).
14 fields
- key string
The Flow's key: what POST /flows/{key}/send takes.
e.g.booking - name stringe.g.
Appointment booking - kind string
bookingform - enabled boolean
- is_default boolean
The Flow the generic trigger words send.
- trigger_keywords string[]
Words that send this Flow.
- id string
Meta's id of the Flow, once uploaded.
- status string
Meta's status. Only a published Flow can be sent.
nonedraftpublisheddeprecatedblockedthrottlederror - can_send boolean
enabled and published.
- health string
Meta's health word: AVAILABLE, LIMITED, BLOCKED, or empty.
- validation string
Meta's validation problems in words, when there are any.
- last_error string
- last_published_at string
- updated_at string (date-time)
- flows object[]
14 item fields
- key string
The Flow's key: what POST /flows/{key}/send takes.
e.g.booking - name stringe.g.
Appointment booking - kind string
bookingform - enabled boolean
- is_default boolean
The Flow the generic trigger words send.
- trigger_keywords string[]
Words that send this Flow.
- id string
Meta's id of the Flow, once uploaded.
- status string
Meta's status. Only a published Flow can be sent.
nonedraftpublisheddeprecatedblockedthrottlederror - can_send boolean
enabled and published.
- health string
Meta's health word: AVAILABLE, LIMITED, BLOCKED, or empty.
- validation string
Meta's validation problems in words, when there are any.
- last_error string
- last_published_at string
- updated_at string (date-time)
- key_status string
The Flow encryption key at Meta (publishing needs valid).
uploadedvalidmismatcherror - timezone stringe.g.
Australia/Sydney - validation string[]
Problems in the stored settings, if any (a saved config is always valid; the default one is empty here).
- note string
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.
- 415 The body is not JSON.
- 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.
- 503 app2email's connection to the WhatsApp account needs attention, or the request log is not available right now.