Skip to main content
WhatsApp endpoints let you read the organization’s connected sender accounts and send a single ad-hoc message to a lead — immediately, outside the sequence engine. Sent messages thread into the lead’s inbox conversation. Every endpoint on this page operates inside the calling organization’s tenant — you cannot read or write WhatsApp accounts or messages from another organization with the same key.
A personal credential lists and sends only from the member’s own connected account. Org-global or another member’s account → 403 FORBIDDEN. Audit does not store the message body.

List WhatsApp accounts

Scope: whatsapp:read. Lists the organization’s connected WhatsApp sender accounts. Use the returned id as the whatsappAccountId when creating a WhatsApp sequence or sending a message.

Request

Response 200


Send a WhatsApp message

Scope: whatsapp:write. Sends a one-off WhatsApp message to a single lead immediately — outside the sequence engine. The message is sent from the given account and threads into the lead’s inbox conversation.
This costs 1 monthly unit against your quota, like any ordinary request. See Rate limits.

Request body

Request

Response 200

Common errors

  • 404 NOT_FOUND — the lead does not exist or belongs to another organization.
  • 400 OPTED_OUT — the lead opted out of WhatsApp and cannot be messaged.
  • 400 ACCOUNT_UNAVAILABLE — the WhatsApp account was not found or is not connected.
  • 400 BAD_REQUEST — the lead has no valid phone number.
  • 400 VALIDATION_ERROR — invalid body (e.g. empty message, leadId not a UUID, invalid media.type).
  • 403 FORBIDDEN — personal credential using an account that is not the caller’s.
  • 429 NUMBER_RATE_LIMITED — the number is paused or out of budget.