The internal notes of a customer
https://api.app2email.com/v1/{number}/bookings/notes Scope: bookings:manage (or messages:read). Every note about one customer (contact is required), pinned first then newest. Page with next_cursor.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270
Query
- contact string
The customer: number with country code, or business-scoped user id. Required.
e.g.61412345678 -
How many (1 to 200, default 50).
- cursor string
The next_cursor of the previous answer, unchanged. Leave out for the first page.
Responses
Fields
- success boolean
- request_id string
- notes object[]
Pinned first, then newest.
11 item 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).
- count integer
- next_cursor string
Pass it as cursor for the next page. Left out on the last page.
- contact string
- booking object
GET /bookings/{id}/notes only.
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.
- 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.