{"info":{"_postman_id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","name":"Verloop Partner - API documentation","description":"

📄 Get started here

This document lists all the APIs supported by Verloop for the partners to manage their whatsapp clients, send messages etc. The APIs are categorised into Management APIs and Messaging APIs. Each would require different types of authorization token to be added in the headers.

🔖 How to use this template

The path suffixes are to be added to the base root url https://partners.verloop.io/. The only exception being https://partners.verloop.io/auth to get the auth token

Authorization

We have two kinds of APIs, Business Management APIs and Messaging APIs. Depending on the category, these APIs require different Access Tokens for authorization. All APIs use Authorization header to accept their respective Access Tokens.

Business Management APIs

Management APIs will require a user to have a System User Token. This can be generated from the Setting tab on the UI.

\n\n

Messaging APIs

Messaging APIs require a Phone Number token to be generated for the phone number. This can done by clicking on the kebab menu next a phone number on Client Details Page and then clicking on Generate Token

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"📄 Get started here","slug":"get-started-here"}],"owner":"27716702","collectionId":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","publishedId":"2sA3XY6J2Y","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-06-24T14:42:35.000Z"},"item":[{"name":"Acess Tokens","item":[{"name":"Auth","event":[{"listen":"test","script":{"id":"91e3e610-0478-4773-b462-05dbf7ff0776","exec":[""],"type":"text/javascript"}}],"id":"1d073cd0-8f9b-4917-b20b-ec6899a890d1","request":{"method":"POST","header":[{"key":"Authorization","value":"","description":"

Not needed for this API

\n","type":"text"}],"body":{"mode":"raw","raw":"{ \"username\": \"user@email.com\", \"password\": \"yourPassH3r3!\" }","options":{"raw":{"language":"json"}}},"url":"https://partners.verloop.com/api/v2/auth","description":"

Gets a SystemUserToken for Business Management APIs.

System User Token generated from dashboard

\n","type":"text"}],"url":"https://https://partners.verloop.com/api/v2/whatsapp/get_phone_token?client_id=some-client-id&phone_id=meta-phone-identifier","description":"

Gets Phone Number Access token for a Phone Number

client ID to which the phone belongs to

\n","type":"text/plain"},"key":"client_id","value":"some-client-id"},{"description":{"content":"

Meta assigned PhoneID for the phone number

\n","type":"text/plain"},"key":"phone_id","value":"meta-phone-identifier"}],"variable":[]}},"response":[{"id":"7fbc5ed8-35b0-4441-b101-7c80b98ca7ff","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"System User Token generated from dashboard","type":"text"}],"url":{"raw":"https://https:/partners.verloop.com/api/v2/whatsapp/get_phone_token?client_id=some-client-id&phone_id=meta-phone-identifier","protocol":"https","host":["https"],"port":"","path":["","partners.verloop.com","api","v2","whatsapp","get_phone_token"],"query":[{"key":"client_id","value":"some-client-id","description":"client ID to which the phone belongs to"},{"key":"phone_id","value":"meta-phone-identifier","description":"Meta assigned PhoneID for the phone number"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"token\": \"some-uuid\"\n}"}],"_postman_id":"b60c0866-fcfa-48f9-a26f-a89d244c3a83"}],"id":"a57333fd-c811-455e-b4d6-ceda5055965e","description":"

These endpoints help you get the Access Tokens needed to use the Business Management ot Messaging APIs.

\n","_postman_id":"a57333fd-c811-455e-b4d6-ceda5055965e","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","name":"Verloop Partner - API documentation","type":"collection"}}},{"name":"Business Management APIs","item":[{"name":"Template APIs","item":[{"name":"Create Template","event":[{"listen":"test","script":{"id":"c87b265f-0c08-4119-ae39-1deca7b89fea","exec":[""],"type":"text/javascript"}}],"id":"2556850b-ae65-490e-aeb1-100c9b5bc00b","request":{"method":"POST","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"

System User Token generated from dashboard

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ClientID\": some-client-id, // Client ID that template belongs to\n \"Template\": {{object}} //template body\n}","options":{"raw":{"language":"json"}}},"url":"https://partners.verloop.com/api/v2/whatsapp/create_template","description":"

Create a template for a Client's WABA.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","name":"Verloop Partner - API documentation","type":"collection"}},"urlObject":{"path":["whatsapp","create_template"],"host":["https://partners.verloop.com/api/v2"],"query":[],"variable":[]}},"response":[{"id":"3899ce34-a562-4493-b7e5-a665e5289f9e","name":"Create Template","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"System User Token generated from dashboard","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ClientID\": \"client_id\",\n \"Template\": {\n \"name\": \"seasonal_promotion\",\n \"language\": \"en_US\",\n \"category\": \"MARKETING\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"TEXT\",\n \"text\": \"Our {{1}} is on!\",\n \"example\": {\n \"header_text\": [\n \"Summer Sale\"\n ]\n }\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Shop now through {{1}} and use code {{2}} to get {{3}} off of all merchandise.\",\n \"example\": {\n \"body_text\": [\n [\n \"the end of August\",\n \"25OFF\",\n \"25%\"\n ]\n ]\n }\n },\n {\n \"type\": \"FOOTER\",\n \"text\": \"Use the buttons below to manage your marketing subscriptions\"\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"Unsubscribe from Promos\"\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"Unsubscribe from All\"\n }\n ]\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://partners.verloop.com/api/v2/whatsapp/create_template"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Resp\": {\n \"id\": \"572279198452421\",\n \"status\": \"PENDING\",\n \"category\": \"MARKETING\"\n }\n}"}],"_postman_id":"2556850b-ae65-490e-aeb1-100c9b5bc00b"},{"name":"List Templates","event":[{"listen":"test","script":{"id":"c87b265f-0c08-4119-ae39-1deca7b89fea","exec":[""],"type":"text/javascript"}}],"id":"0afb852c-9651-4c0c-b2e2-0d99053e87d4","request":{"method":"GET","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"

