Skip to content

API PlatformDevelopers

Get started

Make your first request Keys and permissions Errors Pagination Safe retries (Idempotency-Key)Rate limits and send caps Versions Dry runs and confirmations Webhooks and signatures Filtering contacts Error codes

Recipes

API reference

›Contacts

GETList contacts GETCount contacts POSTSearch contacts POSTCount contacts by filter POSTCheck a contact filter POSTCreate or update a contact GETGet a contact PATCHUpdate a contact DELETEDelete a contact GETFind a contact by phone GETList saved filters GETGet a saved filter POSTSave a contact filter PATCHChange a saved filter DELETEDelete a saved filter POSTImport contacts in bulk

›Tags

GETList contact tags POSTCreate a tag POSTAdd tags to contacts POSTRemove tags from contacts DELETEDelete a tag

›Contact groups

GETList contact groups POSTCreate a contact group POSTAdd contacts to a group DELETERemove contacts from a group PATCHRename a contact group DELETEDelete a contact group

›Custom fields

GETList custom fields POSTCreate a custom field GETGet a custom field PATCHUpdate a custom field DELETEDelete a custom field

›Messages

POSTSend a WhatsApp template POSTSend a message POSTSend a message in a conversation POSTSend a file in a conversation POSTAdd a system message GETList messages of a conversation

›Templates

GETList WhatsApp templates POSTCreate a WhatsApp template GETGet a template PUTEdit a WhatsApp template POSTCheck a template draft POSTArchive templates POSTUpload a template header sample

›Quick messages

GETList quick messages POSTCreate a quick message PATCHUpdate a quick message DELETEDelete a quick message

›Short links

GETList WhatsApp short links POSTCreate a short link GETGet a short link PATCHChange a short link's message DELETEDelete a short link

›Broadcasts

GETList broadcasts GETGet a broadcast POSTCheck broadcast readiness

›Channels

GETList channels

›Conversations

GETList conversations GETGet a conversation and its 24-hour window GETCount conversations PUTAssign a conversation DELETEUnassign a conversation POSTClose a conversation POSTReopen a conversation POSTAdd an internal note POSTTag a conversation DELETEUntag a conversation POSTSet a reminder

›Webhooks

GETList endpoints POSTCreate an endpoint GETGet an endpoint PATCHUpdate an endpoint DELETEDelete an endpoint GETList event types GETGet a sample payload GETList deliveries GETGet a delivery GETList events GETGet an event POSTTurn an endpoint on POSTTurn an endpoint off POSTRotate the signing secret PUTSet subscriptions POSTSend a test event POSTRetry a delivery now POSTReplay an event

›Reports

GETWorkspace summary GETMessaging report GETBroadcasts report GETConversations report GETStaff report GETSLA report

Webhook events

Event catalog Checking signatures

Updates

Changelog RSS feed

rate_limited

HTTP 429 · Too many requests

What it means

You went over a rate limit or a send cap.

What to do

Wait for Retry-After seconds, then retry. Spread big jobs out.

Returned by

© API Platform API status Support Terms Privacy llms.txt OpenAPI