A customer's whole profile
https://api.app2email.com/v1/{number}/bookings/customers/{contact} Scope: bookings:manage (or messages:read). Contact details and tags, upcoming and past appointments, internal notes and reminders, packages, payments, stats and the last 20 messages: one call for an agent that is about to talk to the customer.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270 -
The customer: number with country code, or business-scoped user id.
e.g.61412345678
Responses
Fields
- success boolean
- request_id string
- upcoming object[]
- past object[]
- notes object[]
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).
- reminders object[]
Notes with a remind_at that is due.
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).
- packages object[]
13 item fields
- id integere.g.
5 - contact string
- contact_name string
- package_id string
- package_name string
- services string[]
- sessions_total integer
- sessions_used integer
- sessions_left integer
- expires string (date-time) | null
- status string
pendingactiveused_upexpiredrefundedcancelled - payment_id integer | null
- created string (date-time)
- payments object[]
24 item fields
- id integere.g.
15 - kind string
bookingrequestpackageticket - status string
pendingpaidpartly_refundedrefundedfailedexpiredcancelled - provider string
stripepaypal - amount numbere.g.
40 - amount_label stringe.g.
$40.00 - full_label string
The price before a discount.
- discount_label string
- coupon_code string
- currency stringe.g.
USD - refunded number
- refunded_label string
- description string
- contact string
- payer_name string
- appointment_id integer | null
- booking_reference stringe.g.
BK-7Q3M2A - package_purchase_id integer | null
- checkout_url string
The provider's checkout page while the payment is open. Empty otherwise.
- link_url string
A payment request's page on the business's booking site.
- last_error string
- paid string (date-time) | null
- refunded_at string (date-time) | null
- created string (date-time)
- messages object[]
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.