System User Token generated from dashboard

\n","type":"text"}],"url":"https://partners.verloop.com/api/v2/whatsapp/list_templates?Limit=532&Offset=711&ClientID=some-client-id","description":"

List templates for the linked WABA

The maximum number of templates you want returned in each page of results

\n","type":"text/plain"},"key":"Limit","value":"713"},{"description":{"content":"

Value of offset cursor in case you're making a paginated request

\n","type":"text/plain"},"key":"Offset","value":"595"},{"description":{"content":"

Client ID that the number belongs to

\n","type":"text/plain"},"key":"ClientID","value":"some-client-id"}],"variable":[]}},"response":[{"id":"41af78b9-0931-486e-9786-4ab0008a85dd","name":"List Templates","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"System User Token generated from dashboard","type":"text"}],"url":{"raw":"https://partners.verloop.com/api/v2/whatsapp/list_templates?Limit=179&Offset=713&ClientID=some-client-id","host":["https://partners.verloop.com/api/v2"],"path":["whatsapp","list_templates"],"query":[{"key":"Limit","value":"603","description":"The maximum number of templates you want returned in each page of results"},{"key":"Offset","value":"893","description":"Value of offset cursor in case you're making a paginated request"},{"key":"ClientID","value":"some-client-id","description":"Client ID that the number belongs to"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Resp\": {\n \"data\": [\n {\n \"name\": \"seasonal_promotion_text_only\",\n \"status\": \"APPROVED\",\n \"id\": \"564750795574598\"\n },\n {\n \"name\": \"seasonal_promotion_video\",\n \"status\": \"PENDING\",\n \"id\": \"1252715608684590\"\n }\n ],\n \"paging\": {\n \"cursors\": {\n \"before\": \"MAZDZD\",\n \"after\": \"MgZDZD\"\n }\n }\n }\n}"}],"_postman_id":"0afb852c-9651-4c0c-b2e2-0d99053e87d4"},{"name":"Delete Template","event":[{"listen":"test","script":{"id":"c87b265f-0c08-4119-ae39-1deca7b89fea","exec":[""],"type":"text/javascript"}}],"id":"4d026e17-bafd-4278-8ce9-cf490ae2d2d1","request":{"method":"DELETE","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"

System User Token generated from dashboard

\n","type":"text"}],"url":"https://partners.verloop.com/api/v2/whatsapp/delete_template?ID={{ID}}&Name={{TemplateName}}&ClientID=some-client-id","description":"

Delete template for the linked WABA. The API requires both ID and Name of the template needed to be deleted since deleting with only Name is not a unique identifier in a template namespace.

Template ID

\n","type":"text/plain"},"key":"ID","value":"{{ID}}"},{"description":{"content":"

Template name

\n","type":"text/plain"},"key":"Name","value":"{{TemplateName}}"},{"description":{"content":"

Client ID that the template belongs to

\n","type":"text/plain"},"key":"ClientID","value":"some-client-id"}],"variable":[]}},"response":[{"id":"adb88ee7-b538-4574-9cee-0b52703e1642","name":"Delete Template","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"System User Token generated from dashboard","type":"text"}],"url":{"raw":"https://partners.verloop.com/api/v2/whatsapp/delete_template?ID={{ID}}&Name={{TemplateName}}&ClientID=some-client-id","host":["https://partners.verloop.com/api/v2"],"path":["whatsapp","delete_template"],"query":[{"key":"ID","value":"{{ID}}","description":"Template ID\t"},{"key":"Name","value":"{{TemplateName}}","description":"Template name\t"},{"key":"ClientID","value":"some-client-id","description":"Client ID that the template belongs to\t"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"Success\": true\n}"}],"_postman_id":"4d026e17-bafd-4278-8ce9-cf490ae2d2d1"}],"id":"fa2554c2-8b63-43b2-98dd-ce69af86cd00","description":"

Message Templates are used to send Template messages or initate conversations with users. There APIs provide means to manage templates for a WABA.

Points to remember

Message Template Names: Keep your message template names concise - they can't be longer than 512 characters.
\n
Message Template Content: Make sure your message content is clear and to the point - it's limited to 1024 characters.
\n
Editing Templates: You can only edit templates that are currently approved, rejected, or paused. Additionally, you can only edit a template once per day, with a maximum of 10 edits per month.
\n
Template Creation Limits: WhatsApp Business Accounts have a limit of creating 100 message templates per hour.
\n
Desktop Viewing Limitations: Templates with 4 or more buttons, or a combination of a quick reply button and other buttons cannot be viewed on WhatsApp desktop clients. - Users will be prompted to switch to their phone to see these messages.
\n

\n","_postman_id":"fa2554c2-8b63-43b2-98dd-ce69af86cd00","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","name":"Verloop Partner - API documentation","type":"collection"}}},{"name":"Analytics APIs","item":[{"name":"Get Analytics","event":[{"listen":"test","script":{"id":"c87b265f-0c08-4119-ae39-1deca7b89fea","exec":[""],"type":"text/javascript"}}],"id":"0715792f-90e5-48d4-9b4f-c72b7970d3d7","request":{"method":"GET","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"

System User Token generated from dashboard

\n","type":"text"}],"url":"https://partners.verloop.com/api/v2/whatsapp/get_analytics?client_id=some-client-id&field={{query}}","description":"

Get conversation_analytics or message_analytics for a WABA.

ClientID waba belongs to

\n","type":"text/plain"},"key":"client_id","value":"some-client-id"},{"description":{"content":"

Visit https://developers.facebook.com/docs/whatsapp/business-management-api/analytics/ to get exhaustive list of parameters

