Add an internal note to an appointment
https://api.app2email.com/v1/{number}/bookings/{id}/notes 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
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270 -
The booking's id, or its reference (BK-XXXXXX).
e.g.BK-7Q3M2A
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
- e.g.
Prefers the window seat. - 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
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 integere.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 | nulle.g.
BK-7Q3M2A - body string
Up to 4000 characters.
- pinned boolean
- created string (date-time)
- updated string (date-time)
- on_this_booking boolean
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.