Onboarding link for a new or existing client
https://api.app2email.com/v1/partner/onboarding-links Single use, 24 h, signed, on your site. The person signs up or in, connects WhatsApp, presses Finish, and lands on redirect_url with ?client=<client id>&numbers=<number,...>&state=<state>.
Body application/json
- email string (email)
Shown on the link's page.
- client_id string
An existing client: only that client can finish it (a client with no password yet chooses one).
-
Comes back unchanged in the redirect.
- redirect_url string
https. Default: your redirect_url (PATCH /v1/partner); none: the client's dashboard.
Responses
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.
- 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.