Limited offer50% off your first month: the $99 plan for $4924 hours onlySee plans
← All integrations
WhatsApp logo

WhatsApp

WhatsApp messaging for Sequencer sends and the Unibox.

CommunicationOAuth29 endpoints

Endpoints

OperationMethod & pathEffectLatencyRateCost
accounts_list
List the Unipile accounts on this tenancy (use to locate the WhatsApp account_id).
GET /api/v1/accountsnone——no bill
accounts_get
Retrieve the connected WhatsApp account, including status (CONNECTED, CREDENTIALS, OK, ERROR, etc.) and the linked phone number.
GET /api/v1/accounts/{id}none——no bill
accounts_delete
Unlink the WhatsApp account from Unipile (the linked-device session is revoked).
DELETE /api/v1/accounts/{id}external_send——no bill
accounts_update_proxy
Update the proxy configuration Unipile uses for this WhatsApp account.
PATCH /api/v1/accounts/{id}external_send——no bill
accounts_restart
Restart the sources of a frozen WhatsApp account.
POST /api/v1/accounts/{id}/restartexternal_send——no bill
chats_list
List the WhatsApp account's own chats (inbox). Scope to the connected WhatsApp account via account_id; optionally filter unread.
GET /api/v1/chatsnone——no bill
chats_get
Retrieve a single WhatsApp chat the account is already a participant in.
GET /api/v1/chats/{chat_id}none——no bill
chats_patch
Act on a WhatsApp chat via { action, value }: setReadStatus / setMuteStatus / setArchiveStatus / setPinnedStatus (boolean value), addParticipant / removeParticipant / setLabel (string value), getInviteLink (no value). Participant changes are visible group-admin actions.
PATCH /api/v1/chats/{chat_id}external_send——no bill
chats_delete
Delete a WhatsApp chat from the account's inbox.
DELETE /api/v1/chats/{chat_id}external_send——no bill
chats_sync
Synchronize one WhatsApp conversation from its beginning — the on-demand, paginated history backfill. Call once to start, then poll the same route to monitor: status is SYNC_STARTED | SYNC_RUNNING | SYNC_DONE | SYNC_ERROR | CHAT_DELETED. Re-calling after DONE or ERROR starts a fresh sync.
GET /api/v1/chats/{chat_id}/syncnone——no bill
chats_messages_list
List messages in a WhatsApp chat the account already has (read inbox history).
GET /api/v1/chats/{chat_id}/messagesnone——no bill
chats_attendees_list
List attendees of a WhatsApp chat the account is in (e.g. to resolve the contact to reply to, or enumerate group members).
GET /api/v1/chats/{chat_id}/attendeesnone——no bill

Showing 12 of 29 WhatsApp actions. Every action is in the provider catalog, and the CLI and MCP list them with their inputs.