Pick the winning time

POST https://api.app2email.com/v1/{number}/bookings/polls/{id}/book
scope: bookings:manage sandbox: refused Idempotency-Key

Scope: bookings:manage. Not with a sandbox key. The option is checked like a business booking (409 booking_slot_taken when it is not free any more). With a main contact an appointment is made for them (source dashboard; the normal WhatsApp confirmation unless notify is false); without one the time is blocked in the calendar under the poll's title. The poll becomes booked and poll.closed is sent with the chosen option. 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
  • id string required

    The poll's id.

    e.g. 12

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

  • option_id string required

    One of the poll's options[].id.

    e.g. c
  • notify boolean default true

    Tell the customer on WhatsApp (when the poll has a contact).

Responses

200 Booked.
Fields
  • success boolean
  • request_id string
  • poll object

    A meeting poll: 2 to 10 possible times people vote on at the poll's page (url). The times are not held.

    16 fields
  • booking object

    An appointment. The same object is the data of the booking.created, booking.cancelled, booking.rescheduled and booking.rated webhook events.

    30 fields
    • id integer
      e.g. 42
    • reference string

      The short code the customer sees. GET /bookings/{id} takes it too.

      e.g. BK-7Q3M2A
    • status string
      confirmedcancelledcompletedno_show
    • contact string

      The customer's number (digits, country code first) or their business-scoped user id.

      e.g. 61412345678
    • contact_name string
      e.g. John Smith
    • e.g. john@example.com
    • service object
      3 fields
    • start string (date-time)

      UTC.

    • end string (date-time)

      UTC.

    • timezone string

      The business time zone the slot was chosen in.

      e.g. Australia/Sydney
    • source string

      Booked by the customer in WhatsApp, on the dashboard (or in the calendar app), through this API, or by the customer on the online booking page (web).

      whatsapp_flowdashboardapiweb
    • calendar object
      4 fields
      • provider string
        builtingooglemicrosoftcaldavics
      • event_id string
      • url string
      • error string

        The calendar write failed; the booking still stands.

    • answers object any keys

      Every other field the customer filled in the Flow.

    • notes string
    • provider object

      The staff member, when the business has them. Left out otherwise.

      2 fields
      • id string
        e.g. maria
      • name string
        e.g. Maria
    • rating integer

      The customer's rating from the follow-up message (5 loved it, 3 OK, 1 not great). Left out until given.

      135
    • The business's own note on the payment. Left out when none.

      link_sentpaidwaived
    • credits_used integer

      Always 0 (memberships were removed on 2026-11-10); kept so existing integrations keep parsing.

    • attendance_confirmed string (date-time)

      When the customer tapped Confirm on a reminder.

    • cancelled object

      Only when cancelled.

      3 fields
      • at string (date-time)
      • by string
        customerbusinessapisystem
      • reason string
    • The appointment this one replaced.

    • notes_count integer

      How many internal notes are written on this appointment (GET /bookings/{id}/notes). Given by the calendar routes and the list; left out of webhook events.

    • created string (date-time)
    • location object | null

      Where it takes place, as chosen (null: the service has no locations; then config.messages.location). value: the address, the number, the link; a video link made by the connected Google or Microsoft calendar appears here once made. text: how the messages show it.

      4 fields
      • kind string
        in_personphone_we_callphone_you_callvideocustomer_addresscustom
      • label string
      • value string
      • text string
    • addons object[]

      The add-ons booked (copied at booking time).

      4 item fields
    • guests object[]

      The people who come along.

      2 item fields
    • answer_items object[]

      The answers to the service's questions as label / value (the raw ones are in answers.q).

      3 item fields
    • series object | null

      This appointment is one of a series (null: not).

      4 fields
      • id string
        e.g. SR-7Q3M2A
      • index integer
      • count integer
      • freq string
        weeklybiweeklyevery4weeksmonthly
    • seats integer

      The places this booking takes on a group time (1 + guests); 1 otherwise.

  • 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 integer
      e.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

api_key_expiredapi_key_number_mismatchapi_key_old_formatapi_key_revokedapproval_body_too_largebackground_start_failedblock_list_busyblock_list_fullblock_users_errorblock_users_failedbooking_not_enabledbooking_slot_takenbroadcast_cancelledbsuid_not_supportedcall_permission_requiredcaption_not_supportedcaption_too_longdaily_cap_reacheddisplay_name_not_approvedduplicate_recipientsfree_form_single_recipientidempotency_key_reusedidempotency_request_in_progressidempotency_request_interruptedinsufficient_scopeinternal_errorinvalid_addonsinvalid_api_keyinvalid_authorization_headerinvalid_base64invalid_bookinginvalid_callback_datainvalid_componentsinvalid_contacts_messageinvalid_cursorinvalid_guestsinvalid_idempotency_keyinvalid_identity_key_hashinvalid_interactiveinvalid_jsoninvalid_locationinvalid_marketing_apiinvalid_media_linkinvalid_number_in_urlinvalid_pollinvalid_rangeinvalid_reactioninvalid_recipientsinvalid_reply_toinvalid_send_atinvalid_serviceinvalid_toip_not_allowedmarketing_disabled_on_cloud_apimarketing_per_user_limitmedia_download_errormedia_download_failedmedia_too_largemedia_type_not_allowedmedia_upload_errormedia_upload_failedmessage_too_oldmessaging_limit_restrictedmissing_api_keymissing_interactivemissing_mediamissing_message_idmissing_template_languagemissing_template_namemissing_textmonthly_cap_reachedmonthly_limit_reachednumber_already_verifiednumber_not_foundoutside_24h_windowparameter_value_invalidplan_not_allowedpoll_not_foundrange_too_largerate_limitedreaction_too_oldrecipient_identity_changedrecipient_in_experimentrecipient_is_senderrecipient_not_allowedrecipient_not_opted_inrecipient_opted_outrecipient_stopped_marketingrecipient_unreachableregister_limit_reachedrequired_parameter_missingsandbox_keyschedule_failedsegment_and_recipientssegment_emptysegment_not_foundsend_at_in_pastsend_at_too_farservice_not_livetemplate_disabledtemplate_format_policytemplate_language_not_foundtemplate_lookup_failedtemplate_not_approvedtemplate_not_foundtemplate_not_marketingtemplate_parameter_count_mismatchtemplate_parameter_format_mismatchtemplate_parameter_invalidtemplate_parameters_invalidtemplate_pausedtemplate_sample_media_failedtemplate_text_too_longtext_too_longto_and_recipientstoo_many_messages_to_recipienttoo_many_recipientsunsupported_message_typeusername_account_not_linkedusername_change_limitusername_not_availableusername_not_eligibleusername_takenvoice_needs_ogg_opuswhatsapp_account_lockedwhatsapp_account_restrictedwhatsapp_connection_problemwhatsapp_errorwhatsapp_maintenancewhatsapp_number_not_registeredwhatsapp_parameter_errorwhatsapp_payment_issuewhatsapp_rate_limitwhatsapp_unavailable
  • 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.

Webhooks it causes

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.