Create a key for a client's number
https://api.app2email.com/v1/partner/numbers/{number}/keys The dashboard's key, for /v1/{number}/... and the messaging MCP. Shown once. Sandbox unless "sandbox": false. The number must be LIVE on a plan with the API (409 number_not_live + Retry-After); at most 10 keys per number.
Path
-
A number of one of your clients: country code first, digits only.
e.g.4976659348270
Body application/json
- scopes string | string[]
full (default), send, read, or a list of number permissions (as on the dashboard), or ["*"].
One of: string
or: string[]
-
true (default): sends are simulated, nothing goes to WhatsApp. false: a live key.
-
IPs or IPv4 ranges that may use the key.
-
Most messages per UTC day; 0 = no cap.
-
A send to more recipients waits for approval; 0 = never.
Responses
Fields
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.
- 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.