\n","type":"text/plain"},"key":"field","value":"{{query}}"}],"variable":[]}},"response":[{"id":"806f647f-6e9b-4b8d-8603-12d9b59c0e9b","name":"Get Analytics","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"System User Token generated from dashboard","type":"text"}],"url":{"raw":"https://partners.verloop.com/api/v2/whatsapp/get_analytics?client_id=some-client-id&field={{query}}","host":["https://partners.verloop.com/api/v2"],"path":["whatsapp","get_analytics"],"query":[{"key":"client_id","value":"some-client-id","description":"ClientID waba belongs to"},{"key":"field","value":"{{query}}","description":"Visit https://developers.facebook.com/docs/whatsapp/business-management-api/analytics/ to get exhaustive list of parameters"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"data_points\": [\n {\n \"start\": 1685602800,\n \"end\": 1688194800,\n \"conversation\": 1558,\n \"phone_number\": \"15550458206\",\n \"country\": \"US\",\n \"conversation_type\": \"REGULAR\",\n \"conversation_direction\": \"UNKNOWN\",\n \"conversation_category\": \"AUTHENTICATION\",\n \"cost\": 15.58\n },\n {\n \"start\": 1685602800,\n \"end\": 1688194800,\n \"conversation\": 2636,\n \"phone_number\": \"15550458206\",\n \"country\": \"US\",\n \"conversation_type\": \"REGULAR\",\n \"conversation_category\": \"MARKETING\",\n \"cost\": 26.36\n },\n {\n \"start\": 1685602800,\n \"end\": 1688194800,\n \"conversation\": 2238,\n \"phone_number\": \"15550458206\",\n \"country\": \"US\",\n \"conversation_type\": \"REGULAR\",\n \"conversation_category\": \"SERVICE\",\n \"cost\": 22.38\n },\n {\n \"start\": 1685602800,\n \"end\": 1688194800,\n \"conversation\": 1782,\n \"phone_number\": \"15550458206\",\n \"country\": \"US\",\n \"conversation_type\": \"REGULAR\",\n \"conversation_category\": \"UTILITY\",\n \"cost\": 17.82\n },\n {\n \"start\": 1685602800,\n \"end\": 1688194800,\n \"conversation\": 1568,\n \"phone_number\": \"15550458206\",\n \"country\": \"US\",\n \"conversation_type\": \"FREE_TIER\",\n \"conversation_category\": \"AUTHENTICATION\",\n \"cost\": 15.68\n },\n {\n \"start\": 1685602800,\n \"end\": 1688194800,\n \"conversation\": 2716,\n \"phone_number\": \"15550458206\",\n \"country\": \"US\",\n \"conversation_type\": \"FREE_TIER\",\n \"conversation_category\": \"MARKETING\",\n \"cost\": 27.16\n },\n {\n \"start\": 1685602800,\n \"end\": 1688194800,\n \"conversation\": 2180,\n \"phone_number\": \"15550458206\",\n \"country\": \"US\",\n \"conversation_type\": \"FREE_TIER\",\n \"conversation_category\": \"SERVICE\",\n \"cost\": 21.8\n },\n {\n \"start\": 1685602800,\n \"end\": 1688194800,\n \"conversation\": 1465,\n \"phone_number\": \"15550458206\",\n \"country\": \"US\",\n \"conversation_type\": \"FREE_TIER\",\n \"conversation_category\": \"UTILITY\",\n \"cost\": 14.65\n },\n {\n \"start\": 1685602800,\n \"end\": 1688194800,\n \"conversation\": 1433,\n \"phone_number\": \"15550458206\",\n \"country\": \"US\",\n \"conversation_type\": \"FREE_ENTRY_POINT\",\n \"conversation_category\": \"SERVICE\",\n \"cost\": 14.33\n }\n ]\n }\n]"}],"_postman_id":"0715792f-90e5-48d4-9b4f-c72b7970d3d7"}],"id":"5f505215-2d48-40cb-8c52-bb1b55f97e47","description":"

You can get messaging and conversation analytics with the API. Note that only metrics for business phone numbers associated with your WABA at the time of the request will be included in responses.

\n","_postman_id":"5f505215-2d48-40cb-8c52-bb1b55f97e47","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","name":"Verloop Partner - API documentation","type":"collection"}}},{"name":"Media APIs","item":[{"name":"Upload Media File","id":"5da919ad-fbd0-4295-b01e-1c1e7afef3bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"

System User Token generated from dashboard

\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"client_id","value":"client-id","type":"text"},{"key":"file","type":"file","src":"/Users/sage/Downloads/download.jpeg"}]},"url":"https://partners.verloop.com/api/v2/whatsapp/upload_media","description":"

Uploads a media file to WhatsApp. The uploaded media is stored and returns an asset_handle that can be used in creating media card carousel templates.

Method: POST
Path: /upload_media
Content-Type: multipart/form-data

Form Data Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`client_id`	`string`	✅	Client identifier making the request.
`file`	`file`	✅	The actual media file to upload.
`file_name`	`string`	❌	Optional custom filename. Defaults to uploaded file’s name.
`file_type`	`string`	❌	MIME type of the file. Defaults to detected Content-Type.

Response: \n200 OK
{
\"message\": \"Media uploaded successfully\",
\"asset_handle\": \"MEDIA_ASSET_HANDLE\"
}

400 Bad Request
{
\"error\": \"invalid file type\"
}

500 Internal Server Error
{
\"error\": \"failed to upload: error details\"
}

System User Token generated from dashboard

\n","type":"text"}],"url":"https://partners.verloop.com/api/v2/whatsapp/get_media?client_id=some-client-id&id=media-id","description":"

Fetches media content by its WhatsApp media ID and returns the binary data directly.

Method: GET
URL: {{base_url}}/get_media

