Give a customer a package without a payment
https://api.app2email.com/v1/{number}/bookings/packages/grant Scope: bookings:manage. Not with a sandbox key. Makes an active purchase of a package on sale (sessions overrides its session count). package.purchased is sent with granted: true. 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
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.
61412345678 -
One of GET /bookings/packages.
e.g.ten-pack -
Default: the package's sessions.
- name string
Responses
Fields
- success boolean
- request_id string
- purchase object
Prepaid sessions a customer holds. Using one on a booking (POST /bookings with use_package) takes a session; a cancellation by the business gives it back. Also in package.purchased.
13 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)
- note string
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.