Start an account for a person (agent sign-up)
https://api.app2email.com/v1/account/signup No key. E-mails the person a link to confirm; nothing is created until they do. Then they connect their WhatsApp number and pay. Every call makes a new sign-up, key and e-mail: an open sign-up of the same address is replaced (its link and management_key stop working). An address that has an account is never linked: the person creates an account key on the dashboard instead. Limits: per address, per e-mail address and in all (429 too_many_signups).
Body application/json required
-
The person's e-mail address. They get a link to confirm.
-
The business the account is for.
- plan string
A plan id from GET /v1/account/plans the person means to choose.
Responses
Fields
- success boolean
- request_id string
- signup_id stringe.g.
su_Q7pX2mLw9Rk4Tz1b - status string
pending_email - management_key string
An account key with every account permission. Shown once. Until the person confirms, it works only for GET /v1/account; it expires with the sign-up (48 h), and stops working when a newer create_account for the same address replaces the sign-up.
- onboarding_link string (uri)
Give it to the person: it says what to do next. The confirmation itself is the e-mailed link.
- expires_at string (date-time)
- next_steps string[]
What to do next, in plain words.
- message string
- instant_sandbox object
A key that works at once on app2email's demo number, where pretend customers answer and nothing reaches WhatsApp. Left out of create_account's answer when it could not be made.
12 fields
- api_key string
The instant sandbox key (a2es_..., 96 characters). Shown once. Send it as Authorization: Bearer on base_url or mcp_url. It works only on the demo number.
- expires string (date-time)
7 days after it was made.
- number string
The demo number: the {number} of every call.
e.g.12025550100 - base_url string (uri)e.g.
https://api.app2email.com/v1/12025550100 - mcp_url string (uri)e.g.
https://api.app2email.com/mcp - what_it_is string
- test_contacts object[]
The pretend customers: the only numbers the sandbox writes to.
- templates string[]
- calls string[]
The calls the demo number has. Any other: 403 not_in_instant_sandbox.
- try_first object[]
- not_here string
Errors
- 400 The request is malformed (missing or invalid fields, query parameters or times).
- 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.