Account status and what is still needed
https://api.app2email.com/v1/account pending_email, pending_whatsapp, pending_payment or live, with the numbers and next steps. Works with the management_key before the person confirms.
Responses
Fields
- success boolean
- request_id string
- account object
6 fields
- status string
pending_email: the person has not confirmed. pending_whatsapp: no WhatsApp number yet, or a number with a plan is not LIVE (paused, being connected). pending_payment: no number has a plan with the API. live: at least one number is live.
pending_emailpending_whatsapppending_paymentlive - email string | null
Masked until the person confirms.
- name string | null
- numbers object[]
10 item fields
- number stringe.g.
4976659348270 - display_number string | nulle.g.
+49 7665 9348270 - name string | null
The WhatsApp display name.
- status string
live: LIVE with a plan that includes the API. pending_payment: no such plan yet. not_live: paused, expired or still being connected.
livepending_paymentnot_live - service_status string | nulle.g.
LIVE - plan stringe.g.
standard_5000 - plan_label stringe.g.
Standard 5,000 - api_allowed boolean
- billing_period_end string (date-time) | null
- renewal_enabled boolean
- signup_id string | null
- signup_expires string (date-time) | null
- key object
- next_steps string[]
What to do next, in plain words.
Errors
- 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.
- 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.
- 502 WhatsApp (Meta) returned an error or could not be reached.
- 503 app2email's connection to the WhatsApp account needs attention, or the request log is not available right now.