🔸 Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`id`	`string`	✅	The media ID assigned by WhatsApp.
`client_id`	`string`	✅	The unique identifier of the client requesting the media.

System User Token generated from dashboard

\n","type":"text"}],"url":"https://partners.verloop.com/api/v2/whatsapp/get_media_async?client_id=some-client-id&id=waba-media-id&destination_url=https://example.com/webhook/media","description":"

Queues a background job to download a media file from WhatsApp and send it to a specified destination URL (useful for large files)

Method: GET
URL: {{base_url}}/get_media_async

🔸 Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Required	Description
`id`	`string`	✅	The media ID assigned by WhatsApp.
`client_id`	`string`	✅	The client ID associated with the request.
`destination_url`	`string`	✅	URL where the downloaded media should be sent once available.

Request

GET {{base_url}}/get_media_async?id={{media_id}}&client_id={{client_id}}&destination_url={{destination_url}}\n\n

Response

{\n  \"message\": \"download queued\"\n}\n\n

","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","name":"Verloop Partner - API documentation","type":"collection"}},"urlObject":{"path":["whatsapp","get_media_async"],"host":["https://partners.verloop.com/api/v2"],"query":[{"key":"client_id","value":"some-client-id"},{"key":"id","value":"waba-media-id"},{"key":"destination_url","value":"https://example.com/webhook/media"}],"variable":[]}},"response":[],"_postman_id":"7d00f594-f37e-4bf4-aac2-95162e19cc90"}],"id":"9112fef0-ada3-4386-a1f7-e9da0f05b1cc","description":"

These APIs allow to upload, retrieve, and asynchronously download media files.

\n","_postman_id":"9112fef0-ada3-4386-a1f7-e9da0f05b1cc","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","name":"Verloop Partner - API documentation","type":"collection"}}},{"name":"List Clients","event":[{"listen":"test","script":{"id":"c87b265f-0c08-4119-ae39-1deca7b89fea","exec":[""],"type":"text/javascript"}}],"id":"dfab4e41-2b8b-42cd-8b11-cb39c101bb9b","request":{"method":"GET","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"

System User Token generated from dashboard

\n","type":"text"}],"url":"https://partners.verloop.com/api/v2/whatsapp/list_clients","description":"

List all clients belonging to a partners.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","name":"Verloop Partner - API documentation","type":"collection"}},"urlObject":{"path":["whatsapp","list_clients"],"host":["https://partners.verloop.com/api/v2"],"query":[],"variable":[]}},"response":[{"id":"e76052d3-06d4-44be-9027-f8be0c2de473","name":"List Clients","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"SystemUserToken ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://partners.verloop.com/api/v2/whatsapp/list_clients"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Resp\": {\n \"Clients\": [\n {\n \"ClientID\": \"id\",\n \"Name\": \"name\",\n \"Email\": \"email\",\n \"FullName\": \"full_name\",\n \"PhoneNumber\": \"phone_number\",\n \"OnboardingStatus\": \"onboarding_status\",\n \"WabaID\": \"waba_id\",\n \"WabaNumbers\": [\"waba_numbers\"],\n },\n {\n \"ClientID\": \"id2\",\n \"Name\": \"name2\",\n \"Email\": \"email2\",\n \"FullName\": \"full_name2\",\n \"PhoneNumber\": \"phone_number2\",\n \"OnboardingStatus\": \"onboarding_status2\",\n \"WabaID\": \"waba_id2\",\n \"WabaNumbers\": [\"waba_numbers\"],\n }\n ]\n }\n}"}],"_postman_id":"dfab4e41-2b8b-42cd-8b11-cb39c101bb9b"},{"name":"List Phone Numbers","event":[{"listen":"test","script":{"id":"c87b265f-0c08-4119-ae39-1deca7b89fea","exec":[""],"type":"text/javascript"}}],"id":"18629f28-3dc9-4317-8c1d-c2263482ff4d","request":{"method":"GET","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"

System User Token generated from dashboard

\n","type":"text"}],"url":"https://partners.verloop.com/api/v2/whatsapp/list_waba_phone_numbers?WABAID=000000000000000&ClientID=some-client-id","description":"

List all phone numbers for a WABAID.

WabaID attached to the client

\n","type":"text/plain"},"key":"WABAID","value":"000000000000000"},{"description":{"content":"

Client ID

\n","type":"text/plain"},"key":"ClientID","value":"some-client-id"}],"variable":[]}},"response":[{"id":"bb27e712-7a4c-40c1-a991-2b246010d24f","name":"List Phone Numbers","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"System User Token generated from dashboard","type":"text"}],"url":{"raw":"https://partners.verloop.com/api/v2/whatsapp/list_waba_phone_numbers?WABAID=000000000000000&ClientID=some-client-id","host":["https://partners.verloop.com/api/v2"],"path":["whatsapp","list_waba_phone_numbers"],"query":[{"key":"WABAID","value":"000000000000000","description":"WabaID attached to the client"},{"key":"ClientID","value":"some-client-id","description":"Client ID"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ListWabaPhoneNumbersResponse\": {\n \"WabaId\": \"000000000000000\",\n \"WabaPhoneNumberDetails\": [\n {\n \"VerifiedName\": \"some_name\",\n \"NumberVerificationStatus\": 1,\n \"DisplayPhoneNumber\": \"91XXXXXXXXXX\",\n \"QualityRating\": 1,\n \"PhoneID\": \"000000000000000\",\n \"NumberStatus\": 8,\n \"IsPinEnabled\": true\n }\n ]\n }\n}"}],"_postman_id":"18629f28-3dc9-4317-8c1d-c2263482ff4d"},{"name":"Create Number For WABA","event":[{"listen":"test","script":{"id":"c87b265f-0c08-4119-ae39-1deca7b89fea","exec":[""],"type":"text/javascript"}}],"id":"fb34a77b-692d-401f-b32e-f78b5dc772ee","request":{"method":"POST","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"

System User Token generated from dashboard

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"WABAID\" : \"12345678910\",\n \"PhoneNumber\": \"911234567899\",\n \"Language\": \"EN\",\n \"ClientID\": \"someclientid\"\n}","options":{"raw":{"language":"json"}}},"url":"https://partners.verloop.com/api/v2/whatsapp/create_number_for_waba","description":"

Once the number is added in the WABA using Meta dashboard, partners can use this API to link the phone number to their verloop app in order to verify and register the number.

System User Token generated from dashboard

\n","type":"text"}],"url":"https://partners.verloop.com/api/v2/whatsapp/get_phone_number?PhoneID=meta-phone-identifier&ClientID=some-client-id","description":"

Get phone number details for a PhoneID.

Meta Phone Identifier

\n","type":"text/plain"},"key":"PhoneID","value":"meta-phone-identifier"},{"description":{"content":"

Client ID that the number belongs to

\n","type":"text/plain"},"key":"ClientID","value":"some-client-id"}],"variable":[]}},"response":[{"id":"f8bd7f30-73cd-45a9-be44-bb1fe04f60b2","name":"Get Phone Details","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"System User Token generated from dashboard","type":"text"}],"url":{"raw":"https://partners.verloop.com/api/v2/whatsapp/get_phone_number?PhoneID=meta-phone-identifier&ClientID=some-client-id","host":["https://partners.verloop.com/api/v2"],"path":["whatsapp","get_phone_number"],"query":[{"key":"PhoneID","value":"meta-phone-identifier","description":"Meta Phone Identifier"},{"key":"ClientID","value":"some-client-id","description":"Client ID that the number belongs to"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"WabaPhoneNumberDetails\": {\n \"VerifiedName\": \"Test Number\",\n \"NumberVerificationStatus\": 2,\n \"DisplayPhoneNumber\": \"+1555-XXX-XXXX\",\n \"PhoneID\": \"12345678910\",\n \"NumberStatus\": 8,\n \"MessagingLimitTier\": 3,\n \"IsPinEnabled\": true,\n \"NameStatus\": 1\n }\n}"}],"_postman_id":"fa321603-c230-4221-8aea-8f25bf8742f0"},{"name":"Delete Phone Number","event":[{"listen":"test","script":{"id":"c87b265f-0c08-4119-ae39-1deca7b89fea","exec":[""],"type":"text/javascript"}}],"id":"af0b08e7-24fd-4cb5-9a08-4eb053b3c432","request":{"method":"DELETE","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"

System User Token generated from dashboard

\n","type":"text"}],"url":"https://partners.verloop.com/api/v2/whatsapp/delete_phone_number?phone_id=meta-phone-identifier&client_id=some-client-id","description":"

Delete phone number details for a PhoneID. Note: This only deletes the number from Verloop's DB. To delete the number from Meta, you'll need to go to Meta dashboard and manually delete it.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","name":"Verloop Partner - API documentation","type":"collection"}},"urlObject":{"path":["whatsapp","delete_phone_number"],"host":["https://partners.verloop.com/api/v2"],"query":[{"key":"phone_id","value":"meta-phone-identifier"},{"key":"client_id","value":"some-client-id"}],"variable":[]}},"response":[{"id":"855e60cb-80f5-4564-8cd9-b540db587048","name":"Delete Phone Number","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"System User Token generated from dashboard","type":"text"}],"url":{"raw":"https://partners.verloop.com/api/v2/whatsapp/delete_phone_number?phone_id=meta-phone-identifier&client_id=some-client-id","host":["https://partners.verloop.com/api/v2"],"path":["whatsapp","delete_phone_number"],"query":[{"key":"phone_id","value":"meta-phone-identifier","description":"Meta Phone Identifier"},{"key":"client_id","value":"some-client-id","description":"Client ID that the number belongs to"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true\n}"}],"_postman_id":"af0b08e7-24fd-4cb5-9a08-4eb053b3c432"},{"name":"Get Waba Business Account","event":[{"listen":"test","script":{"id":"c87b265f-0c08-4119-ae39-1deca7b89fea","exec":[""],"type":"text/javascript"}}],"id":"43c74729-5ff6-4d8b-a704-4227ef56d79b","request":{"method":"GET","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"

System User Token generated from dashboard

\n","type":"text"}],"url":"https://partners.verloop.com/api/v2/whatsapp/get_waba_business_account?ClientID=some-client-id","description":"

Get WABA details for the WABAID linked to the client Account.

Client ID

\n","type":"text/plain"},"key":"ClientID","value":"some-client-id"}],"variable":[]}},"response":[{"id":"d11dfb7a-ae1b-43a6-afed-4cf1adceb842","name":"Get Waba Business Account","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"System User Token generated from dashboard","type":"text"}],"url":{"raw":"https://partners.verloop.com/api/v2/whatsapp/get_waba_business_account?ClientID=some-client-id","host":["https://partners.verloop.com/api/v2"],"path":["whatsapp","get_waba_business_account"],"query":[{"key":"ClientID","value":"some-client-id","description":"Client ID"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"WabaID\": \"102828102583215\",\n \"BusinessAccountName\": \"Test WhatsApp Business Account\",\n \"AccountStatus\": \"APPROVED\",\n \"OnBehalfOfBusinessInfo\": {\n \"Name\": \"Verloop\",\n \"BusinessId\": \"647311512300466\",\n \"Status\": \"APPROVED\"\n },\n \"TimeZoneID\": \"America/Los_Angeles\"\n}"}],"_postman_id":"43c74729-5ff6-4d8b-a704-4227ef56d79b"},{"name":"Request OTP for Phone Verification","event":[{"listen":"test","script":{"id":"c87b265f-0c08-4119-ae39-1deca7b89fea","exec":[""],"type":"text/javascript"}}],"id":"f3546239-af92-4092-97b4-890130524f8e","request":{"method":"POST","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"

System User Token generated from dashboard

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"PhoneID\": meta-phone-identifier, // Unique Identifier for a Phone number\n \"PhoneNumber\": {{PhoneNumber}}, // Phone number to be linked without + sign. E.g. 91XXXXXXXXXX\n \"Method\": {{Method}}, // OTP request method. Possible values: \"SMS\", \"VOICE\"\n \"ClientID\": some-client-id // Client ID that the number belongs to\n}","options":{"raw":{"language":"json"}}},"url":"https://partners.verloop.com/api/v2/whatsapp/request_otp","description":"

Once the number is added to partner's client, partner can preoceed with phone number verification. Here's how to request an OTP for phone number verification.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","name":"Verloop Partner - API documentation","type":"collection"}},"urlObject":{"path":["whatsapp","request_otp"],"host":["https://partners.verloop.com/api/v2"],"query":[],"variable":[]}},"response":[{"id":"1126b543-e234-465f-9f7c-554afcc87bf3","name":"Request OTP for Phone Verification","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"System User Token generated from dashboard","type":"text"}],"body":{"mode":"raw","raw":"{\n \"PhoneID\": meta-phone-identifier, // Unique Identifier for a Phone number\n \"PhoneNumber\": {{PhoneNumber}}, // Phone number to be linked without + sign. E.g. 91XXXXXXXXXX\n \"Method\": {{Method}}, // OTP request method. Possible values: \"SMS\", \"VOICE\"\n \"ClientID\": some-client-id // Client ID that the number belongs to\n}","options":{"raw":{"language":"json"}}},"url":"https://partners.verloop.com/api/v2/whatsapp/request_otp"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true\n}"}],"_postman_id":"f3546239-af92-4092-97b4-890130524f8e"},{"name":"Verify OTP for Phone Verification","event":[{"listen":"test","script":{"id":"c87b265f-0c08-4119-ae39-1deca7b89fea","exec":[""],"type":"text/javascript"}}],"id":"a43fdb96-a3b4-4abe-b073-503572cb3929","request":{"method":"POST","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"

System User Token generated from dashboard

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"PhoneID\": meta-phone-identifier, // Unique Identifier for a Phone number\n \"PhoneNumber\": {{PhoneNumber}}, // Phone number to be linked without + sign. E.g. 91XXXXXXXXXX\n \"Code\": {{Method}}, // OTP received via SMS or Call\n \"ClientID\": some-client-id // Client ID that the number belongs to\n}","options":{"raw":{"language":"json"}}},"url":"https://partners.verloop.com/api/v2/whatsapp/verify_otp","description":"

