{
"opencollection": "1.0.0",
"info": {
"name": "Infobip OpenAPI Specification",
"version": "3.210.0"
},
"items": [
{
"info": {
"name": "channels",
"type": "folder"
},
"items": [
{
"info": {
"name": "Send WhatsApp template message",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/message/template",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Send a single or multiple template messages to one or more recipients. Template messages can be sent and delivered at anytime. Each template needs to be registered and pre-approved by WhatsApp.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead."
},
{
"info": {
"name": "Send WhatsApp text message",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/message/text",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Send a text message to a single recipient. Text messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead."
},
{
"info": {
"name": "Send WhatsApp document message",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/message/document",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Send a document to a single recipient. Document messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead."
},
{
"info": {
"name": "Send WhatsApp image message",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/message/image",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Send an image to a single recipient. Image messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead."
},
{
"info": {
"name": "Send WhatsApp audio message",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/message/audio",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Send an audio to a single recipient. Audio messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead."
},
{
"info": {
"name": "Send WhatsApp video message",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/message/video",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Send a video to a single recipient. Video messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead."
},
{
"info": {
"name": "Send WhatsApp sticker message",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/message/sticker",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Send a sticker to a single recipient. Sticker messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead."
},
{
"info": {
"name": "Send WhatsApp location message",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/message/location",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Send a location to a single recipient. Location messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead."
},
{
"info": {
"name": "Send WhatsApp contact message",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/message/contact",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Send a contact to a single recipient. Contact messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead."
},
{
"info": {
"name": "Send WhatsApp interactive buttons message",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/message/interactive/buttons",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Send an interactive buttons message to a single recipient. Interactive buttons messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead."
},
{
"info": {
"name": "Send WhatsApp interactive list message",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/message/interactive/list",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Send an interactive list message to a single recipient. Interactive list messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead."
},
{
"info": {
"name": "Send WhatsApp interactive media carousel message",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/message/interactive/media-carousel",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Send an interactive media carousel message to a single recipient. Interactive media carousel messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead."
},
{
"info": {
"name": "Send WhatsApp interactive location request message",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/message/interactive/location-request",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Send an interactive location request message to a single recipient. Interactive location request messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead."
},
{
"info": {
"name": "Send WhatsApp interactive product message",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/message/interactive/product",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Send an interactive product message to a single recipient. Interactive product messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead."
},
{
"info": {
"name": "Send WhatsApp interactive multi-product message",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/message/interactive/multi-product",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Send an interactive multi-product message to a single recipient. Interactive multi-product messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead."
},
{
"info": {
"name": "Send WhatsApp interactive order-details message",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/message/interactive/order-details",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Send an interactive order-details message to a single recipient.
An order-details message is a structured message containing essential information about the customer's selected products. Alternatively, a [single](#channels/whatsapp/send-whatsapp-interactive-product-message) or [multi-product](#channels/whatsapp/send-whatsapp-interactive-multi-product-message) interactive message can serve this purpose.
Interactive order-details messages can only be successfully delivered if the recip"
},
{
"info": {
"name": "Send WhatsApp interactive order-status message",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/message/interactive/order-status",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Send an interactive order-status message to a single recipient.
An order-status message delivers real-time updates to customers about the current status of their order.
Interactive order-status messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Rep"
},
{
"info": {
"name": "Send WhatsApp interactive flow message",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/message/interactive/flow",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Send an interactive flow message to a single recipient. Interactive flow messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead."
},
{
"info": {
"name": "Send WhatsApp interactive url button message",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/message/interactive/url-button",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Send an interactive url button message to a single recipient."
},
{
"info": {
"name": "Send WhatsApp interactive call permission request message",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/message/interactive/call-permission-request",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Send an interactive call permission request message to a single recipient. Interactive call permission request messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead."
},
{
"info": {
"name": "Send WhatsApp interactive voice button message",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/message/interactive/voice-button",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Send an interactive voice button message to a single recipient. Interactive voice button messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead."
},
{
"info": {
"name": "Send WhatsApp interactive in-thread authentication request message",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/message/interactive/in-thread-authentication-request",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Send an interactive in-thread authentication request message to a single recipient. Interactive in-thread authentication request messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead."
},
{
"info": {
"name": "Send WhatsApp interactive request contact info message",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/message/interactive/request-contact-info",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Send an interactive request contact info message to a single recipient. Interactive request contact info messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used.
The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead."
},
{
"info": {
"name": "Send WhatsApp events",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/events",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Send WhatsApp events to multiple recipients."
},
{
"info": {
"name": "Download inbound media",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/media/:mediaId",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
},
{
"name": "mediaId",
"value": "20250_13_123e4567-e89b-12d3-a456-426655440000",
"type": "path",
"description": "ID of the media."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Download WhatsApp media sent by end-users."
},
{
"info": {
"name": "Get media metadata",
"type": "http"
},
"http": {
"method": "HEAD",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/media/:mediaId",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
},
{
"name": "mediaId",
"value": "20250_13_123e4567-e89b-12d3-a456-426655440000",
"type": "path",
"description": "ID of the media."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Get metadata of WhatsApp media sent by end-users to check media type and the size of a file without downloading the content."
},
{
"info": {
"name": "Mark as read",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/message/:messageId/read",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
},
{
"name": "messageId",
"value": "abcdef_ghij124567890klmnopr",
"type": "path",
"description": "ID of the message to be marked as read."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Mark WhatsApp messages sent by end-users as read."
},
{
"info": {
"name": "Get India UPI PayU payment status",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/payments/upi/payu/:paymentId",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
},
{
"name": "paymentId",
"value": "16085194825",
"type": "path",
"description": "Unique identifier of the payment."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Get India UPI PayU payment and transaction status."
},
{
"info": {
"name": "Get Brazil payment status",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/payments/br/:paymentId",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
},
{
"name": "paymentId",
"value": "16085194825",
"type": "path",
"description": "Unique identifier of the payment."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Get Brazil payment and transaction status."
},
{
"info": {
"name": "Get India UPI PayU/Razorpay payment status",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/payments/upi/:paymentId",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
},
{
"name": "paymentId",
"value": "16085194825",
"type": "path",
"description": "Unique identifier of the payment."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Get India UPI PayU/Razor payment and transaction status."
},
{
"info": {
"name": "Get WhatsApp Templates",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/whatsapp/2/senders/:sender/templates",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Get all the templates and their statuses for a given sender."
},
{
"info": {
"name": "Create WhatsApp Template",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/2/senders/:sender/templates",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Create a WhatsApp template. Once created, Infobip submits a template for WhatsApp's review and approval. When approved, a template can be sent to end users. Refer to [template guidelines](https://www.infobip.com/docs/whatsapp/remaining-compliant#message-templates) for additional info."
},
{
"info": {
"name": "Delete WhatsApp Template",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/whatsapp/2/senders/:sender/templates/:templateName",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
},
{
"name": "templateName",
"value": "template_name",
"type": "path",
"description": "Template name. Must only contain lowercase alphanumeric characters and underscores."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Delete a WhatsApp template.\n* If registered in multiple languages, deleting the message template will also delete all its languages.\n* The template will be deleted for all senders registered under the same WhatsApp Business Account (WABA).\n* The system will attempt to deliver sent messages for 30 days, regardless of the template deletion.\n* Once deleted, the name of the approved template cannot be reused for 30 days."
},
{
"info": {
"name": "Get WhatsApp Template",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/whatsapp/2/senders/:sender/templates/:id",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
},
{
"name": "id",
"value": "5653923468715475",
"type": "path",
"description": "Template ID. Must be a number."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Get a single template with its status for a given template ID."
},
{
"info": {
"name": "Edit WhatsApp Template",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/whatsapp/2/senders/:sender/templates/:id",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
},
{
"name": "id",
"value": "5653923468715475",
"type": "path",
"description": "Template ID. Must be a number."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Edit a WhatsApp template. Once edited, Infobip submits a template for WhatsApp's review and approval. When approved, a template can be sent to end users. Refer to [template guidelines](https://www.infobip.com/docs/whatsapp/remaining-compliant#message-templates) for additional info.\n* Only templates with an approved, rejected, or paused status can be edited.\n* Use the structure provided in the [Create WhatsApp Template](#channels/whatsapp/whatsapp-service-management/create-whatsapp-template) endp"
},
{
"info": {
"name": "Get WhatsApp Templates",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/templates",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Get all the templates and their statuses for a given sender. This version is deprecated as of June 29th 2022, meaning no fixes/updates will be provided and no new parameters will be added. This API will be deleted at the end of the year. Please use the [latest version](#channels/whatsapp/get-whatsapp-templates)."
},
{
"info": {
"name": "Create WhatsApp Template",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/templates",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Create a WhatsApp template. Created template will be submitted for WhatsApp's review and approval. Once approved, template can be sent to end-users. Refer to [template guidelines](https://www.infobip.com/docs/whatsapp/message-types#guidelines-amp-best-practices) for additional info. This version is deprecated as of June 29th 2022, meaning no fixes/updates will be provided and no new parameters will be added. This API will be deleted at the end of the year. Please use the [latest version](#channe"
},
{
"info": {
"name": "Get account WhatsApp templates",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/whatsapp/1/templates",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "query",
"description": "List of registered WhatsApp senders numbers separated by comma. Must be in international format."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "List of template statuses, separated by commas."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Template name."
},
{
"name": "language",
"value": "en,en_US",
"type": "query",
"description": "List of languages for the templates, separated by commas."
},
{
"name": "category",
"value": "",
"type": "query",
"description": "List of template categories, separated by commas."
},
{
"name": "applicationId",
"value": "",
"type": "query",
"description": "Application ID used in outbound send requests. It is also returned in notification events. For more details, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)."
},
{
"name": "entityId",
"value": "",
"type": "query",
"description": "Entity ID used in outbound send requests. It is also returned in notification events. For more details, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Current page number."
},
{
"name": "size",
"value": "",
"type": "query",
"description": "Number of items per page."
},
{
"name": "orderBy",
"value": "name,ASC",
"type": "query",
"description": "Sorting criteria in the format property,direction. Can be ascending (ASC) or descending (DESC). Available properties: category, language, name, status, templateId"
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Retrieve all templates associated with your account based on the provided filter criteria."
},
{
"info": {
"name": "Get WhatsApp Flows",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/flows",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Get all the flows for a given sender."
},
{
"info": {
"name": "Create WhatsApp Flow",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/flows",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Create a WhatsApp flow. If successful, flow will be created in DRAFT status with default flow.json. Flow.json contains structure of the flow and other fields given in request can be updated until publication."
},
{
"info": {
"name": "Update WhatsApp Flow",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/flows/:flowId",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
},
{
"name": "flowId",
"value": "123456",
"type": "path",
"description": "ID of the flow to be modified."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Update a WhatsApp flow. Only flows in DRAFT status can be modified."
},
{
"info": {
"name": "Delete WhatsApp Flow",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/flows/:flowId",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
},
{
"name": "flowId",
"value": "123456",
"type": "path",
"description": "ID of the flow to be deleted."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Delete a WhatsApp flow. Only flows in DRAFT status can be deleted."
},
{
"info": {
"name": "Publish WhatsApp Flow",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/flows/:flowId/publish",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
},
{
"name": "flowId",
"value": "123456",
"type": "path",
"description": "ID of the flow to be published."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Publish a WhatsApp flow. If successful, the flow will change its status to PUBLISHED. From now on the flow cannot be modified."
},
{
"info": {
"name": "Get WhatsApp Flow JSON",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/flows/:flowId/json",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
},
{
"name": "flowId",
"value": "123456",
"type": "path",
"description": "ID of the flow the JSON is attached to."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Get the Flow JSON attached to a specified flow."
},
{
"info": {
"name": "Add WhatsApp Flow JSON",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/flows/:flowId/json",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
},
{
"name": "flowId",
"value": "123456",
"type": "path",
"description": "ID of the flow to attach JSON to."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Add WhatsApp Flow JSON. File created from provided JSON content is sent and validated, errors found are provided in response. Regardless of whether any validation errors are returned, the Flow JSON is loaded on the Meta side and the request is considered successful. The maximum size of created file is 10MB. More information about JSON structure can be found under Meta documentation: https://developers.facebook.com/docs/whatsapp/flows/reference/flowjson."
},
{
"info": {
"name": "Deprecate WhatsApp Flow",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/flows/:flowId/deprecate",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
},
{
"name": "flowId",
"value": "123456",
"type": "path",
"description": "ID of the flow to be deprecated."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Deprecate a WhatsApp flow. If successful, flow will change its status to DEPRECATED. From now on flow cannot be sent anymore."
},
{
"info": {
"name": "Get WhatsApp Flow's preview",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/flows/:flowId/preview",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
},
{
"name": "flowId",
"value": "123456",
"type": "path",
"description": "ID of the flow for which the preview URL will be generated."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Get flow's preview URL. Link does not require login and will expire in 30 days."
},
{
"info": {
"name": "Generate WhatsApp Flow",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/flows/generate",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Use this endpoint to automatically generate a WhatsApp Flow definition using AI, based on a natural language prompt. Provide a descriptive prompt (e.g., \"Create a Static WhatsApp Flow to collect details like Name, Surname and email for our global event next week.\"). The AI will generate a flow configuration designed to match your intent. If you include a responseId from an earlier request, the prompt will be used to modify or refine the flow that was previously generated, so you can adjust and "
},
{
"info": {
"name": "Delete media",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/media",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Delete WhatsApp media. May be outbound or inbound media."
},
{
"info": {
"name": "Get quality information of WhatsApp senders",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/whatsapp/1/senders/quality",
"params": [
{
"name": "senders",
"value": "447796344125,447796344126",
"type": "query",
"description": "List of comma-separated WhatsApp sender numbers."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Get WhatsApp sender information, such as quality rating, status, and current limit of given senders. Only senders associated with your account are included in the response."
},
{
"info": {
"name": "Get business info of WhatsApp sender",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/business-info",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Get WhatsApp sender business information, such as about, address, description, email, vertical, websites, and display name."
},
{
"info": {
"name": "Update business info of WhatsApp sender",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/business-info",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Update WhatsApp sender business information, such as about, address, description, email, vertical, websites, and logo."
},
{
"info": {
"name": "Download business logo of WhatsApp sender",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/business-info/logo",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Download WhatsApp sender business logo."
},
{
"info": {
"name": "Get calling permission",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/calls/:userNumber/permissions",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
},
{
"name": "userNumber",
"value": "447796344125",
"type": "path",
"description": "End user phone number. Must be in international format."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Get calling permission info of WhatsApp sender for specified end user number, including status, allowed actions, and limitations."
},
{
"info": {
"name": "Get WhatsApp sender public key",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/public-key",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Retrieves the public key for WhatsApp encryption. The public key enables\n end-to-end encrypted data exchange with WhatsApp, such as in WhatsApp Flows."
},
{
"info": {
"name": "Upload WhatsApp sender public key",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/senders/:sender/public-key",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
}
],
"body": {
"type": "multipart-form",
"data": []
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Uploads a public key for WhatsApp encryption. The public key enables\n end-to-end encrypted data exchange with WhatsApp, such as in WhatsApp Flows.\n Previous keys are replaced when new ones are uploaded using this endpoint."
},
{
"info": {
"name": "Add WhatsApp sender",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/embedded-signup/registrations/business-account/:businessAccountId/senders",
"params": [
{
"name": "businessAccountId",
"value": "12345567897878",
"type": "path",
"description": "WhatsApp Business Account Id."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Add a WhatsApp sender to your WhatsApp Business Account and initiate the verification process. If the sender is recognized as already verified, it will be automatically submitted for registration."
},
{
"info": {
"name": "Verify WhatsApp sender",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/embedded-signup/registrations/senders/:sender/verification",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "WhatsApp sender number. Must be in international format."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Verify your WhatsApp sender and submit it for registration."
},
{
"info": {
"name": "Retry WhatsApp sender verification",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/whatsapp/1/embedded-signup/registrations/senders/:sender/verification",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "WhatsApp sender number. Must be in international format."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Retry the WhatsApp sender verification process in the event of a non-delivered verification code."
},
{
"info": {
"name": "Get identity",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/whatsapp/1/:sender/contacts/:userNumber/identity",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
},
{
"name": "userNumber",
"value": "441134960001",
"type": "path",
"description": "End user's number. Must be in international format."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Get end user's identity info. Feature is not enabled by default."
},
{
"info": {
"name": "Confirm identity",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/whatsapp/1/:sender/contacts/:userNumber/identity",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
},
{
"name": "userNumber",
"value": "441134960001",
"type": "path",
"description": "End user's number. Must be in international format."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Confirm end user's identity. Feature is not enabled by default."
},
{
"info": {
"name": "Delete identity",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/whatsapp/1/:sender/contacts/:userNumber/identity",
"params": [
{
"name": "sender",
"value": "447796344125",
"type": "path",
"description": "Registered WhatsApp sender number. Must be in international format."
},
{
"name": "userNumber",
"value": "441134960001",
"type": "path",
"description": "End user's number. Must be in international format."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Delete end user's identity. Feature is not enabled by default."
},
{
"info": {
"name": "Submit conversions",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/conversions",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Submit WhatsApp conversion events. Events are indivisible, either all are submitted or none."
},
{
"info": {
"name": "Submit WABA conversions",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/whatsapp/1/conversions/waba",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Submit WhatsApp conversion events using your WhatsApp Business Account (WABA) phone number as the source. Each conversion event is linked to an ad click via ctwaClickId — a unique identifier contained within the inbound WhatsApp message originating from the ad. You can optionally include conversion details such as value and currency, and a conversion timestamp (up to 7 days in the past). Events are submitted in batches of up to 1,000 and are indivisible — either all are submitted or none."
}
]
}
],
"bundled": true
}