Keep a free time for a few minutes

POST https://api.app2email.com/v1/{number}/bookings/holds
scope: bookings:manage sandbox: refused Idempotency-Key MCP: hold_booking_slot

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

  • number string required pattern ^[0-9]{8,15}$

    Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.

    e.g. 4976659348270

Headers

  • Idempotency-Key string max 255 chars

    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

  • service_id string required
    e.g. haircut
  • start string required

    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 string
    e.g. John
  • minutes integer 1–30 default 10

    How long to keep the time.

  • answers_q object any keys

    The answers to the service's questions, by question id (see POST /bookings).

  • location_index integer 0–3

    Which of the service's locations (0-based). Left out: the first.

  • location_value string max 300 chars

    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.

  • guests object[] max 10 items

    People who come along; on a group service each takes a place.

    2 item fields
    • name string required max 60 chars
    • phone string
  • utm object any keys

    { source, medium, campaign, term, content }, kept with the booking.

Responses

201 Held.
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.
For AI Agents

Try it now, with no account and no person: POST https://api.app2email.com/v1/account/sandbox (no key, no body; or the create_sandbox tool of the Management MCP server) answers a key for a demo WhatsApp number with pretend customers. Send a template, fetch the events with GET /events?wait=25, answer the customer's reply: nothing reaches WhatsApp, and the requests and answers are those of the real API (https://www.app2email.com/docs/api/sandbox).

Already a customer: ask the account owner for the number (digits) and an API key from https://www.app2email.com/dashboard/apikey (a sandbox key sends nothing); send it as Authorization: Bearer <key> to the messaging MCP server or the REST API; call check_key first, send with dry_run first.

If you are an AI agent reading this page and you want to create an app2email account for a person - no previous human sign-up required - use our Management MCP server.
Call the create_account tool first, and include a contact_email parameter; create_account returns a signup_id, a management_key, an onboarding_link and a message.
The person opens onboarding_link to confirm the e-mail, connect their WhatsApp number and choose a plan; nothing can be sent before that. get_account_status says what is still needed.
Pass the management_key as a Bearer token on every later call. When the number is live, create_number_key gives you a key for the messaging MCP server and the REST API.