Skip to main content
POST
Connect a WhatsApp Number

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Body

application/json
success_redirect_url
string

Optional hosted-onboarding success redirect. No local URL validation.

failure_redirect_url
string

Optional hosted-onboarding failure redirect. No local URL validation.

language
string

Optional provider language; no local enum/default.

Response

Successful response.

success
enum<boolean>
required
Available options:
true
channel_id
string
required
expires_at
string<date-time> | null
Last modified on September 8, 2026