Release a held time
https://api.app2email.com/v1/{number}/bookings/holds/{reference} Scope: bookings:manage. Not with a sandbox key. Frees the time at once. Releasing a time that was already released answers 200 again; one that expired or was booked answers 409 hold_expired.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270 -
The hold's reference, as POST /bookings/holds answered.
e.g.BK-4HT9XC
Responses
Fields
- success boolean
- request_id string
- released boolean
- 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
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.
- 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.