Verify OTP request

\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","name":"Verloop Partner - API documentation","type":"collection"}},"urlObject":{"path":["whatsapp","verify_otp"],"host":["https://partners.verloop.com/api/v2"],"query":[],"variable":[]}},"response":[{"id":"312eaa79-407c-4be7-b02a-8021dd4ae345","name":"Verify OTP for Phone Verification","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"System User Token generated from dashboard","type":"text"}],"body":{"mode":"raw","raw":"{\n \"PhoneID\": meta-phone-identifier, // Unique Identifier for a Phone number\n \"PhoneNumber\": {{PhoneNumber}}, // Phone number to be linked without + sign. E.g. 91XXXXXXXXXX\n \"Code\": {{Method}}, // OTP received via SMS or Call\n \"ClientID\": some-client-id // Client ID that the number belongs to\n}","options":{"raw":{"language":"json"}}},"url":"https://partners.verloop.com/api/v2/whatsapp/verify_otp"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true\n}"}],"_postman_id":"a43fdb96-a3b4-4abe-b073-503572cb3929"},{"name":"Register Phone Number","event":[{"listen":"test","script":{"id":"c87b265f-0c08-4119-ae39-1deca7b89fea","exec":[""],"type":"text/javascript"}}],"id":"7d052acd-1a94-4442-a70a-2d676a46e62b","request":{"method":"POST","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"

