Keep a free time for a few minutes
https://api.app2email.com/v1/{number}/bookings/holds Scope: bookings:manage. Not with a sandbox key. Keeps a free time for minutes (1 to 30, default 10) so no one else can book it while the customer decides: it counts as taken in the availability, the calendar and every booking check. The slot is checked like a booking is; 409 booking_slot_taken when it is not free. Book it with POST /bookings and hold (the reference), or release it with DELETE; it frees itself at expires. 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
- e.g.
haircut -
A free slot of GET /bookings/availability or /bookings/next: Local time in the business time zone, yyyy-MM-ddTHH:mm.
e.g.2026-11-10T09:00 - provider_id string
Left out (or "any"): the first free staff member who does the service.
e.g.maria - contact string
The customer, when known.
e.g.61412345678 - name stringe.g.
John -
How long to keep the time.
-
The answers to the service's questions, by question id (see POST /bookings).
-
Which of the service's locations (0-based). Left out: the first.
-
The customer's address, for an at-your-address location.
- addon_ids string[]
The service's add-ons: the time is held as long as they make it.
-
People who come along; on a group service each takes a place.
-
{ source, medium, campaign, term, content }, kept with the booking.
Responses
Fields
- success boolean
- request_id string
- hold object
A time kept for a few minutes so no one else can book it.
12 fields
- reference string
Becomes the booking's reference when the hold is booked.
e.g.BK-4HT9XC - status string
heldbookedexpiredreleased - service_id string
- provider_id string | null
The staff member the time is kept with.
- contact string | null
- name string | null
- start string (date-time)
UTC.
- end string (date-time)
UTC.
- start_local string
Local time in the business time zone, yyyy-MM-ddTHH:mm.
- end_local string
Local time in the business time zone, yyyy-MM-ddTHH:mm.
- expires string (date-time)
When the time is freed.
- source string
webapi
- 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.
- 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.
- 415 The body is not JSON.
- 422 The request is understood but cannot be sent (template parameters, media, text, recipient, or a WhatsApp rule such as the 24 hour window).
- 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.