The opt-in records, or check one number
https://api.app2email.com/v1/{number}/optins Your own proof that people agreed to your messages (kept by app2email; nothing else uses it unless the opt-in rule is on). Needs the 'settings:manage' scope.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270
Query
- number string
Check only this number: opted_in true or false.
e.g.61412345678 -
How many (1 to 200, default 100).
- after string
The next_after of the previous page.
e.g.61412345678
Responses
Fields
- success boolean
- request_id string
- total integer
- optins object[]
- next_after string
Pass as 'after' for the next page. Left out on the last page and with ?number=.
- opted_in boolean
Only with ?number=: is this number opted in?
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.