System User Token generated from dashboard

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"PhoneID\": meta-phone-identifier, // Unique Identifier for a Phone number\n \"PhoneNumber\": {{PhoneNumber}}, // Phone number to be linked without + sign. E.g. 91XXXXXXXXXX\n \"ClientID\": some-client-id // Client ID that the number belongs to\n}","options":{"raw":{"language":"json"}}},"url":"https://partners.verloop.com/api/v2/whatsapp/register_number","description":"

In order to make a phone number usable after successful verification, we need to register it. Not just that, after any change in the phone number, it needs to be registered. These changes include:

Display name change

System User Token generated from dashboard

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"PhoneNumber\": {{PhoneNumber}}, // Phone number to be linked without + sign. E.g. 91XXXXXXXXXX\n \"ClientID\": some-client-id, // Client ID that the number belongs to\n \"SourceWabaID\": 0000000000000000, // Waba ID of the account the number currently belongs to\n \"DestinationWabaID\": 0000000000000000, // Waba ID of the account the number needs to be ported to\n \"CountryCode\": {{countryCode}} // Numerical country code of the number\n}","options":{"raw":{"language":"json"}}},"url":"https://partners.verloop.com/api/v2/whatsapp/migrate_number","description":"

Migrate Number endpoint can be used to move a phone number from one WABA to another

