Reference
API reference
101 endpoints, grouped by family. Each one: what it does, its fields, its response, its refusals, and an example in cURL, Node.js and Python.
Endpoint descriptions are in English, the language of integration.
- GET
/broadcastsList broadcasts - POST
/broadcastsSend a broadcast - GET
/broadcasts/{id}Get a broadcast - POST
/broadcasts/{id}/cancelCancel a broadcast - DEL
/broadcasts/{id}/recipientsClear the recipients of a broadcast - GET
/broadcasts/{id}/recipientsList the recipients of a broadcast - POST
/broadcasts/{id}/recipientsAdd recipients to a broadcast - POST
/broadcasts/{id}/resumeResume a broadcast - POST
/broadcasts/{id}/sendSend or schedule a broadcast - POST
/broadcasts/previewPreview who a broadcast would reach
Channels
14- GET
/channelsList the channels - POST
/channelsCreate a test channel - DEL
/channels/{id}Delete a channel - GET
/channels/{id}Get a channel - PATCH
/channels/{id}Switch a channel on or off, or rename it - POST
/channels/{id}/checkCheck a WhatsApp number - POST
/channels/{id}/diagnosticDiagnose a WhatsApp number - GET
/channels/{id}/display-nameGet the display name of a WhatsApp number - POST
/channels/{id}/display-nameRequest a new display name - GET
/channels/{id}/profileGet the profile of a WhatsApp number - PATCH
/channels/{id}/profileChange the profile of a WhatsApp number - DEL
/channels/{id}/usernameRemove the username of a WhatsApp number - GET
/channels/{id}/usernameGet the username of a WhatsApp number - PUT
/channels/{id}/usernameSet the username of a WhatsApp number
Flows
22- GET
/flow-responsesList Flow responses - GET
/flowsList WhatsApp Flows - POST
/flowsCreate a WhatsApp Flow - DEL
/flows/{id}Delete a draft Flow - GET
/flows/{id}Get a WhatsApp Flow - PATCH
/flows/{id}Rename a WhatsApp Flow - DEL
/flows/{id}/data-endpointDetach the data endpoint of a Flow - GET
/flows/{id}/data-endpointGet the data endpoint of a Flow - PUT
/flows/{id}/data-endpointAttach a data endpoint to a Flow - POST
/flows/{id}/data-endpoint-testTry the data endpoint of a Flow - POST
/flows/{id}/deprecateDeprecate a Flow - POST
/flows/{id}/duplicateDuplicate a Flow - GET
/flows/{id}/healthGet the sending health of a Flow - GET
/flows/{id}/invocationsList the calls Meta made to a Flow - GET
/flows/{id}/previewGet the preview of a Flow - POST
/flows/{id}/publishPublish a Flow - GET
/flows/{id}/versionsList the versions of a Flow - POST
/flows/{id}/versionsSave a new version of a Flow - GET
/flows/{id}/versions/{versionId}Get one version of a Flow - GET
/flows/encryptionRead the encryption state of the client's numbers - POST
/flows/encryptionRegister the encryption key on a number - POST
/flows/syncSync Flows from Meta
- GET
/templatesList message templates - POST
/templatesDraft a template - DEL
/templates/{id}Delete a template - GET
/templates/{id}Get one template - PATCH
/templates/{id}Edit a template - POST
/templates/{id}/deployDeploy a template to Meta - POST
/templates/{id}/refreshAsk Meta where a template stands - POST
/templates/importImport the templates already at Meta - POST
/templates/samplesPrepare a header sample upload - POST
/templates/samples/{id}/confirmConfirm a header sample
- GET
/connect-linksList connect links - DEL
/connect-links/{id}Revoke a connect link - GET
/tenantsList your tenants - POST
/tenantsCreate a tenant - DEL
/tenants/{id}Close a tenant - GET
/tenants/{id}Get a tenant - PATCH
/tenants/{id}Update a tenant - GET
/tenants/{id}/channelsList the channels of a tenant - POST
/tenants/{id}/connect-linksCreate a hosted connect link
- GET
/webhooksList your webhook subscriptions - POST
/webhooksSubscribe to events - DEL
/webhooks/{id}Unsubscribe - GET
/webhooks/{id}Get a subscription - PATCH
/webhooks/{id}Change a subscription - POST
/webhooks/{id}/rotate-secretRotate the signing secret - POST
/webhooks/{id}/testSend a test call - GET
/webhooks/deliveriesList deliveries - POST
/webhooks/deliveries/{id}/redeliverRedeliver an event