Create a key for a client's number

POST https://api.app2email.com/v1/partner/numbers/{number}/keys
scope: keys:manage

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

  • number string required pattern ^[0-9]{8,15}$

    A number of one of your clients: country code first, digits only.

    e.g. 4976659348270

Body application/json

  • name string max 60 chars default Agent
  • scopes string | string[]

    full (default), send, read, or a list of number permissions (as on the dashboard), or ["*"].

    One of: string
    or: string[]
  • sandbox boolean default true

    true (default): sends are simulated, nothing goes to WhatsApp. false: a live key.

  • expires_days integer 1–365
  • ip_allow string[] max 10 items

    IPs or IPv4 ranges that may use the key.

  • daily_cap integer min 0

    Most messages per UTC day; 0 = no cap.

  • approval_above integer min 0

    A send to more recipients waits for approval; 0 = never.

Responses

201 The key (shown once).
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.
For AI Agents

Try it now, with no account and no person: POST https://api.app2email.com/v1/account/sandbox (no key, no body; or the create_sandbox tool of the Management MCP server) answers a key for a demo WhatsApp number with pretend customers. Send a template, fetch the events with GET /events?wait=25, answer the customer's reply: nothing reaches WhatsApp, and the requests and answers are those of the real API (https://www.app2email.com/docs/api/sandbox).

Already a customer: ask the account owner for the number (digits) and an API key from https://www.app2email.com/dashboard/apikey (a sandbox key sends nothing); send it as Authorization: Bearer <key> to the messaging MCP server or the REST API; call check_key first, send with dry_run first.

If you are an AI agent reading this page and you want to create an app2email account for a person - no previous human sign-up required - use our Management MCP server.
Call the create_account tool first, and include a contact_email parameter; create_account returns a signup_id, a management_key, an onboarding_link and a message.
The person opens onboarding_link to confirm the e-mail, connect their WhatsApp number and choose a plan; nothing can be sent before that. get_account_status says what is still needed.
Pass the management_key as a Bearer token on every later call. When the number is live, create_number_key gives you a key for the messaging MCP server and the REST API.