\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","name":"Verloop Partner - API documentation","type":"collection"}},"urlObject":{"path":["whatsapp","migrate_number"],"host":["https://partners.verloop.com/api/v2"],"query":[],"variable":[]}},"response":[{"id":"839ef7e2-d4f2-43e5-a781-a4c56cc8cafd","name":"Migrate Phone Number","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"System User Token generated from dashboard","type":"text"}],"body":{"mode":"raw","raw":"{\n \"PhoneNumber\": {{PhoneNumber}}, // Phone number to be linked without + sign. E.g. 91XXXXXXXXXX\n \"ClientID\": some-client-id, // Client ID that the number belongs to\n \"SourceWabaID\": 0000000000000000, // Waba ID of the account the number currently belongs to\n \"DestinationWabaID\": 0000000000000000, // Waba ID of the account the number needs to be ported to\n \"CountryCode\": {{countryCode}} // Numerical country code of the number\n}","options":{"raw":{"language":"json"}}},"url":"https://partners.verloop.com/api/v2/whatsapp/migrate_number"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true\n}"}],"_postman_id":"08223317-b53d-41f2-9ea8-234650174930"},{"name":"Set Cart for Phone number","event":[{"listen":"test","script":{"id":"c87b265f-0c08-4119-ae39-1deca7b89fea","exec":[""],"type":"text/javascript"}}],"id":"908a1c4a-8e09-4a94-adda-4034caf8a02d","request":{"method":"POST","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"

System User Token generated from dashboard

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"PhoneID\": meta-phone-identifier, // Unique Identifier for a Phone number\n \"IsEnabled\": false, // Bool flag for Cart enabled\n \"ClientID\": some-client-id // Client ID that the number belongs to\n}","options":{"raw":{"language":"json"}}},"url":"https://partners.verloop.com/api/v2/whatsapp/set_cart","description":"

Set Cart enabled/diabled for a Phone number

System User Token generated from dashboard

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"PhoneID\": meta-phone-identifier, // Unique Identifier for a Phone number\n \"IsEnabled\": true, // Bool flag for Catalog enabled\n \"ClientID\": some-client-id // Client ID that the number belongs to\n}","options":{"raw":{"language":"json"}}},"url":"https://partners.verloop.com/api/v2/whatsapp/set_catalog","description":"

Set Catalog enabled/diabled for a Phone number

These APIs can be used by the partners to manage clients. System auth token is needed to authorize these endpoints.

\n","_postman_id":"cf3d96d5-ae4a-496e-a33f-7956b665fba5","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","name":"Verloop Partner - API documentation","type":"collection"}}},{"name":"Messaging APIs","item":[{"name":"Send Message","event":[{"listen":"test","script":{"id":"c87b265f-0c08-4119-ae39-1deca7b89fea","exec":[""],"type":"text/javascript"}}],"id":"5c97621d-71e6-4f28-98e9-955a8acc73ed","request":{"method":"POST","header":[{"key":"Authorization","value":"generate-token-from-dashboard","description":"

System User Token generated from dashboard

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"messages\": [ // array of meesage objects. To learn more about message objects visit https://developers.facebook.com/docs/whatsapp/cloud-api/guides/send-messages\n {\n \"messaging_product\": \"whatsapp\", // Allowed value: \"whatsapp\"\n \"recipient_type\": \"individual\", // Allowed values: \"individual\"\n \"to\": 318-521-5324, // Phone number to send message to\n \"type\": \"\" // Allowed values: \"text\", \"image\", \"document\", \"audio\", \"video\", \"location\", \"sticker\", \"contacts\", \"template\", \"interactive\", \"reaction\". \n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://partners.verloop.com/api/v2/whatsapp/send_message","description":"

Send messages using Verloop WhatsApp Business API

These endpoints are used to send messages using a Client's registered Phone Number.

Authorization header need to have a Phone Number Access Token.

Messaging APIs use the message structure as defined by Meta. To know more about message object, visit https://developers.facebook.com/docs/whatsapp/cloud-api/guides/send-messages

\n","_postman_id":"0b5152f8-ed50-4e0d-9156-6785790e4d22","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","name":"Verloop Partner - API documentation","type":"collection"}}},{"name":"Webhooks","item":[{"name":"Messaging/Template Webhooks","item":[{"name":"New Request","id":"bbbddc86-d951-4180-813b-ecea032175a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","name":"Verloop Partner - API documentation","type":"collection"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"bbbddc86-d951-4180-813b-ecea032175a5"}],"id":"e61a8670-f374-430d-807f-c028f48877f6","description":"

You can receive messaging webhooks on the Callback URL specified in the settings page on partners app dashboard.

\n\n

Once a message is sent to Meta, partner can receive webhook events to get status updates on the messages. Please refer to Meta's webhook payload docs for details on payload fields.

Validating Payloads

We sign all webhook payloads with a SHA256 signature and include the signature in the request's X-Partner-Signature-256 header, preceded with sha256=. You don't have to validate the payload, but you should.

To validate the payload:

Generate a SHA256 signature using the payload and your latest SystemUserToken.
Compare your signature to the signature in the X-Partner-Signature-256 header (everything after sha256=). If the signatures match, the payload is genuine.

Webhook Examples

Example Incoming Message Webhook event

