The personal booking links
https://api.app2email.com/v1/{number}/bookings/links Scope: bookings:manage (or messages:read). The personal links of the number, newest first; contact shows one customer's. Each has its state (ok, expired, revoked, used_up, off) and how often it was opened. 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
Only this customer's links.
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
- links object[]
Newest first.
21 item fields
- id integer
- code stringe.g.
k3XbQ9rTzP2m - url stringe.g.
https://www.app2email.com/book/k3XbQ9rTzP2m - kind string
This API makes and lists personal links.
personalpublicfeed - contact string | null
Who the link is for. null: a one-off link the customer confirms on WhatsApp.
- contact_name string | null
- service_id string | null
- provider_id string | null
- purpose string
bookreschedulemanage - booking_id integer | null
The appointment of a reschedule / manage link.
- single_use boolean
- max_uses integer
0 = no limit.
- uses integer
- expires string (date-time) | null
- revoked string (date-time) | null
- source stringe.g.
api - created_by stringe.g.
API key Planner - open_count integer
- last_opened string (date-time) | null
- created string (date-time)
- state string
ok: it opens. off: the online booking page is switched off.
oknot_foundexpiredrevokedused_upoff
- count integer
- next_cursor string
Pass it as cursor for the next page. Left out on the last page.
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.