Create an account key
https://api.app2email.com/v1/account/keys Shown once. Never more permissions than the calling key has. At most 20 per account.
Body application/json required
- scopes string | string[]
full (default), read, or a list of account permissions. Never more than the calling key has.
One of: string
or: string[]
Responses
Fields
- success boolean
- request_id string
- account_key string
The key. Shown once.
- key object
11 fields
- id stringe.g.
ak_Hc4dR8sLm2Qv9Xw1 - name string
- scopes string[]
- prefix stringe.g.
a2e_acct_ - first4 string
- last4 string
- created string (date-time)
- created_by string
dashboardapicreate_account - last_used string (date-time) | null
- expires string (date-time) | null
- management_key boolean
Made by create_account (an agent's sign-up).
- message 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.
- 409 Idempotency-Key: the first request with this key is still running, or did not finish. Or a conflict: the template name exists, the webhook URL is used by another webhook, the broadcast cannot be cancelled, the booking slot is taken or the booking is already cancelled, or the Flow is not published.
- 415 The body is not JSON.
- 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.