Block time so that no one can book it
https://api.app2email.com/v1/{number}/calendar/blocks Scope: bookings:manage. Not with a sandbox key. Time off, a break, a closed afternoon: for one staff member (provider_id) or the whole business. Give start and end, or date for one whole day. Existing appointments are not touched. The block is made with source "api" and created_by "API key <name>"; calendar.block.created is sent. 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
- start string
Local time in the business time zone, yyyy-MM-ddTHH:mm. Or ISO 8601 with an offset (2026-11-14T12:00:00+11:00).
e.g.2026-11-14T12:00 - end string
Same format as start. After start, at most 31 days later.
e.g.2026-11-14T13:00 - date string
Instead of start and end: one whole day (YYYY-MM-DD, business time zone).
e.g.2026-11-14 - provider_id string
A staff member (GET /bookings/staff). Left out: the whole business.
e.g.maria - e.g.
Lunch
Responses
Fields
- success boolean
- request_id string
- block object
Time that cannot be booked: time off, a break, a closed afternoon. Also the data of the calendar.block.created and calendar.block.deleted events.
12 fields
- id integere.g.
3 - provider_id string
The staff member it is for. Empty: the whole business.
e.g.maria - title string
Up to 80 characters.
e.g.Lunch - notes string
Up to 500 characters.
- start string (date-time)
UTC.
- end string (date-time)
UTC.
- start_local string
Local time in the business time zone, yyyy-MM-ddTHH:mm.
e.g.2026-11-14T12:00 - end_local string
Local time in the business time zone, yyyy-MM-ddTHH:mm.
e.g.2026-11-14T13:00 - source string
Made in the calendar app, or through this API.
calendarapi - created_by string
The e-mail of the person, or API key <name>.
e.g.API key Planner - created string (date-time)
- updated string (date-time)
- 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.