WhatsApp Senders

Manage WhatsApp business senders — phone numbers registered under a WhatsApp Business Account (WABA). A sender must be verified and active before it can send messages. Connect your WhatsApp Business number first, then register it here with its WhatsApp Business Account ID and Phone Number ID (both found in Meta Business Manager) and verify.

Add Sender

POST

/v1/whatsapp/senders

Register a WhatsApp business sender. After creation (and once the account and phone number IDs are set), call verify to begin registration.

Parameters

Parameter	Type	Description
`name`required	`string`	Internal name for the sender in the dashboard. Only you see this.
`phoneNumber`required	`string`	Business phone number in E.164 format (e.g. +61412345678).
`displayName`	`string`	Verified display name shown to recipients on WhatsApp.
`wabaId`	`string`	WhatsApp Business Account ID, found in Meta Business Manager under WhatsApp Accounts. Required before verifying.
`phoneNumberId`	`string`	ID of the phone number registered to your WhatsApp Business Account (not the phone number itself). Required before verifying.

Example Response

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "name": "Acme Support",
  "phoneNumber": "+61412345678",
  "displayName": "Acme",
  "status": "not_started",
  "phoneNumberId": "pn-123",
  "wabaId": "waba-1",
  "rejectionReason": null,
  "createdAt": "2026-06-04T10:00:00Z",
  "updatedAt": "2026-06-04T10:00:00Z"
}

List Senders

GET

/v1/whatsapp/senders

List all WhatsApp senders for the current team.

Get Sender

GET

/v1/whatsapp/senders/{id}

Retrieve a single WhatsApp sender by ID.

Update Sender

PATCH

/v1/whatsapp/senders/{id}

Update name, display name, WhatsApp Business Account ID, or Phone Number ID.

Delete Sender

DELETE

/v1/whatsapp/senders/{id}

Delete a WhatsApp sender. Cannot be deleted once it has messages.

Verify Sender

POST

/v1/whatsapp/senders/{id}/verify

Start or restart registration for a sender (status not_started, failed, or rejected). The WhatsApp Business Account ID and Phone Number ID must be set first.

Sender Status Lifecycle

not_startedInitial state. Set the WhatsApp Business Account ID and Phone Number ID, then call verify.
pendingRegistration in progress with the provider.
activeVerified and ready to send.
failedRegistration failed. Retry via verify.
rejectedRejected by Meta/provider. Check rejectionReason; can retry.
suspendedSuspended by the provider. Contact support.