{\n  \"object\": \"whatsapp_business_account\",\n  \"entry\": [{\n      \"id\": \"WHATSAPP_BUSINESS_ACCOUNT_ID\",\n      \"changes\": [{\n          \"value\": {\n              \"messaging_product\": \"whatsapp\",\n              \"metadata\": {\n                  \"display_phone_number\": PHONE_NUMBER,\n                  \"phone_number_id\": PHONE_NUMBER_ID\n              },\n              \"contacts\": [{\n                  \"profile\": {\n                    \"name\": \"NAME\"\n                  },\n                  \"wa_id\": PHONE_NUMBER\n                }],\n              \"messages\": [{\n                  \"from\": PHONE_NUMBER,\n                  \"id\": \"wamid.ID\",\n                  \"timestamp\": TIMESTAMP,\n                  \"text\": {\n                    \"body\": \"MESSAGE_BODY\"\n                  },\n                  \"type\": \"text\"\n                }]\n          },\n          \"field\": \"messages\"\n        }]\n  }]\n}\n\n

Example Message Status Webhook event

{\n  \"object\": \"whatsapp_business_account\",\n  \"entry\": [\n    {\n      \"id\": \"WHATSAPP_BUSINESS_ACCOUNT_ID\",\n      \"changes\": [\n        {\n          \"value\": {\n            \"messaging_product\": \"whatsapp\",\n            \"metadata\": {\n              \"display_phone_number\": \"BUSINESS_DISPLAY_PHONE_NUMBER\",\n              \"phone_number_id\": \"BUSINESS_PHONE_NUMBER_ID\"\n            },\n            \"statuses\": [\n              {\n                \"id\": \"WHATSAPP_MESSAGE_ID\",\n                \"status\": \"sent\",\n                \"timestamp\": \"TIMESTAMP\",\n                \"recipient_id\": \"CUSTOMER_PHONE_NUMBER\",\n                \"conversation\": {\n                  \"id\": \"CONVERSATION_ID\",\n                  \"expiration_timestamp\": \"CONVERSATION_EXPIRATION_TIMESTAMP\",\n                  \"origin\": {\n                    \"type\": \"user_initiated\"\n                  }\n                },\n                \"pricing\": {\n                  \"billable\": true,\n                  \"pricing_model\": \"CBP\",\n                  \"category\": \"service\"\n                }\n              }\n            ]\n          },\n          \"field\": \"messages\"\n        }\n      ]\n    }\n  ]\n}\n\n

Template webhook events cover Message Template Status Updates. Please refer to Meta's template webhook docs to get details about payload fields.

Example Template Webhook Event

{\n  \"entry\": [\n    {\n      \"id\": \"<WHATSAPP_BUSINESS_ACCOUNT_ID>\",\n      \"time\": <TIMESTAMP>,\n      \"changes\": [\n        {\n          \"value\": {\n            \"event\": \"APPROVED\",\n            \"message_template_id\": <TEMPLATE_ID>,\n            \"message_template_name\": \"<TEMPLATE_NAME>\",\n            \"message_template_language\": \"<LANGUAGE_AND_LOCALE_CODE>\",\n            \"reason\": \"NONE\"\n          },\n          \"field\": \"message_template_status_update\"\n        }\n      ]\n    }\n  ],\n  \"object\": \"whatsapp_business_account\"\n}\n\n

Message Template Status Update

Status updates on templates.

Template Approved

{\n  \"entry\": [\n    {\n      \"id\": \"<WHATSAPP_BUSINESS_ACCOUNT_ID>\",\n      \"time\": <TIMESTAMP>,\n      \"changes\": [\n        {\n          \"value\": {\n            \"event\": \"APPROVED\",\n            \"message_template_id\": <TEMPLATE_ID>,\n            \"message_template_name\": \"<TEMPLATE_NAME>\",\n            \"message_template_language\": \"<LANGUAGE_AND_LOCALE_CODE>\",\n            \"reason\": \"NONE\"\n          },\n          \"field\": \"message_template_status_update\"\n        }\n      ]\n    }\n  ],\n  \"object\": \"whatsapp_business_account\"\n}\n\n

Template Rejected

{\n  \"object\": \"whatsapp_business_account\"\n  \"entry\": [\n    {\n      \"id\": \"<WHATSAPP_BUSINESS_ACCOUNT_ID>\",\n      \"time\": <TIMESTAMP>,\n      \"changes\": [\n        {\n          \"value\": {\n            \"event\": \"REJECTED\",\n            \"message_template_id\": <TEMPLATE_ID>,\n            \"message_template_name\": \"<TEMPLATE_NAME>\",\n            \"message_template_language\": \"<LANGUAGE_AND_LOCALE_CODE>\",\n            \"reason\": \"<REJECTION_REASON>\"\n          },\n          \"field\": \"message_template_status_update\"\n        }\n      ]\n    }\n  ]\n}\n\n

Template Scheduled for Disabling

{\n  \"object\": \"whatsapp_business_account\",\n  \"entry\": [\n    {\n      \"id\": \"WHATSAPP-BUSINESS-ACCOUNT-ID\",\n      \"time\": TIMESTAMP,\n      \"changes\": [\n        {\n          \"field\": \"message_template_status_update\",\n          \"value\": { \n              \"event\": \"FLAGGED\",\n              \"message_template_id\": TEMPLATE-ID, \n              \"message_template_name\": \"My message template\",\n              \"message_template_language\": \"en-US\",\n              \"reason\": null,\n              \"disable_info\": {\n                  \"disable_date\": \"DATE\",\n              }\n         }\n       }\n      ]\n    }\n  ]\n}\n\n

","_postman_id":"e61a8670-f374-430d-807f-c028f48877f6","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","name":"Verloop Partner - API documentation","type":"collection"}}}],"id":"aa03b1e9-a0a4-4bdb-a0fe-4a88b51f7405","_postman_id":"aa03b1e9-a0a4-4bdb-a0fe-4a88b51f7405","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","id":"abec4ce3-46fb-42a5-a8b5-9f1eb7f25ca6","name":"Verloop Partner - API documentation","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[]}},"event":[{"listen":"prerequest","script":{"id":"23f61752-e5c0-4f8a-a2dd-423bddd2bf02","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"a634f58b-b6a4-45e5-8410-8ba43c441c4d","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://partners.verloop.com/api/v2"},{"key":"systemUserToken","value":"generate-token-from-dashboard"},{"key":"SomePhoneID","value":"meta-phone-identifier"},{"key":"ClientID","value":"some-client-id"},{"key":"wabaID","value":"0000000000000000"},{"key":"WabaID","value":"000000000000000"}]}