Register a WhatsApp phone number

Register a phone number from the workspace's WhatsApp Business Account.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <API_KEY>, where API_KEY is your API key.

Path parameters

workspaceIdstringRequired
Workspace whose WhatsApp phone number to register.

Headers

X-Account-IdstringRequired
Account that owns the workspace.

Request

This endpoint expects an object.
phoneNumberIdstringRequired

Phone number ID from the phone-numbers list. It must not already be assigned to another workspace.

pinstringOptional

Six-digit two-step verification PIN. Required for numbers not already CONNECTED.

Response

Confirms the phone number was registered.
successboolean
True when the phone number is registered and WhatsApp is connected.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error