Add an internal note to an appointment

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

Scope: bookings:manage. Not with a sandbox key. The note is about the appointment's customer and written on this appointment. author is "API key <name>" and author_kind "api". booking.note.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

  • 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 booking's id, or its reference (BK-XXXXXX).

    e.g. BK-7Q3M2A

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

  • body string required max 4000 chars
    e.g. Prefers the window seat.
  • pinned boolean default false
  • contact string

    POST /bookings/notes only: the customer (number with country code, or business-scoped user id). Left out when booking_id is given.

    e.g. 61412345678
  • booking_id string

    POST /bookings/notes only: the appointment (id or reference) the note is written on; the customer is taken from it.

    e.g. BK-7Q3M2A

Responses

201 Added.
Fields
  • success boolean
  • request_id string
  • note object

    An internal note about a customer, optionally written on one appointment. Never shown to the customer. Also the data of the booking.note.created event (plus booking and timestamp).

    11 fields
    • id integer
      e.g. 7
    • contact string

      The customer.

      e.g. 61412345678
    • appointment_id integer | null

      The appointment it was written on. null: a note on the customer alone.

    • booking_reference string | null
      e.g. BK-7Q3M2A
    • body string

      Up to 4000 characters.

    • author string

      A person's name or e-mail, or API key <name>.

      e.g. API key Planner
    • author_kind string
      userapiagentsystem
    • pinned boolean
    • created string (date-time)
    • updated string (date-time)
    • Only in GET /bookings/{id}/notes: written on that appointment (false: another note of the same customer).

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