{ "info": { "_postman_id": "fed285cb-cbd0-4051-8f2f-d8197ee82dca", "name": "Business Messaging API", "description": "This API is for sending messages in Messaging Apps like WhatsApp, Viber, RCS and Line. It also provides the ability to manage templates and export logs.\n\nContact Support:\n Name: 8x8 Inc\n Email: cpaas-support@8x8.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T00:28:15.000Z", "updatedAt": "2026-07-28T00:28:17.000Z", "lastUpdatedBy": "35240", "uid": "35240-fed285cb-cbd0-4051-8f2f-d8197ee82dca" }, "item": [ { "name": "api", "item": [ { "name": "v1", "item": [ { "name": "subaccounts", "item": [ { "name": "{subAccountId}", "item": [ { "name": "messages", "item": [ { "name": "batch", "item": [ { "name": "{batchId}", "item": [ { "name": "Cancel batch of scheduled message", "id": "cbd70f98-2430-4056-b745-8b94fa1f8651", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "batch", ":batchId" ], "variable": [ { "id": "d0742316-3483-4a4d-b9a0-2d58efa2eb68", "key": "subAccountId", "value": "R9NaCkLgHIvQsJybeqo9xUk0Ea&9B5R.oGGhwosoeXqg4", "description": "(Required) You must replace *{subAccountId}* with the subaccountid that you want to use. By default this is generated once you signed up with a new account at [https://connect.8x8.com](https://connect.8x8.com)." }, { "id": "ffc23eaf-d9ce-4ada-99a2-c3aa8c88f692", "key": "batchId", "value": "", "description": "(Required) " } ] }, "description": "- Sending a DELETE request on this this endpoint allows to **cancel a batch of scheduled messages** that has not been sent yet.\n- This method should be used to cancel a batch of scheduled messages sent by previously submitting a POST request to either the \"many\" or \"many compact\" endpoint.\n- To cancel a batch of scheduled messages, use its *batchId* to target it.\n\n### URL\n* In the original POST request used to schedule the batch of messages, you used a specific subaccountid and the API responded with a batchID.\n* You need to use both as path parameters in order to send your DELETE request successfully as shown below:\n`https://chatapps.8x8.com/api/v1/subaccounts/{subAccountId}/messages/batch/{batchId}`\n\n> You must replace `{subAccountId}` and `{batchId}` in the URL above with the subaccountid you used to schedule the messages in the first place and the batchId you got in response." }, "response": [ { "id": "a0308ef9-2a1a-4afc-aa89-cd734f57e569", "name": "New Response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "batch", ":batchId" ], "variable": [ { "key": "subAccountId" }, { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"cancelledCount\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-a0308ef9-2a1a-4afc-aa89-cd734f57e569" }, { "id": "5bdb6d4b-1291-4130-a511-00a9face65e0", "name": "Bad request error response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "batch", ":batchId" ], "variable": [ { "key": "subAccountId" }, { "key": "batchId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-5bdb6d4b-1291-4130-a511-00a9face65e0" }, { "id": "34ece35f-1cbc-471c-a269-91f4a8728811", "name": "Request was not authenticated response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "batch", ":batchId" ], "variable": [ { "key": "subAccountId" }, { "key": "batchId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-34ece35f-1cbc-471c-a269-91f4a8728811" }, { "id": "440f92c6-e3cc-4795-a593-4c3babd10c05", "name": "Internal server error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/batch/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "batch", ":batchId" ], "variable": [ { "key": "subAccountId" }, { "key": "batchId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-440f92c6-e3cc-4795-a593-4c3babd10c05" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-cbd70f98-2430-4056-b745-8b94fa1f8651" } ], "id": "e26473b5-28cd-4ecb-93af-2489d3054e04", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-e26473b5-28cd-4ecb-93af-2489d3054e04" }, { "name": "Send message batch", "id": "4e602f45-dd8f-4eb8-99d1-87fae5a67122", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"messages\": [\n {\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"lineUserId\": \"\",\n \"channelUserId\": \"\"\n },\n \"type\": \"text\",\n \"content\": {\n \"text\": \"\",\n \"whatsApp\": {\n \"directSend\": {\n \"category\": \"utility\",\n \"ttlSeconds\": \"\"\n }\n },\n \"url\": \"\",\n \"fallbackText\": \"\",\n \"sms\": {\n \"encoding\": \"UCS2\",\n \"source\": \"\"\n },\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"interactive\": {\n \"type\": \"voice_call\",\n \"action\": {\n \"button\": \"\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"catalog_id\": \"\",\n \"product_retailer_id\": \"\",\n \"name\": \"\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ],\n \"product_items\": [\n {\n \"product_retailer_id\": \"\"\n }\n ],\n \"title\": \"\"\n }\n ],\n \"parameters\": {\n \"display_text\": \"\",\n \"ttlMinutes\": 10080,\n \"payload\": \"\",\n \"url\": \"\",\n \"flowId\": \"\",\n \"flowCta\": \"\",\n \"flowAction\": \"navigate\",\n \"flowActionPayload\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"doloref\": -5265997.495780766\n }\n }\n }\n },\n \"header\": {\n \"document\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"image\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"text\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"type\": \"video\",\n \"video\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n }\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n }\n },\n \"video\": {\n \"thumbnail\": \"\",\n \"filesize\": \"\",\n \"duration\": \"\"\n },\n \"image\": {\n \"thumbnail\": \"\"\n },\n \"audio\": {\n \"duration\": \"\"\n },\n \"template\": {\n \"name\": \"\",\n \"language\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"ttlMinutes\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"occaecat_0f9\": 22876862,\n \"eiusmod__d7\": \"\",\n \"Ut_3ee\": false,\n \"dolore4\": \"nulla Duis\"\n }\n },\n \"ttlMinutes\": 10080\n }\n ],\n \"index\": 0,\n \"subType\": \"CopyCode\",\n \"cards\": [\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n }\n ]\n }\n ]\n }\n ]\n },\n \"richCard\": {\n \"cardOrientation\": \"vertical\",\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"tall\"\n },\n \"thumbnailImageAlignment\": \"left\",\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"carousel\": {\n \"cardWidth\": \"medium\",\n \"cards\": [\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"tall\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"medium\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n }\n ]\n },\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"channels\": [\n {\n \"channel\": \"Zalo\",\n \"fallbackAfter\": \"\",\n \"successStatus\": \"Read\"\n }\n ],\n \"context\": {\n \"umid\": \"\"\n }\n }\n ],\n \"clientBatchId\": \"\",\n \"template\": {\n \"type\": \"video\",\n \"content\": {\n \"text\": \"\",\n \"whatsApp\": {\n \"directSend\": {\n \"category\": \"utility\",\n \"ttlSeconds\": \"\"\n }\n },\n \"url\": \"\",\n \"fallbackText\": \"\",\n \"sms\": {\n \"encoding\": \"GSM7\",\n \"source\": \"\"\n },\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"interactive\": {\n \"type\": \"voice_call\",\n \"action\": {\n \"button\": \"\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"catalog_id\": \"\",\n \"product_retailer_id\": \"\",\n \"name\": \"\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ],\n \"product_items\": [\n {\n \"product_retailer_id\": \"\"\n }\n ],\n \"title\": \"\"\n }\n ],\n \"parameters\": {\n \"display_text\": \"\",\n \"ttlMinutes\": 10080,\n \"payload\": \"\",\n \"url\": \"\",\n \"flowId\": \"\",\n \"flowCta\": \"\",\n \"flowAction\": \"navigate\",\n \"flowActionPayload\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"anim_a47\": \"in veniam labore\",\n \"eiusmod7\": 75248001\n }\n }\n }\n },\n \"header\": {\n \"document\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"image\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"text\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"type\": \"document\",\n \"video\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n }\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n }\n },\n \"video\": {\n \"thumbnail\": \"\",\n \"filesize\": \"\",\n \"duration\": \"\"\n },\n \"image\": {\n \"thumbnail\": \"\"\n },\n \"audio\": {\n \"duration\": \"\"\n },\n \"template\": {\n \"name\": \"\",\n \"language\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"mollit635\": \"sed minim\",\n \"laboris_fa\": -41471264.30819213\n }\n },\n \"ttlMinutes\": 10080\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\",\n \"cards\": [\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n }\n ]\n }\n ]\n }\n ]\n },\n \"richCard\": {\n \"cardOrientation\": \"horizontal\",\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"short\"\n },\n \"thumbnailImageAlignment\": \"right\",\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"carousel\": {\n \"cardWidth\": \"medium\",\n \"cards\": [\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"medium\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"medium\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n }\n ]\n },\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"dlrCallbackUrl\": \"\"\n },\n \"includeMessagesInResponse\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "batch" ], "variable": [ { "id": "3ba34aef-b5eb-4ee4-8651-64c0a2c08bba", "key": "subAccountId", "value": "R9NaCkLgHIvQsJybeqo9xUk0Ea&9B5R.oGGhwosoeXqg4", "description": "(Required) You must replace *{subAccountId}* with the subaccountid that you want to use. By default this is generated once you signed up with a new account at [https://connect.8x8.com](https://connect.8x8.com)." } ] }, "description": "* This endpoint is used to send Messaging Apps messages by batches (1 request for multiple messages) with personalized contents/properties. \n* It is ideal to send any kind of massive personalized announcement. \n* Using this API, it is possible to send up to 1,000 messages per request." }, "response": [ { "id": "838c26e2-822f-4ce2-99dc-cef9164a3a0e", "name": "Success response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"messages\": [\n {\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"lineUserId\": \"\",\n \"channelUserId\": \"\"\n },\n \"type\": \"text\",\n \"content\": {\n \"text\": \"\",\n \"whatsApp\": {\n \"directSend\": {\n \"category\": \"utility\",\n \"ttlSeconds\": \"\"\n }\n },\n \"url\": \"\",\n \"fallbackText\": \"\",\n \"sms\": {\n \"encoding\": \"UCS2\",\n \"source\": \"\"\n },\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"interactive\": {\n \"type\": \"voice_call\",\n \"action\": {\n \"button\": \"\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"catalog_id\": \"\",\n \"product_retailer_id\": \"\",\n \"name\": \"\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ],\n \"product_items\": [\n {\n \"product_retailer_id\": \"\"\n }\n ],\n \"title\": \"\"\n }\n ],\n \"parameters\": {\n \"display_text\": \"\",\n \"ttlMinutes\": 10080,\n \"payload\": \"\",\n \"url\": \"\",\n \"flowId\": \"\",\n \"flowCta\": \"\",\n \"flowAction\": \"navigate\",\n \"flowActionPayload\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"doloref\": -5265997.495780766\n }\n }\n }\n },\n \"header\": {\n \"document\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"image\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"text\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"type\": \"video\",\n \"video\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n }\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n }\n },\n \"video\": {\n \"thumbnail\": \"\",\n \"filesize\": \"\",\n \"duration\": \"\"\n },\n \"image\": {\n \"thumbnail\": \"\"\n },\n \"audio\": {\n \"duration\": \"\"\n },\n \"template\": {\n \"name\": \"\",\n \"language\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"ttlMinutes\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"occaecat_0f9\": 22876862,\n \"eiusmod__d7\": \"\",\n \"Ut_3ee\": false,\n \"dolore4\": \"nulla Duis\"\n }\n },\n \"ttlMinutes\": 10080\n }\n ],\n \"index\": 0,\n \"subType\": \"CopyCode\",\n \"cards\": [\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n }\n ]\n }\n ]\n }\n ]\n },\n \"richCard\": {\n \"cardOrientation\": \"vertical\",\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"tall\"\n },\n \"thumbnailImageAlignment\": \"left\",\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"carousel\": {\n \"cardWidth\": \"medium\",\n \"cards\": [\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"tall\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"medium\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n }\n ]\n },\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"channels\": [\n {\n \"channel\": \"Zalo\",\n \"fallbackAfter\": \"\",\n \"successStatus\": \"Read\"\n }\n ],\n \"context\": {\n \"umid\": \"\"\n }\n }\n ],\n \"clientBatchId\": \"\",\n \"template\": {\n \"type\": \"video\",\n \"content\": {\n \"text\": \"\",\n \"whatsApp\": {\n \"directSend\": {\n \"category\": \"utility\",\n \"ttlSeconds\": \"\"\n }\n },\n \"url\": \"\",\n \"fallbackText\": \"\",\n \"sms\": {\n \"encoding\": \"GSM7\",\n \"source\": \"\"\n },\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"interactive\": {\n \"type\": \"voice_call\",\n \"action\": {\n \"button\": \"\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"catalog_id\": \"\",\n \"product_retailer_id\": \"\",\n \"name\": \"\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ],\n \"product_items\": [\n {\n \"product_retailer_id\": \"\"\n }\n ],\n \"title\": \"\"\n }\n ],\n \"parameters\": {\n \"display_text\": \"\",\n \"ttlMinutes\": 10080,\n \"payload\": \"\",\n \"url\": \"\",\n \"flowId\": \"\",\n \"flowCta\": \"\",\n \"flowAction\": \"navigate\",\n \"flowActionPayload\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"anim_a47\": \"in veniam labore\",\n \"eiusmod7\": 75248001\n }\n }\n }\n },\n \"header\": {\n \"document\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"image\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"text\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"type\": \"document\",\n \"video\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n }\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n }\n },\n \"video\": {\n \"thumbnail\": \"\",\n \"filesize\": \"\",\n \"duration\": \"\"\n },\n \"image\": {\n \"thumbnail\": \"\"\n },\n \"audio\": {\n \"duration\": \"\"\n },\n \"template\": {\n \"name\": \"\",\n \"language\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"mollit635\": \"sed minim\",\n \"laboris_fa\": -41471264.30819213\n }\n },\n \"ttlMinutes\": 10080\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\",\n \"cards\": [\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n }\n ]\n }\n ]\n }\n ]\n },\n \"richCard\": {\n \"cardOrientation\": \"horizontal\",\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"short\"\n },\n \"thumbnailImageAlignment\": \"right\",\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"carousel\": {\n \"cardWidth\": \"medium\",\n \"cards\": [\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"medium\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"medium\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n }\n ]\n },\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"dlrCallbackUrl\": \"\"\n },\n \"includeMessagesInResponse\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "batch" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"batchId\": \"\",\n \"acceptedCount\": \"\",\n \"rejectedCount\": \"\",\n \"clientBatchId\": \"\",\n \"messages\": [\n {\n \"status\": {\n \"state\": \"\",\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorMessage\": \"\",\n \"timestamp\": \"\"\n },\n \"umid\": \"\",\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"channelUserId\": \"\"\n },\n \"clientMessageId\": \"\"\n },\n {\n \"status\": {\n \"state\": \"\",\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorMessage\": \"\",\n \"timestamp\": \"\"\n },\n \"umid\": \"\",\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"channelUserId\": \"\"\n },\n \"clientMessageId\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-838c26e2-822f-4ce2-99dc-cef9164a3a0e" }, { "id": "6e4ef858-6341-41d3-90d6-bd60db6c693e", "name": "Bad request error response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"messages\": [\n {\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"lineUserId\": \"\",\n \"channelUserId\": \"\"\n },\n \"type\": \"text\",\n \"content\": {\n \"text\": \"\",\n \"whatsApp\": {\n \"directSend\": {\n \"category\": \"utility\",\n \"ttlSeconds\": \"\"\n }\n },\n \"url\": \"\",\n \"fallbackText\": \"\",\n \"sms\": {\n \"encoding\": \"UCS2\",\n \"source\": \"\"\n },\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"interactive\": {\n \"type\": \"voice_call\",\n \"action\": {\n \"button\": \"\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"catalog_id\": \"\",\n \"product_retailer_id\": \"\",\n \"name\": \"\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ],\n \"product_items\": [\n {\n \"product_retailer_id\": \"\"\n }\n ],\n \"title\": \"\"\n }\n ],\n \"parameters\": {\n \"display_text\": \"\",\n \"ttlMinutes\": 10080,\n \"payload\": \"\",\n \"url\": \"\",\n \"flowId\": \"\",\n \"flowCta\": \"\",\n \"flowAction\": \"navigate\",\n \"flowActionPayload\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"doloref\": -5265997.495780766\n }\n }\n }\n },\n \"header\": {\n \"document\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"image\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"text\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"type\": \"video\",\n \"video\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n }\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n }\n },\n \"video\": {\n \"thumbnail\": \"\",\n \"filesize\": \"\",\n \"duration\": \"\"\n },\n \"image\": {\n \"thumbnail\": \"\"\n },\n \"audio\": {\n \"duration\": \"\"\n },\n \"template\": {\n \"name\": \"\",\n \"language\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"ttlMinutes\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"occaecat_0f9\": 22876862,\n \"eiusmod__d7\": \"\",\n \"Ut_3ee\": false,\n \"dolore4\": \"nulla Duis\"\n }\n },\n \"ttlMinutes\": 10080\n }\n ],\n \"index\": 0,\n \"subType\": \"CopyCode\",\n \"cards\": [\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n }\n ]\n }\n ]\n }\n ]\n },\n \"richCard\": {\n \"cardOrientation\": \"vertical\",\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"tall\"\n },\n \"thumbnailImageAlignment\": \"left\",\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"carousel\": {\n \"cardWidth\": \"medium\",\n \"cards\": [\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"tall\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"medium\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n }\n ]\n },\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"channels\": [\n {\n \"channel\": \"Zalo\",\n \"fallbackAfter\": \"\",\n \"successStatus\": \"Read\"\n }\n ],\n \"context\": {\n \"umid\": \"\"\n }\n }\n ],\n \"clientBatchId\": \"\",\n \"template\": {\n \"type\": \"video\",\n \"content\": {\n \"text\": \"\",\n \"whatsApp\": {\n \"directSend\": {\n \"category\": \"utility\",\n \"ttlSeconds\": \"\"\n }\n },\n \"url\": \"\",\n \"fallbackText\": \"\",\n \"sms\": {\n \"encoding\": \"GSM7\",\n \"source\": \"\"\n },\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"interactive\": {\n \"type\": \"voice_call\",\n \"action\": {\n \"button\": \"\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"catalog_id\": \"\",\n \"product_retailer_id\": \"\",\n \"name\": \"\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ],\n \"product_items\": [\n {\n \"product_retailer_id\": \"\"\n }\n ],\n \"title\": \"\"\n }\n ],\n \"parameters\": {\n \"display_text\": \"\",\n \"ttlMinutes\": 10080,\n \"payload\": \"\",\n \"url\": \"\",\n \"flowId\": \"\",\n \"flowCta\": \"\",\n \"flowAction\": \"navigate\",\n \"flowActionPayload\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"anim_a47\": \"in veniam labore\",\n \"eiusmod7\": 75248001\n }\n }\n }\n },\n \"header\": {\n \"document\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"image\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"text\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"type\": \"document\",\n \"video\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n }\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n }\n },\n \"video\": {\n \"thumbnail\": \"\",\n \"filesize\": \"\",\n \"duration\": \"\"\n },\n \"image\": {\n \"thumbnail\": \"\"\n },\n \"audio\": {\n \"duration\": \"\"\n },\n \"template\": {\n \"name\": \"\",\n \"language\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"mollit635\": \"sed minim\",\n \"laboris_fa\": -41471264.30819213\n }\n },\n \"ttlMinutes\": 10080\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\",\n \"cards\": [\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n }\n ]\n }\n ]\n }\n ]\n },\n \"richCard\": {\n \"cardOrientation\": \"horizontal\",\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"short\"\n },\n \"thumbnailImageAlignment\": \"right\",\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"carousel\": {\n \"cardWidth\": \"medium\",\n \"cards\": [\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"medium\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"medium\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n }\n ]\n },\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"dlrCallbackUrl\": \"\"\n },\n \"includeMessagesInResponse\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "batch" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-6e4ef858-6341-41d3-90d6-bd60db6c693e" }, { "id": "ddcbe89a-af18-471e-a65b-ff7a4108ee99", "name": "Request was not authenticated response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"messages\": [\n {\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"lineUserId\": \"\",\n \"channelUserId\": \"\"\n },\n \"type\": \"text\",\n \"content\": {\n \"text\": \"\",\n \"whatsApp\": {\n \"directSend\": {\n \"category\": \"utility\",\n \"ttlSeconds\": \"\"\n }\n },\n \"url\": \"\",\n \"fallbackText\": \"\",\n \"sms\": {\n \"encoding\": \"UCS2\",\n \"source\": \"\"\n },\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"interactive\": {\n \"type\": \"voice_call\",\n \"action\": {\n \"button\": \"\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"catalog_id\": \"\",\n \"product_retailer_id\": \"\",\n \"name\": \"\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ],\n \"product_items\": [\n {\n \"product_retailer_id\": \"\"\n }\n ],\n \"title\": \"\"\n }\n ],\n \"parameters\": {\n \"display_text\": \"\",\n \"ttlMinutes\": 10080,\n \"payload\": \"\",\n \"url\": \"\",\n \"flowId\": \"\",\n \"flowCta\": \"\",\n \"flowAction\": \"navigate\",\n \"flowActionPayload\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"doloref\": -5265997.495780766\n }\n }\n }\n },\n \"header\": {\n \"document\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"image\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"text\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"type\": \"video\",\n \"video\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n }\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n }\n },\n \"video\": {\n \"thumbnail\": \"\",\n \"filesize\": \"\",\n \"duration\": \"\"\n },\n \"image\": {\n \"thumbnail\": \"\"\n },\n \"audio\": {\n \"duration\": \"\"\n },\n \"template\": {\n \"name\": \"\",\n \"language\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"ttlMinutes\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"occaecat_0f9\": 22876862,\n \"eiusmod__d7\": \"\",\n \"Ut_3ee\": false,\n \"dolore4\": \"nulla Duis\"\n }\n },\n \"ttlMinutes\": 10080\n }\n ],\n \"index\": 0,\n \"subType\": \"CopyCode\",\n \"cards\": [\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n }\n ]\n }\n ]\n }\n ]\n },\n \"richCard\": {\n \"cardOrientation\": \"vertical\",\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"tall\"\n },\n \"thumbnailImageAlignment\": \"left\",\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"carousel\": {\n \"cardWidth\": \"medium\",\n \"cards\": [\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"tall\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"medium\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n }\n ]\n },\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"channels\": [\n {\n \"channel\": \"Zalo\",\n \"fallbackAfter\": \"\",\n \"successStatus\": \"Read\"\n }\n ],\n \"context\": {\n \"umid\": \"\"\n }\n }\n ],\n \"clientBatchId\": \"\",\n \"template\": {\n \"type\": \"video\",\n \"content\": {\n \"text\": \"\",\n \"whatsApp\": {\n \"directSend\": {\n \"category\": \"utility\",\n \"ttlSeconds\": \"\"\n }\n },\n \"url\": \"\",\n \"fallbackText\": \"\",\n \"sms\": {\n \"encoding\": \"GSM7\",\n \"source\": \"\"\n },\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"interactive\": {\n \"type\": \"voice_call\",\n \"action\": {\n \"button\": \"\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"catalog_id\": \"\",\n \"product_retailer_id\": \"\",\n \"name\": \"\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ],\n \"product_items\": [\n {\n \"product_retailer_id\": \"\"\n }\n ],\n \"title\": \"\"\n }\n ],\n \"parameters\": {\n \"display_text\": \"\",\n \"ttlMinutes\": 10080,\n \"payload\": \"\",\n \"url\": \"\",\n \"flowId\": \"\",\n \"flowCta\": \"\",\n \"flowAction\": \"navigate\",\n \"flowActionPayload\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"anim_a47\": \"in veniam labore\",\n \"eiusmod7\": 75248001\n }\n }\n }\n },\n \"header\": {\n \"document\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"image\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"text\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"type\": \"document\",\n \"video\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n }\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n }\n },\n \"video\": {\n \"thumbnail\": \"\",\n \"filesize\": \"\",\n \"duration\": \"\"\n },\n \"image\": {\n \"thumbnail\": \"\"\n },\n \"audio\": {\n \"duration\": \"\"\n },\n \"template\": {\n \"name\": \"\",\n \"language\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"mollit635\": \"sed minim\",\n \"laboris_fa\": -41471264.30819213\n }\n },\n \"ttlMinutes\": 10080\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\",\n \"cards\": [\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n }\n ]\n }\n ]\n }\n ]\n },\n \"richCard\": {\n \"cardOrientation\": \"horizontal\",\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"short\"\n },\n \"thumbnailImageAlignment\": \"right\",\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"carousel\": {\n \"cardWidth\": \"medium\",\n \"cards\": [\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"medium\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"medium\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n }\n ]\n },\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"dlrCallbackUrl\": \"\"\n },\n \"includeMessagesInResponse\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "batch" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-ddcbe89a-af18-471e-a65b-ff7a4108ee99" }, { "id": "c4243679-1a3d-46cf-a115-a73b1be6cc03", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"messages\": [\n {\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"lineUserId\": \"\",\n \"channelUserId\": \"\"\n },\n \"type\": \"text\",\n \"content\": {\n \"text\": \"\",\n \"whatsApp\": {\n \"directSend\": {\n \"category\": \"utility\",\n \"ttlSeconds\": \"\"\n }\n },\n \"url\": \"\",\n \"fallbackText\": \"\",\n \"sms\": {\n \"encoding\": \"UCS2\",\n \"source\": \"\"\n },\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"interactive\": {\n \"type\": \"voice_call\",\n \"action\": {\n \"button\": \"\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"catalog_id\": \"\",\n \"product_retailer_id\": \"\",\n \"name\": \"\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ],\n \"product_items\": [\n {\n \"product_retailer_id\": \"\"\n }\n ],\n \"title\": \"\"\n }\n ],\n \"parameters\": {\n \"display_text\": \"\",\n \"ttlMinutes\": 10080,\n \"payload\": \"\",\n \"url\": \"\",\n \"flowId\": \"\",\n \"flowCta\": \"\",\n \"flowAction\": \"navigate\",\n \"flowActionPayload\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"doloref\": -5265997.495780766\n }\n }\n }\n },\n \"header\": {\n \"document\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"image\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"text\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"type\": \"video\",\n \"video\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n }\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n }\n },\n \"video\": {\n \"thumbnail\": \"\",\n \"filesize\": \"\",\n \"duration\": \"\"\n },\n \"image\": {\n \"thumbnail\": \"\"\n },\n \"audio\": {\n \"duration\": \"\"\n },\n \"template\": {\n \"name\": \"\",\n \"language\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"ttlMinutes\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"occaecat_0f9\": 22876862,\n \"eiusmod__d7\": \"\",\n \"Ut_3ee\": false,\n \"dolore4\": \"nulla Duis\"\n }\n },\n \"ttlMinutes\": 10080\n }\n ],\n \"index\": 0,\n \"subType\": \"CopyCode\",\n \"cards\": [\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n }\n ]\n }\n ]\n }\n ]\n },\n \"richCard\": {\n \"cardOrientation\": \"vertical\",\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"tall\"\n },\n \"thumbnailImageAlignment\": \"left\",\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"carousel\": {\n \"cardWidth\": \"medium\",\n \"cards\": [\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"tall\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"medium\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n }\n ]\n },\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"channels\": [\n {\n \"channel\": \"Zalo\",\n \"fallbackAfter\": \"\",\n \"successStatus\": \"Read\"\n }\n ],\n \"context\": {\n \"umid\": \"\"\n }\n }\n ],\n \"clientBatchId\": \"\",\n \"template\": {\n \"type\": \"video\",\n \"content\": {\n \"text\": \"\",\n \"whatsApp\": {\n \"directSend\": {\n \"category\": \"utility\",\n \"ttlSeconds\": \"\"\n }\n },\n \"url\": \"\",\n \"fallbackText\": \"\",\n \"sms\": {\n \"encoding\": \"GSM7\",\n \"source\": \"\"\n },\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"interactive\": {\n \"type\": \"voice_call\",\n \"action\": {\n \"button\": \"\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"catalog_id\": \"\",\n \"product_retailer_id\": \"\",\n \"name\": \"\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ],\n \"product_items\": [\n {\n \"product_retailer_id\": \"\"\n }\n ],\n \"title\": \"\"\n }\n ],\n \"parameters\": {\n \"display_text\": \"\",\n \"ttlMinutes\": 10080,\n \"payload\": \"\",\n \"url\": \"\",\n \"flowId\": \"\",\n \"flowCta\": \"\",\n \"flowAction\": \"navigate\",\n \"flowActionPayload\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"anim_a47\": \"in veniam labore\",\n \"eiusmod7\": 75248001\n }\n }\n }\n },\n \"header\": {\n \"document\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"image\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"text\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"type\": \"document\",\n \"video\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n }\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n }\n },\n \"video\": {\n \"thumbnail\": \"\",\n \"filesize\": \"\",\n \"duration\": \"\"\n },\n \"image\": {\n \"thumbnail\": \"\"\n },\n \"audio\": {\n \"duration\": \"\"\n },\n \"template\": {\n \"name\": \"\",\n \"language\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"mollit635\": \"sed minim\",\n \"laboris_fa\": -41471264.30819213\n }\n },\n \"ttlMinutes\": 10080\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\",\n \"cards\": [\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"image\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n }\n ]\n }\n ]\n }\n ]\n },\n \"richCard\": {\n \"cardOrientation\": \"horizontal\",\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"short\"\n },\n \"thumbnailImageAlignment\": \"right\",\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"carousel\": {\n \"cardWidth\": \"medium\",\n \"cards\": [\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"medium\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"medium\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n }\n ]\n },\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"dlrCallbackUrl\": \"\"\n },\n \"includeMessagesInResponse\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "batch" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-c4243679-1a3d-46cf-a115-a73b1be6cc03" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-4e602f45-dd8f-4eb8-99d1-87fae5a67122" } ], "id": "b6f7d209-1718-4123-8406-dcde63ebb905", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-b6f7d209-1718-4123-8406-dcde63ebb905" }, { "name": "{umid}", "item": [ { "name": "read", "item": [ { "name": "Mark message as read", "id": "94e8ac45-b4b9-4f62-89da-a4d376e9cc7b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid/read", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid", "read" ], "variable": [ { "id": "15ff45b1-851a-476a-9234-6da248d67265", "key": "subAccountId", "value": "R9NaCkLgHIvQsJybeqo9xUk0Ea&9B5R.oGGhwosoeXqg4", "description": "(Required) You must replace *{subAccountId}* with the subaccountid that you want to use. By default this is generated once you signed up with a new account at [https://connect.8x8.com](https://connect.8x8.com)." }, { "id": "bd2fa142-a4a1-4079-bc5a-6666224b94cb", "key": "umid", "value": "", "description": "(Required) Unique message Id, generated by 8x8 API." } ] }, "description": "This endpoint is used to indicate to end users that a message has been read by the respective brand or official account. \n\nCurrent channel support: \n- WhatsApp Business account (two blue ticks on customers message). \n" }, "response": [ { "id": "ed743e60-ae0b-4bf1-9898-97731beaa22e", "name": "Request is successful. ", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid/read", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid", "read" ], "variable": [ { "key": "subAccountId" }, { "key": "umid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-ed743e60-ae0b-4bf1-9898-97731beaa22e" }, { "id": "f6a2ed51-b161-4951-8610-599394c995ff", "name": "Bad request error response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid/read", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid", "read" ], "variable": [ { "key": "subAccountId" }, { "key": "umid" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-f6a2ed51-b161-4951-8610-599394c995ff" }, { "id": "9d61a522-3593-4f8b-8e79-3ab550aca6ed", "name": "Request was not authenticated response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid/read", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid", "read" ], "variable": [ { "key": "subAccountId" }, { "key": "umid" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-9d61a522-3593-4f8b-8e79-3ab550aca6ed" }, { "id": "a2f9cfbc-3664-4bf0-bb1f-fb8c9633bae6", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid/read", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid", "read" ], "variable": [ { "key": "subAccountId" }, { "key": "umid" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-a2f9cfbc-3664-4bf0-bb1f-fb8c9633bae6" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-94e8ac45-b4b9-4f62-89da-a4d376e9cc7b" } ], "id": "39a1853c-332f-43ca-be5e-d9c1b08db932", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-39a1853c-332f-43ca-be5e-d9c1b08db932" }, { "name": "Retrieve message details", "id": "5406b4b3-cadb-4dd5-88d0-4effba30b249", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid" ], "variable": [ { "id": "ae0f2a5a-db2f-4adf-a688-bcd01a3393b9", "key": "subAccountId", "value": "R9NaCkLgHIvQsJybeqo9xUk0Ea&9B5R.oGGhwosoeXqg4", "description": "(Required) You must replace *{subAccountId}* with the subaccountid that you want to use. By default this is generated once you signed up with a new account at [https://connect.8x8.com](https://connect.8x8.com)." }, { "id": "ef681543-1e1f-44cc-9bb5-c2c938f57e6e", "key": "umid", "value": "", "description": "(Required) Unique message Id, generated by 8x8 API." } ] }, "description": "This resource can be used to query message details like delivery status using the UMID of the message. You need to specify the sub account id and the umid of the message in place of *{subAccountId}* and *{umid}* respectively. *umid* is the unique identifier (in the form of a uuid) you received when you submitted the message to the api.\n\n### API Rate Limiting\nTo protect the platform from being overloaded and maintain a high quality of service to all customers, we enforce API rate limits for this API endpoint.\n\nThe limit is set to 1 request/second per subaccount.\n> To safeguard your privacy, sensitive data such as message content and phone numbers are masked by default. Access to this information can be requested by contacting our support team." }, "response": [ { "id": "bef1c1bf-378d-4afb-89f8-d83debf4c559", "name": "The success response returned with the message details of the message specified by the umid. Since channel fallback is supported, a single message umid may have multiple message details records depending on the number of channels attempted.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid" ], "variable": [ { "key": "subAccountId" }, { "key": "umid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"umid\": \"\",\n \"subAccountId\": \"\",\n \"channel\": \"\",\n \"channelId\": \"\",\n \"direction\": \"\",\n \"status\": {\n \"state\": \"\",\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorMessage\": \"\",\n \"timestamp\": \"\"\n },\n \"contentType\": \"\",\n \"createdAt\": \"\",\n \"step\": \"\",\n \"country\": \"\",\n \"user\": {\n \"msisdn\": \"\",\n \"channelUserId\": \"\"\n },\n \"content\": \"\",\n \"clientMessageId\": \"\",\n \"clientBatchId\": \"\",\n \"batchId\": \"\"\n },\n {\n \"umid\": \"\",\n \"subAccountId\": \"\",\n \"channel\": \"\",\n \"channelId\": \"\",\n \"direction\": \"\",\n \"status\": {\n \"state\": \"\",\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorMessage\": \"\",\n \"timestamp\": \"\"\n },\n \"contentType\": \"\",\n \"createdAt\": \"\",\n \"step\": \"\",\n \"country\": \"\",\n \"user\": {\n \"msisdn\": \"\",\n \"channelUserId\": \"\"\n },\n \"content\": \"\",\n \"clientMessageId\": \"\",\n \"clientBatchId\": \"\",\n \"batchId\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-bef1c1bf-378d-4afb-89f8-d83debf4c559" }, { "id": "f3870b08-b03c-4356-a2b0-045959388c8b", "name": "Bad request error response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid" ], "variable": [ { "key": "subAccountId" }, { "key": "umid" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-f3870b08-b03c-4356-a2b0-045959388c8b" }, { "id": "2d6d13a5-886b-438f-83b1-3e24f548bf93", "name": "Request was not authenticated response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid" ], "variable": [ { "key": "subAccountId" }, { "key": "umid" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-2d6d13a5-886b-438f-83b1-3e24f548bf93" }, { "id": "6ba494d2-f817-49b7-8d15-b43fbe4c4a2d", "name": "The entity doesn't exist", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid" ], "variable": [ { "key": "subAccountId" }, { "key": "umid" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-6ba494d2-f817-49b7-8d15-b43fbe4c4a2d" }, { "id": "4d4f9e92-ab29-4212-ab4b-c47a26abd285", "name": "Rate limiting quota exceeded error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid" ], "variable": [ { "key": "subAccountId" }, { "key": "umid" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-4d4f9e92-ab29-4212-ab4b-c47a26abd285" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-5406b4b3-cadb-4dd5-88d0-4effba30b249" }, { "name": "Cancel the scheduled message", "id": "b0dfcfe6-96a9-4e33-9194-d43b50ae44c0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid" ], "variable": [ { "id": "5aa02967-3257-489b-a71f-90e8bd976ba0", "key": "subAccountId", "value": "R9NaCkLgHIvQsJybeqo9xUk0Ea&9B5R.oGGhwosoeXqg4", "description": "(Required) You must replace *{subAccountId}* with the subaccountid that you want to use. By default this is generated once you signed up with a new account at [https://connect.8x8.com](https://connect.8x8.com)." }, { "id": "b991f8fb-da57-4390-a197-5e189ea63a6c", "key": "umid", "value": "", "description": "(Required) Unique message Id, generated by 8x8 API." } ] }, "description": "This resource can be used to cancel a scheduled message that has not been sent yet using the *unique message identifier* (`UMID`) of the message.\n\n### URL\nYou need to specify the *sub-account id* and the *umid* of the message in place of `{subAccountId}` and `{umid}` respectively. \n`umid` is the unique identifier you received when you submitted the message to the API.\n" }, "response": [ { "id": "f96a8aee-feba-497e-85d7-b44f436f2f6d", "name": "Successful operation", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid" ], "variable": [ { "key": "subAccountId" }, { "key": "umid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"cancelledCount\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-f96a8aee-feba-497e-85d7-b44f436f2f6d" }, { "id": "951cde7e-a448-40be-960e-8a1c8b59fb7c", "name": "This error response is returned if the request is invalid (e.g. umid is not a valid uuid).", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid" ], "variable": [ { "key": "subAccountId" }, { "key": "umid" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-951cde7e-a448-40be-960e-8a1c8b59fb7c" }, { "id": "a14baff6-925c-48bf-b4b6-89a1ecd59cd2", "name": "Request was not authenticated response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid" ], "variable": [ { "key": "subAccountId" }, { "key": "umid" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-a14baff6-925c-48bf-b4b6-89a1ecd59cd2" }, { "id": "abf82fe9-c1ad-4fce-a71a-b724672e1ab1", "name": "This error response is returned if there is a message by the specified sub account and umid does not exist.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid" ], "variable": [ { "key": "subAccountId" }, { "key": "umid" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-abf82fe9-c1ad-4fce-a71a-b724672e1ab1" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-b0dfcfe6-96a9-4e33-9194-d43b50ae44c0" } ], "id": "48335ab3-16ef-4553-9e67-e31fb226f821", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-48335ab3-16ef-4553-9e67-e31fb226f821" }, { "name": "exports", "item": [ { "name": "{jobId}", "item": [ { "name": "Get log export job result", "id": "c47faf6f-a83b-453c-b558-eea8a9a31a17", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/exports/:jobId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "exports", ":jobId" ], "variable": [ { "id": "e8f094cc-bda7-4e72-b6a0-bcd7e3f3a701", "key": "subAccountId", "value": "R9NaCkLgHIvQsJybeqo9xUk0Ea&9B5R.oGGhwosoeXqg4", "description": "(Required) You must replace *{subAccountId}* with the subaccountid that you want to use. By default this is generated once you signed up with a new account at [https://connect.8x8.com](https://connect.8x8.com)." }, { "id": "b70ca88c-09ae-4b60-a5d5-438b16e81168", "key": "jobId", "value": "", "description": "(Required) Export job identifier" } ] }, "description": "* Sending a **GET** request on this endpoint allows to **check the status of an Messaging Apps Logs export job** and to **get a download link** if its generation has succeeded.\n\n \n\n## URL\n\nTo define which SMS logs export you want to retrieve, you need to enter the Job ID generated by XXXXX in the path as well as the 8x8 SMS subaccountid you used in the previous request.\n`https://chatapps.8x8.com/api/v1/subaccounts/{subAccountID}/messages/exports/{jobId}`\n\n*You must replace `{jobID}` and `{subAccountId}` in the URL above with the jobID and subaccountid from the start SMS logs export job request*\n> To safeguard your privacy, sensitive data such as message content and phone numbers are masked by default. Access to this information can be requested by contacting our support team." }, "response": [ { "id": "4ec03b48-2631-43e9-87ad-9a49c86186d1", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/exports/:jobId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "exports", ":jobId" ], "variable": [ { "key": "subAccountId" }, { "key": "jobId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"failed\",\n \"data\": [\n \"\",\n \"\"\n ],\n \"expires\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-4ec03b48-2631-43e9-87ad-9a49c86186d1" }, { "id": "0463c06a-e451-4789-bf89-b974669a10b2", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/exports/:jobId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "exports", ":jobId" ], "variable": [ { "key": "subAccountId" }, { "key": "jobId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-0463c06a-e451-4789-bf89-b974669a10b2" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-c47faf6f-a83b-453c-b558-eea8a9a31a17" }, { "name": "Cancel the log export job ", "id": "7f8db0b5-6609-4358-8807-8143b66f475d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/exports/:jobId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "exports", ":jobId" ], "variable": [ { "id": "06027aa0-fd3a-416e-8a1d-a3939f75712f", "key": "subAccountId", "value": "R9NaCkLgHIvQsJybeqo9xUk0Ea&9B5R.oGGhwosoeXqg4", "description": "(Required) You must replace *{subAccountId}* with the subaccountid that you want to use. By default this is generated once you signed up with a new account at [https://connect.8x8.com](https://connect.8x8.com)." }, { "id": "2d6d19ac-1caa-460a-ba73-7df04b6ba46a", "key": "jobId", "value": "", "description": "(Required) Export job identifier" } ] }, "description": "* Sending a **DELETE** request on this endpoint allows to **cancel a Messaging Apps Logs export job**.\n\n \n\n## URL\n\nTo define which SMS logs export you want to retrieve, you need to enter the Job ID generated by XXXXX in the path as well as the 8x8 SMS subaccountid you used in the previous request.\n`https://chatapps.8x8.com/api/v1/subaccounts/{subAccountID}/messages/exports/{jobId}`\n\n*You must replace `{jobID}` and `{subAccountId}` in the URL above with the jobID and subaccountid from the start SMS logs export job request*" }, "response": [ { "id": "5105b025-1769-4dde-9783-0ac5510ebdcf", "name": "New Response", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/exports/:jobId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "exports", ":jobId" ], "variable": [ { "key": "subAccountId" }, { "key": "jobId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-5105b025-1769-4dde-9783-0ac5510ebdcf" }, { "id": "be03eaf5-d88c-4ea0-aa35-ef2f4c176384", "name": "New Response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/exports/:jobId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "exports", ":jobId" ], "variable": [ { "key": "subAccountId" }, { "key": "jobId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-be03eaf5-d88c-4ea0-aa35-ef2f4c176384" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-7f8db0b5-6609-4358-8807-8143b66f475d" } ], "id": "ef1952d2-0022-4a5f-96e9-cde808562e8b", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-ef1952d2-0022-4a5f-96e9-cde808562e8b" }, { "name": "Start log export job", "id": "58d7a67b-671f-4ac1-a518-20c3d080a399", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"from\": \"\",\n \"to\": \"\",\n \"phoneNumber\": \"\",\n \"countries\": [\n \"\",\n \"\"\n ],\n \"limit\": 0,\n \"channelUserId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/exports", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "exports" ], "variable": [ { "id": "38b03f69-9d58-46c2-a06b-52386886dd74", "key": "subAccountId", "value": "R9NaCkLgHIvQsJybeqo9xUk0Ea&9B5R.oGGhwosoeXqg4", "description": "(Required) You must replace *{subAccountId}* with the subaccountid that you want to use. By default this is generated once you signed up with a new account at [https://connect.8x8.com](https://connect.8x8.com)." } ] }, "description": "* Sending a **POST** request on this endpoint allows to **request an Messaging Apps logs file**.\n\n## URL\n\nThe 8x8 Messaging Apps `subAccountId` needs to be provided in the URL as shown below:\n`https://chatapps.8x8.com/api/v1/subaccounts/{subAccountID}/messages/exports`\n\n*You must replace `{subAccountId}` in the URL above with the subaccountid that you want to use.*" }, "response": [ { "id": "2a194b94-d8b8-408f-b0cb-5c20a56b1def", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"from\": \"\",\n \"to\": \"\",\n \"phoneNumber\": \"\",\n \"countries\": [\n \"\",\n \"\"\n ],\n \"limit\": 0,\n \"channelUserId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/exports", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", "exports" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"jobId\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-2a194b94-d8b8-408f-b0cb-5c20a56b1def" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-58d7a67b-671f-4ac1-a518-20c3d080a399" } ], "id": "e6a719ff-8bea-450e-9d41-8a9fbb37f680", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-e6a719ff-8bea-450e-9d41-8a9fbb37f680" }, { "name": "Send message", "id": "64ec81b0-7dd0-485e-9e36-352e36b7b373", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"lineUserId\": \"\",\n \"channelUserId\": \"\"\n },\n \"type\": \"audio\",\n \"content\": {\n \"text\": \"\",\n \"whatsApp\": {\n \"directSend\": {\n \"category\": \"utility\",\n \"ttlSeconds\": \"\"\n }\n },\n \"url\": \"\",\n \"fallbackText\": \"\",\n \"sms\": {\n \"encoding\": \"AUTO\",\n \"source\": \"\"\n },\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"interactive\": {\n \"type\": \"request_contact_info\",\n \"action\": {\n \"button\": \"\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n },\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"catalog_id\": \"\",\n \"product_retailer_id\": \"\",\n \"name\": \"\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ],\n \"product_items\": [\n {\n \"product_retailer_id\": \"\"\n },\n {\n \"product_retailer_id\": \"\"\n }\n ],\n \"title\": \"\"\n }\n ],\n \"parameters\": {\n \"display_text\": \"\",\n \"ttlMinutes\": 10080,\n \"payload\": \"\",\n \"url\": \"\",\n \"flowId\": \"\",\n \"flowCta\": \"\",\n \"flowAction\": \"navigate\",\n \"flowActionPayload\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"in916\": false\n }\n }\n }\n },\n \"header\": {\n \"document\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"image\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"text\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"type\": \"text\",\n \"video\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n }\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n }\n },\n \"video\": {\n \"thumbnail\": \"\",\n \"filesize\": \"\",\n \"duration\": \"\"\n },\n \"image\": {\n \"thumbnail\": \"\"\n },\n \"audio\": {\n \"duration\": \"\"\n },\n \"template\": {\n \"name\": \"\",\n \"language\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"gif\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"ut6\": 86484048.09368029,\n \"ut_4\": \"non dolore anim\",\n \"deserunt_10\": \"ad laboris labore Lorem\",\n \"dolore46b\": 83104166\n }\n },\n \"ttlMinutes\": 10080\n },\n {\n \"type\": \"ttlMinutes\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"irure_d3\": true\n }\n },\n \"ttlMinutes\": 10080\n }\n ],\n \"index\": 0,\n \"subType\": \"VoiceCall\",\n \"cards\": [\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"payload\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"couponCode\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"location\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n }\n ]\n },\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"payload\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"video\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"couponCode\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n }\n ]\n }\n ]\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"ttlMinutes\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"incididuntb4b\": -96275303,\n \"ipsum_91\": \"fugiat\",\n \"eiusmod12\": true,\n \"in_4\": -83906494\n }\n },\n \"ttlMinutes\": 10080\n },\n {\n \"type\": \"couponCode\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"occaecat_3\": \"e\",\n \"voluptate_b8\": 72194666,\n \"minimb2b\": \"in eiusmod\"\n }\n },\n \"ttlMinutes\": 10080\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\",\n \"cards\": [\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"location\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"video\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n }\n ]\n },\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"video\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"text\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n }\n ]\n }\n ]\n }\n ]\n },\n \"richCard\": {\n \"cardOrientation\": \"vertical\",\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"tall\"\n },\n \"thumbnailImageAlignment\": \"right\",\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n },\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"carousel\": {\n \"cardWidth\": \"small\",\n \"cards\": [\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"medium\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n },\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"short\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n },\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n }\n ]\n },\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n },\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"channels\": [\n {\n \"channel\": \"WeChat\",\n \"fallbackAfter\": \"\",\n \"successStatus\": \"Delivered\"\n },\n {\n \"channel\": \"Facebook\",\n \"fallbackAfter\": \"\",\n \"successStatus\": \"Delivered\"\n }\n ],\n \"context\": {\n \"umid\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages" ], "variable": [ { "id": "7ef303a3-32c7-4895-b56b-38d69ec9ddc4", "key": "subAccountId", "value": "R9NaCkLgHIvQsJybeqo9xUk0Ea&9B5R.oGGhwosoeXqg4", "description": "(Required) You must replace *{subAccountId}* with the subaccountid that you want to use. By default this is generated once you signed up with a new account at [https://connect.8x8.com](https://connect.8x8.com)." } ] }, "description": "This endpoint is used to send Messaging Apps messages individually (1 request per message).\nIt is ideal to send single personalized messages for use-cases like notifications or alerting for example.\n\n**For WhatsApp:**\nWhen sending a 'text' type message, we will try to match it with registered WhatsApp templates under your account\nIf matching is successful, the message will be submitted as a template to WhatsApp, if not as a normal message\n\nTo bypass the template matching and send template only, you can select type 'template'\nIn this case, you need to provide template name, language and parameters\n\n**WhatsApp Call Permission Request:**\nYou can request permission to call a customer using either:\n- **Interactive message**: Set type to 'interactive' with interactive.type as 'call_permission_request'. The body field is optional.\n- **Template message**: Set type to 'template' with your approved Call Permission Request template name and language.\n\n**WhatsApp Request Contact Info:**\nYou can request a customer to share their contact information using either:\n- **Interactive message**: Set type to 'interactive' with interactive.type as 'request_contact_info'. The body field is optional.\n- **Template message**: Set type to 'template' with your approved Request Contact Info template name and language.\n\n**WhatsApp Business-Scoped User ID (BSUID):**\nYou can address a recipient using their `channelUserId` (BSUID) instead of, or alongside, their phone number (`msisdn`). Format: `.` where the country code is an uppercase ISO 3166-1 alpha-2 code (e.g. `US.13491208655302741918`). If both are provided, `msisdn` takes precedence.\n\n\nMore examples on how this endpoint can be used are available here: [Usage examples](/connect/docs/whatsapp/whatsapp-over-8x8-api)" }, "response": [ { "id": "1d733994-bbe2-4002-9e57-2280bfb68cdc", "name": "Success response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"lineUserId\": \"\",\n \"channelUserId\": \"\"\n },\n \"type\": \"audio\",\n \"content\": {\n \"text\": \"\",\n \"whatsApp\": {\n \"directSend\": {\n \"category\": \"utility\",\n \"ttlSeconds\": \"\"\n }\n },\n \"url\": \"\",\n \"fallbackText\": \"\",\n \"sms\": {\n \"encoding\": \"AUTO\",\n \"source\": \"\"\n },\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"interactive\": {\n \"type\": \"request_contact_info\",\n \"action\": {\n \"button\": \"\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n },\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"catalog_id\": \"\",\n \"product_retailer_id\": \"\",\n \"name\": \"\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ],\n \"product_items\": [\n {\n \"product_retailer_id\": \"\"\n },\n {\n \"product_retailer_id\": \"\"\n }\n ],\n \"title\": \"\"\n }\n ],\n \"parameters\": {\n \"display_text\": \"\",\n \"ttlMinutes\": 10080,\n \"payload\": \"\",\n \"url\": \"\",\n \"flowId\": \"\",\n \"flowCta\": \"\",\n \"flowAction\": \"navigate\",\n \"flowActionPayload\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"in916\": false\n }\n }\n }\n },\n \"header\": {\n \"document\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"image\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"text\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"type\": \"text\",\n \"video\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n }\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n }\n },\n \"video\": {\n \"thumbnail\": \"\",\n \"filesize\": \"\",\n \"duration\": \"\"\n },\n \"image\": {\n \"thumbnail\": \"\"\n },\n \"audio\": {\n \"duration\": \"\"\n },\n \"template\": {\n \"name\": \"\",\n \"language\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"gif\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"ut6\": 86484048.09368029,\n \"ut_4\": \"non dolore anim\",\n \"deserunt_10\": \"ad laboris labore Lorem\",\n \"dolore46b\": 83104166\n }\n },\n \"ttlMinutes\": 10080\n },\n {\n \"type\": \"ttlMinutes\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"irure_d3\": true\n }\n },\n \"ttlMinutes\": 10080\n }\n ],\n \"index\": 0,\n \"subType\": \"VoiceCall\",\n \"cards\": [\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"payload\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"couponCode\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"location\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n }\n ]\n },\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"payload\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"video\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"couponCode\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n }\n ]\n }\n ]\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"ttlMinutes\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"incididuntb4b\": -96275303,\n \"ipsum_91\": \"fugiat\",\n \"eiusmod12\": true,\n \"in_4\": -83906494\n }\n },\n \"ttlMinutes\": 10080\n },\n {\n \"type\": \"couponCode\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"occaecat_3\": \"e\",\n \"voluptate_b8\": 72194666,\n \"minimb2b\": \"in eiusmod\"\n }\n },\n \"ttlMinutes\": 10080\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\",\n \"cards\": [\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"location\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"video\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n }\n ]\n },\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"video\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"text\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n }\n ]\n }\n ]\n }\n ]\n },\n \"richCard\": {\n \"cardOrientation\": \"vertical\",\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"tall\"\n },\n \"thumbnailImageAlignment\": \"right\",\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n },\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"carousel\": {\n \"cardWidth\": \"small\",\n \"cards\": [\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"medium\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n },\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"short\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n },\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n }\n ]\n },\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n },\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"channels\": [\n {\n \"channel\": \"WeChat\",\n \"fallbackAfter\": \"\",\n \"successStatus\": \"Delivered\"\n },\n {\n \"channel\": \"Facebook\",\n \"fallbackAfter\": \"\",\n \"successStatus\": \"Delivered\"\n }\n ],\n \"context\": {\n \"umid\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": {\n \"state\": \"\",\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorMessage\": \"\",\n \"timestamp\": \"\"\n },\n \"umid\": \"\",\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"channelUserId\": \"\"\n },\n \"clientMessageId\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-1d733994-bbe2-4002-9e57-2280bfb68cdc" }, { "id": "659ab385-583b-41bb-8817-a38c960fc24c", "name": "Bad request error response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"lineUserId\": \"\",\n \"channelUserId\": \"\"\n },\n \"type\": \"audio\",\n \"content\": {\n \"text\": \"\",\n \"whatsApp\": {\n \"directSend\": {\n \"category\": \"utility\",\n \"ttlSeconds\": \"\"\n }\n },\n \"url\": \"\",\n \"fallbackText\": \"\",\n \"sms\": {\n \"encoding\": \"AUTO\",\n \"source\": \"\"\n },\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"interactive\": {\n \"type\": \"request_contact_info\",\n \"action\": {\n \"button\": \"\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n },\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"catalog_id\": \"\",\n \"product_retailer_id\": \"\",\n \"name\": \"\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ],\n \"product_items\": [\n {\n \"product_retailer_id\": \"\"\n },\n {\n \"product_retailer_id\": \"\"\n }\n ],\n \"title\": \"\"\n }\n ],\n \"parameters\": {\n \"display_text\": \"\",\n \"ttlMinutes\": 10080,\n \"payload\": \"\",\n \"url\": \"\",\n \"flowId\": \"\",\n \"flowCta\": \"\",\n \"flowAction\": \"navigate\",\n \"flowActionPayload\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"in916\": false\n }\n }\n }\n },\n \"header\": {\n \"document\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"image\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"text\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"type\": \"text\",\n \"video\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n }\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n }\n },\n \"video\": {\n \"thumbnail\": \"\",\n \"filesize\": \"\",\n \"duration\": \"\"\n },\n \"image\": {\n \"thumbnail\": \"\"\n },\n \"audio\": {\n \"duration\": \"\"\n },\n \"template\": {\n \"name\": \"\",\n \"language\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"gif\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"ut6\": 86484048.09368029,\n \"ut_4\": \"non dolore anim\",\n \"deserunt_10\": \"ad laboris labore Lorem\",\n \"dolore46b\": 83104166\n }\n },\n \"ttlMinutes\": 10080\n },\n {\n \"type\": \"ttlMinutes\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"irure_d3\": true\n }\n },\n \"ttlMinutes\": 10080\n }\n ],\n \"index\": 0,\n \"subType\": \"VoiceCall\",\n \"cards\": [\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"payload\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"couponCode\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"location\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n }\n ]\n },\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"payload\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"video\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"couponCode\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n }\n ]\n }\n ]\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"ttlMinutes\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"incididuntb4b\": -96275303,\n \"ipsum_91\": \"fugiat\",\n \"eiusmod12\": true,\n \"in_4\": -83906494\n }\n },\n \"ttlMinutes\": 10080\n },\n {\n \"type\": \"couponCode\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"occaecat_3\": \"e\",\n \"voluptate_b8\": 72194666,\n \"minimb2b\": \"in eiusmod\"\n }\n },\n \"ttlMinutes\": 10080\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\",\n \"cards\": [\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"location\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"video\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n }\n ]\n },\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"video\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"text\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n }\n ]\n }\n ]\n }\n ]\n },\n \"richCard\": {\n \"cardOrientation\": \"vertical\",\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"tall\"\n },\n \"thumbnailImageAlignment\": \"right\",\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n },\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"carousel\": {\n \"cardWidth\": \"small\",\n \"cards\": [\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"medium\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n },\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"short\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n },\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n }\n ]\n },\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n },\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"channels\": [\n {\n \"channel\": \"WeChat\",\n \"fallbackAfter\": \"\",\n \"successStatus\": \"Delivered\"\n },\n {\n \"channel\": \"Facebook\",\n \"fallbackAfter\": \"\",\n \"successStatus\": \"Delivered\"\n }\n ],\n \"context\": {\n \"umid\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-659ab385-583b-41bb-8817-a38c960fc24c" }, { "id": "bc3a83a2-915f-4da6-b8ed-65a0899a6455", "name": "Request was not authenticated response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"lineUserId\": \"\",\n \"channelUserId\": \"\"\n },\n \"type\": \"audio\",\n \"content\": {\n \"text\": \"\",\n \"whatsApp\": {\n \"directSend\": {\n \"category\": \"utility\",\n \"ttlSeconds\": \"\"\n }\n },\n \"url\": \"\",\n \"fallbackText\": \"\",\n \"sms\": {\n \"encoding\": \"AUTO\",\n \"source\": \"\"\n },\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"interactive\": {\n \"type\": \"request_contact_info\",\n \"action\": {\n \"button\": \"\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n },\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"catalog_id\": \"\",\n \"product_retailer_id\": \"\",\n \"name\": \"\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ],\n \"product_items\": [\n {\n \"product_retailer_id\": \"\"\n },\n {\n \"product_retailer_id\": \"\"\n }\n ],\n \"title\": \"\"\n }\n ],\n \"parameters\": {\n \"display_text\": \"\",\n \"ttlMinutes\": 10080,\n \"payload\": \"\",\n \"url\": \"\",\n \"flowId\": \"\",\n \"flowCta\": \"\",\n \"flowAction\": \"navigate\",\n \"flowActionPayload\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"in916\": false\n }\n }\n }\n },\n \"header\": {\n \"document\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"image\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"text\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"type\": \"text\",\n \"video\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n }\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n }\n },\n \"video\": {\n \"thumbnail\": \"\",\n \"filesize\": \"\",\n \"duration\": \"\"\n },\n \"image\": {\n \"thumbnail\": \"\"\n },\n \"audio\": {\n \"duration\": \"\"\n },\n \"template\": {\n \"name\": \"\",\n \"language\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"gif\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"ut6\": 86484048.09368029,\n \"ut_4\": \"non dolore anim\",\n \"deserunt_10\": \"ad laboris labore Lorem\",\n \"dolore46b\": 83104166\n }\n },\n \"ttlMinutes\": 10080\n },\n {\n \"type\": \"ttlMinutes\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"irure_d3\": true\n }\n },\n \"ttlMinutes\": 10080\n }\n ],\n \"index\": 0,\n \"subType\": \"VoiceCall\",\n \"cards\": [\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"payload\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"couponCode\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"location\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n }\n ]\n },\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"payload\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"video\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"couponCode\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n }\n ]\n }\n ]\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"ttlMinutes\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"incididuntb4b\": -96275303,\n \"ipsum_91\": \"fugiat\",\n \"eiusmod12\": true,\n \"in_4\": -83906494\n }\n },\n \"ttlMinutes\": 10080\n },\n {\n \"type\": \"couponCode\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"occaecat_3\": \"e\",\n \"voluptate_b8\": 72194666,\n \"minimb2b\": \"in eiusmod\"\n }\n },\n \"ttlMinutes\": 10080\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\",\n \"cards\": [\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"location\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"video\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n }\n ]\n },\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"video\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"text\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n }\n ]\n }\n ]\n }\n ]\n },\n \"richCard\": {\n \"cardOrientation\": \"vertical\",\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"tall\"\n },\n \"thumbnailImageAlignment\": \"right\",\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n },\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"carousel\": {\n \"cardWidth\": \"small\",\n \"cards\": [\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"medium\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n },\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"short\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n },\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n }\n ]\n },\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n },\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"channels\": [\n {\n \"channel\": \"WeChat\",\n \"fallbackAfter\": \"\",\n \"successStatus\": \"Delivered\"\n },\n {\n \"channel\": \"Facebook\",\n \"fallbackAfter\": \"\",\n \"successStatus\": \"Delivered\"\n }\n ],\n \"context\": {\n \"umid\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-bc3a83a2-915f-4da6-b8ed-65a0899a6455" }, { "id": "36e3f083-aaf7-4ee7-9726-e27f048d8f22", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"lineUserId\": \"\",\n \"channelUserId\": \"\"\n },\n \"type\": \"audio\",\n \"content\": {\n \"text\": \"\",\n \"whatsApp\": {\n \"directSend\": {\n \"category\": \"utility\",\n \"ttlSeconds\": \"\"\n }\n },\n \"url\": \"\",\n \"fallbackText\": \"\",\n \"sms\": {\n \"encoding\": \"AUTO\",\n \"source\": \"\"\n },\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"interactive\": {\n \"type\": \"request_contact_info\",\n \"action\": {\n \"button\": \"\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n },\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"catalog_id\": \"\",\n \"product_retailer_id\": \"\",\n \"name\": \"\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ],\n \"product_items\": [\n {\n \"product_retailer_id\": \"\"\n },\n {\n \"product_retailer_id\": \"\"\n }\n ],\n \"title\": \"\"\n }\n ],\n \"parameters\": {\n \"display_text\": \"\",\n \"ttlMinutes\": 10080,\n \"payload\": \"\",\n \"url\": \"\",\n \"flowId\": \"\",\n \"flowCta\": \"\",\n \"flowAction\": \"navigate\",\n \"flowActionPayload\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"in916\": false\n }\n }\n }\n },\n \"header\": {\n \"document\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"image\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"text\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n },\n \"type\": \"text\",\n \"video\": {\n \"id\": \"\",\n \"link\": \"\",\n \"caption\": \"\",\n \"filename\": \"\",\n \"provider\": \"\"\n }\n },\n \"body\": {\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n }\n },\n \"video\": {\n \"thumbnail\": \"\",\n \"filesize\": \"\",\n \"duration\": \"\"\n },\n \"image\": {\n \"thumbnail\": \"\"\n },\n \"audio\": {\n \"duration\": \"\"\n },\n \"template\": {\n \"name\": \"\",\n \"language\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"gif\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"ut6\": 86484048.09368029,\n \"ut_4\": \"non dolore anim\",\n \"deserunt_10\": \"ad laboris labore Lorem\",\n \"dolore46b\": 83104166\n }\n },\n \"ttlMinutes\": 10080\n },\n {\n \"type\": \"ttlMinutes\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"irure_d3\": true\n }\n },\n \"ttlMinutes\": 10080\n }\n ],\n \"index\": 0,\n \"subType\": \"VoiceCall\",\n \"cards\": [\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"payload\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"couponCode\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"location\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n }\n ]\n },\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"payload\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"video\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"couponCode\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n }\n ]\n }\n ]\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"ttlMinutes\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"incididuntb4b\": -96275303,\n \"ipsum_91\": \"fugiat\",\n \"eiusmod12\": true,\n \"in_4\": -83906494\n }\n },\n \"ttlMinutes\": 10080\n },\n {\n \"type\": \"couponCode\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\",\n \"flowActionData\": {\n \"screen\": \"FIRST_ENTRY_SCREEN\",\n \"data\": {\n \"occaecat_3\": \"e\",\n \"voluptate_b8\": 72194666,\n \"minimb2b\": \"in eiusmod\"\n }\n },\n \"ttlMinutes\": 10080\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\",\n \"cards\": [\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"text\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"location\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"video\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n }\n ]\n },\n {\n \"cardIndex\": \"\",\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"document\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"QuickReply\"\n },\n {\n \"type\": \"body\",\n \"parameters\": [\n {\n \"type\": \"video\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n },\n {\n \"type\": \"text\",\n \"text\": \"\",\n \"url\": \"\",\n \"location\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\",\n \"address\": \"\"\n },\n \"payload\": \"\",\n \"couponCode\": \"\"\n }\n ],\n \"index\": 0,\n \"subType\": \"Url\"\n }\n ]\n }\n ]\n }\n ]\n },\n \"richCard\": {\n \"cardOrientation\": \"vertical\",\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"tall\"\n },\n \"thumbnailImageAlignment\": \"right\",\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n },\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"carousel\": {\n \"cardWidth\": \"small\",\n \"cards\": [\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"medium\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n },\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n {\n \"media\": {\n \"contentInfo\": {\n \"fileUrl\": \"\",\n \"thumbnailUrl\": \"\",\n \"forceRefresh\": false\n },\n \"height\": \"short\"\n },\n \"title\": \"\",\n \"description\": \"\",\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n },\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n }\n ]\n },\n \"suggestions\": [\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n },\n {\n \"reply\": {\n \"text\": \"\",\n \"postbackData\": \"\"\n },\n \"action\": {\n \"text\": \"\",\n \"postbackData\": \"\",\n \"fallbackUrl\": \"\",\n \"dialAction\": {\n \"phoneNumber\": \"\"\n },\n \"viewLocationAction\": {\n \"latLong\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n \"label\": \"\",\n \"query\": \"\"\n },\n \"createCalendarEventAction\": {\n \"title\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"description\": \"\"\n },\n \"openUrlAction\": {\n \"url\": \"\",\n \"application\": \"OPEN_URL_APPLICATION_UNSPECIFIED\",\n \"webviewViewMode\": \"FULL\",\n \"description\": \"\"\n }\n }\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"channels\": [\n {\n \"channel\": \"WeChat\",\n \"fallbackAfter\": \"\",\n \"successStatus\": \"Delivered\"\n },\n {\n \"channel\": \"Facebook\",\n \"fallbackAfter\": \"\",\n \"successStatus\": \"Delivered\"\n }\n ],\n \"context\": {\n \"umid\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-36e3f083-aaf7-4ee7-9726-e27f048d8f22" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-64ec81b0-7dd0-485e-9e36-352e36b7b373" } ], "id": "0f535f30-591d-4191-8dc7-6f528501f472", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-0f535f30-591d-4191-8dc7-6f528501f472" }, { "name": "events", "item": [ { "name": "Send Typing Indicator", "id": "98b56a05-b774-4009-999c-f6ddc2bf1846", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"channel\": \"whatsapp\",\n \"type\": \"typing\",\n \"umid\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/events", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "events" ], "variable": [ { "id": "19eb27d8-9efb-488d-b0b0-4b578e6ae1e4", "key": "subAccountId", "value": "R9NaCkLgHIvQsJybeqo9xUk0Ea&9B5R.oGGhwosoeXqg4", "description": "(Required) You must replace *{subAccountId}* with the subaccountid that you want to use. By default this is generated once you signed up with a new account at [https://connect.8x8.com](https://connect.8x8.com)." } ] }, "description": "This endpoint is used to send typing indicators to messaging channels. This allows brands to provide real-time feedback to end users, showing that a response is being composed.\nThe `umid` parameter should reference the unique message ID of an inbound message that you are responding to.\n\n**Important:** Typing indicators can only be sent for inbound messages received within the last 2 hours." }, "response": [ { "id": "019ac4c7-adc4-4272-9871-ef95493acd29", "name": "Request is successful.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"channel\": \"whatsapp\",\n \"type\": \"typing\",\n \"umid\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/events", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "events" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-019ac4c7-adc4-4272-9871-ef95493acd29" }, { "id": "e019e734-501c-42be-a959-4c753cfcb1cf", "name": "Bad request error response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"channel\": \"whatsapp\",\n \"type\": \"typing\",\n \"umid\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/events", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "events" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-e019e734-501c-42be-a959-4c753cfcb1cf" }, { "id": "4da73706-e4a4-4c6c-91da-e204318e0c57", "name": "Request was not authenticated response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"channel\": \"whatsapp\",\n \"type\": \"typing\",\n \"umid\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/events", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "events" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-4da73706-e4a4-4c6c-91da-e204318e0c57" }, { "id": "2e220871-bc87-4ad4-853c-c28068080eb4", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"channel\": \"whatsapp\",\n \"type\": \"typing\",\n \"umid\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/events", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "events" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-2e220871-bc87-4ad4-853c-c28068080eb4" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-98b56a05-b774-4009-999c-f6ddc2bf1846" } ], "id": "180628b7-b7ea-4399-8f25-7279e61dd2d7", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-180628b7-b7ea-4399-8f25-7279e61dd2d7" }, { "name": "lon", "item": [ { "name": "batch", "item": [ { "name": "Send Line Notification message batch", "id": "0b7cc618-eb16-411a-bf51-02ce3b3d3e50", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"messages\": [\n {\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"channelUserId\": \"\"\n },\n \"content\": {\n \"title\": \"\",\n \"company\": \"\",\n \"icon\": \"gear\",\n \"emphasis\": {\n \"label\": \"\",\n \"content\": \"\"\n },\n \"list\": [\n {\n \"label\": \"\",\n \"content\": \"\"\n },\n {\n \"label\": \"\",\n \"content\": \"\"\n }\n ],\n \"greeting\": \"\",\n \"explanation\": \"\",\n \"actions\": [\n {\n \"title\": \"\",\n \"url\": \"\"\n },\n {\n \"title\": \"\",\n \"url\": \"\"\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"smsFallback\": {\n \"text\": \"\",\n \"source\": \"\",\n \"encoding\": \"AUTO\"\n }\n },\n {\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"channelUserId\": \"\"\n },\n \"content\": {\n \"title\": \"\",\n \"company\": \"\",\n \"icon\": \"wallet\",\n \"emphasis\": {\n \"label\": \"\",\n \"content\": \"\"\n },\n \"list\": [\n {\n \"label\": \"\",\n \"content\": \"\"\n },\n {\n \"label\": \"\",\n \"content\": \"\"\n }\n ],\n \"greeting\": \"\",\n \"explanation\": \"\",\n \"actions\": [\n {\n \"title\": \"\",\n \"url\": \"\"\n },\n {\n \"title\": \"\",\n \"url\": \"\"\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"smsFallback\": {\n \"text\": \"\",\n \"source\": \"\",\n \"encoding\": \"UCS2\"\n }\n }\n ],\n \"clientBatchId\": \"\",\n \"includeMessagesInResponse\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/lon/batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "lon", "batch" ], "variable": [ { "id": "5973d659-8d5a-4440-8e45-8df1578be00e", "key": "subAccountId", "value": "R9NaCkLgHIvQsJybeqo9xUk0Ea&9B5R.oGGhwosoeXqg4", "description": "(Required) You must replace *{subAccountId}* with the subaccountid that you want to use. By default this is generated once you signed up with a new account at [https://connect.8x8.com](https://connect.8x8.com)." } ] }, "description": "* This endpoint is used to send Messaging Apps messages by batches (1 request for multiple messages) with personalized contents/properties. \n* It is ideal to send any kind of massive personalized announcement. \n* Using this API, it is possible to send up to 1,000 messages per request." }, "response": [ { "id": "ac8f7d51-5734-41c7-8314-4f210ce48adb", "name": "Success response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"messages\": [\n {\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"channelUserId\": \"\"\n },\n \"content\": {\n \"title\": \"\",\n \"company\": \"\",\n \"icon\": \"gear\",\n \"emphasis\": {\n \"label\": \"\",\n \"content\": \"\"\n },\n \"list\": [\n {\n \"label\": \"\",\n \"content\": \"\"\n },\n {\n \"label\": \"\",\n \"content\": \"\"\n }\n ],\n \"greeting\": \"\",\n \"explanation\": \"\",\n \"actions\": [\n {\n \"title\": \"\",\n \"url\": \"\"\n },\n {\n \"title\": \"\",\n \"url\": \"\"\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"smsFallback\": {\n \"text\": \"\",\n \"source\": \"\",\n \"encoding\": \"AUTO\"\n }\n },\n {\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"channelUserId\": \"\"\n },\n \"content\": {\n \"title\": \"\",\n \"company\": \"\",\n \"icon\": \"wallet\",\n \"emphasis\": {\n \"label\": \"\",\n \"content\": \"\"\n },\n \"list\": [\n {\n \"label\": \"\",\n \"content\": \"\"\n },\n {\n \"label\": \"\",\n \"content\": \"\"\n }\n ],\n \"greeting\": \"\",\n \"explanation\": \"\",\n \"actions\": [\n {\n \"title\": \"\",\n \"url\": \"\"\n },\n {\n \"title\": \"\",\n \"url\": \"\"\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"smsFallback\": {\n \"text\": \"\",\n \"source\": \"\",\n \"encoding\": \"UCS2\"\n }\n }\n ],\n \"clientBatchId\": \"\",\n \"includeMessagesInResponse\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/lon/batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "lon", "batch" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"batchId\": \"\",\n \"acceptedCount\": \"\",\n \"rejectedCount\": \"\",\n \"clientBatchId\": \"\",\n \"messages\": [\n {\n \"status\": {\n \"state\": \"\",\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorMessage\": \"\",\n \"timestamp\": \"\"\n },\n \"umid\": \"\",\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"channelUserId\": \"\"\n },\n \"clientMessageId\": \"\"\n },\n {\n \"status\": {\n \"state\": \"\",\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorMessage\": \"\",\n \"timestamp\": \"\"\n },\n \"umid\": \"\",\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"channelUserId\": \"\"\n },\n \"clientMessageId\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-ac8f7d51-5734-41c7-8314-4f210ce48adb" }, { "id": "959849b9-8587-4fad-851a-0ea9bf46ef33", "name": "Bad request error response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"messages\": [\n {\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"channelUserId\": \"\"\n },\n \"content\": {\n \"title\": \"\",\n \"company\": \"\",\n \"icon\": \"gear\",\n \"emphasis\": {\n \"label\": \"\",\n \"content\": \"\"\n },\n \"list\": [\n {\n \"label\": \"\",\n \"content\": \"\"\n },\n {\n \"label\": \"\",\n \"content\": \"\"\n }\n ],\n \"greeting\": \"\",\n \"explanation\": \"\",\n \"actions\": [\n {\n \"title\": \"\",\n \"url\": \"\"\n },\n {\n \"title\": \"\",\n \"url\": \"\"\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"smsFallback\": {\n \"text\": \"\",\n \"source\": \"\",\n \"encoding\": \"AUTO\"\n }\n },\n {\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"channelUserId\": \"\"\n },\n \"content\": {\n \"title\": \"\",\n \"company\": \"\",\n \"icon\": \"wallet\",\n \"emphasis\": {\n \"label\": \"\",\n \"content\": \"\"\n },\n \"list\": [\n {\n \"label\": \"\",\n \"content\": \"\"\n },\n {\n \"label\": \"\",\n \"content\": \"\"\n }\n ],\n \"greeting\": \"\",\n \"explanation\": \"\",\n \"actions\": [\n {\n \"title\": \"\",\n \"url\": \"\"\n },\n {\n \"title\": \"\",\n \"url\": \"\"\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"smsFallback\": {\n \"text\": \"\",\n \"source\": \"\",\n \"encoding\": \"UCS2\"\n }\n }\n ],\n \"clientBatchId\": \"\",\n \"includeMessagesInResponse\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/lon/batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "lon", "batch" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-959849b9-8587-4fad-851a-0ea9bf46ef33" }, { "id": "b769a230-f153-4130-9e32-4a4ffa991532", "name": "Request was not authenticated response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"messages\": [\n {\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"channelUserId\": \"\"\n },\n \"content\": {\n \"title\": \"\",\n \"company\": \"\",\n \"icon\": \"gear\",\n \"emphasis\": {\n \"label\": \"\",\n \"content\": \"\"\n },\n \"list\": [\n {\n \"label\": \"\",\n \"content\": \"\"\n },\n {\n \"label\": \"\",\n \"content\": \"\"\n }\n ],\n \"greeting\": \"\",\n \"explanation\": \"\",\n \"actions\": [\n {\n \"title\": \"\",\n \"url\": \"\"\n },\n {\n \"title\": \"\",\n \"url\": \"\"\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"smsFallback\": {\n \"text\": \"\",\n \"source\": \"\",\n \"encoding\": \"AUTO\"\n }\n },\n {\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"channelUserId\": \"\"\n },\n \"content\": {\n \"title\": \"\",\n \"company\": \"\",\n \"icon\": \"wallet\",\n \"emphasis\": {\n \"label\": \"\",\n \"content\": \"\"\n },\n \"list\": [\n {\n \"label\": \"\",\n \"content\": \"\"\n },\n {\n \"label\": \"\",\n \"content\": \"\"\n }\n ],\n \"greeting\": \"\",\n \"explanation\": \"\",\n \"actions\": [\n {\n \"title\": \"\",\n \"url\": \"\"\n },\n {\n \"title\": \"\",\n \"url\": \"\"\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"smsFallback\": {\n \"text\": \"\",\n \"source\": \"\",\n \"encoding\": \"UCS2\"\n }\n }\n ],\n \"clientBatchId\": \"\",\n \"includeMessagesInResponse\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/lon/batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "lon", "batch" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-b769a230-f153-4130-9e32-4a4ffa991532" }, { "id": "ca6b0e33-0647-4af1-897f-66295672e893", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"messages\": [\n {\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"channelUserId\": \"\"\n },\n \"content\": {\n \"title\": \"\",\n \"company\": \"\",\n \"icon\": \"gear\",\n \"emphasis\": {\n \"label\": \"\",\n \"content\": \"\"\n },\n \"list\": [\n {\n \"label\": \"\",\n \"content\": \"\"\n },\n {\n \"label\": \"\",\n \"content\": \"\"\n }\n ],\n \"greeting\": \"\",\n \"explanation\": \"\",\n \"actions\": [\n {\n \"title\": \"\",\n \"url\": \"\"\n },\n {\n \"title\": \"\",\n \"url\": \"\"\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"smsFallback\": {\n \"text\": \"\",\n \"source\": \"\",\n \"encoding\": \"AUTO\"\n }\n },\n {\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"channelUserId\": \"\"\n },\n \"content\": {\n \"title\": \"\",\n \"company\": \"\",\n \"icon\": \"wallet\",\n \"emphasis\": {\n \"label\": \"\",\n \"content\": \"\"\n },\n \"list\": [\n {\n \"label\": \"\",\n \"content\": \"\"\n },\n {\n \"label\": \"\",\n \"content\": \"\"\n }\n ],\n \"greeting\": \"\",\n \"explanation\": \"\",\n \"actions\": [\n {\n \"title\": \"\",\n \"url\": \"\"\n },\n {\n \"title\": \"\",\n \"url\": \"\"\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"smsFallback\": {\n \"text\": \"\",\n \"source\": \"\",\n \"encoding\": \"UCS2\"\n }\n }\n ],\n \"clientBatchId\": \"\",\n \"includeMessagesInResponse\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/lon/batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "lon", "batch" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-ca6b0e33-0647-4af1-897f-66295672e893" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-0b7cc618-eb16-411a-bf51-02ce3b3d3e50" } ], "id": "04ffbf3b-dc77-4abe-8d3b-8bd7041a574c", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-04ffbf3b-dc77-4abe-8d3b-8bd7041a574c" }, { "name": "Send Line Notification message", "id": "b9f38724-0ac0-4a54-bb34-e91eefdea824", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"channelUserId\": \"\"\n },\n \"content\": {\n \"title\": \"\",\n \"company\": \"\",\n \"icon\": \"planeDeparture\",\n \"emphasis\": {\n \"label\": \"\",\n \"content\": \"\"\n },\n \"list\": [\n {\n \"label\": \"\",\n \"content\": \"\"\n },\n {\n \"label\": \"\",\n \"content\": \"\"\n }\n ],\n \"greeting\": \"\",\n \"explanation\": \"\",\n \"actions\": [\n {\n \"title\": \"\",\n \"url\": \"\"\n },\n {\n \"title\": \"\",\n \"url\": \"\"\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"smsFallback\": {\n \"text\": \"\",\n \"source\": \"\",\n \"encoding\": \"AUTO\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/lon", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "lon" ], "variable": [ { "id": "272547de-21d5-420b-b85e-9673605c6d6f", "key": "subAccountId", "value": "R9NaCkLgHIvQsJybeqo9xUk0Ea&9B5R.oGGhwosoeXqg4", "description": "(Required) You must replace *{subAccountId}* with the subaccountid that you want to use. By default this is generated once you signed up with a new account at [https://connect.8x8.com](https://connect.8x8.com)." } ] }, "description": "This endpoint is used to send Messaging Apps messages individually (1 request per message).\nIt is ideal to send single personalized messages for use-cases like notifications or alerting for example." }, "response": [ { "id": "afc33e3e-be6f-4a10-b956-8a095d2a0bc1", "name": "Success response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"channelUserId\": \"\"\n },\n \"content\": {\n \"title\": \"\",\n \"company\": \"\",\n \"icon\": \"planeDeparture\",\n \"emphasis\": {\n \"label\": \"\",\n \"content\": \"\"\n },\n \"list\": [\n {\n \"label\": \"\",\n \"content\": \"\"\n },\n {\n \"label\": \"\",\n \"content\": \"\"\n }\n ],\n \"greeting\": \"\",\n \"explanation\": \"\",\n \"actions\": [\n {\n \"title\": \"\",\n \"url\": \"\"\n },\n {\n \"title\": \"\",\n \"url\": \"\"\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"smsFallback\": {\n \"text\": \"\",\n \"source\": \"\",\n \"encoding\": \"AUTO\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/lon", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "lon" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": {\n \"state\": \"\",\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorMessage\": \"\",\n \"timestamp\": \"\"\n },\n \"umid\": \"\",\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"channelUserId\": \"\"\n },\n \"clientMessageId\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-afc33e3e-be6f-4a10-b956-8a095d2a0bc1" }, { "id": "2cd1db55-02a5-471a-aa36-404faac8b659", "name": "Bad request error response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"channelUserId\": \"\"\n },\n \"content\": {\n \"title\": \"\",\n \"company\": \"\",\n \"icon\": \"planeDeparture\",\n \"emphasis\": {\n \"label\": \"\",\n \"content\": \"\"\n },\n \"list\": [\n {\n \"label\": \"\",\n \"content\": \"\"\n },\n {\n \"label\": \"\",\n \"content\": \"\"\n }\n ],\n \"greeting\": \"\",\n \"explanation\": \"\",\n \"actions\": [\n {\n \"title\": \"\",\n \"url\": \"\"\n },\n {\n \"title\": \"\",\n \"url\": \"\"\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"smsFallback\": {\n \"text\": \"\",\n \"source\": \"\",\n \"encoding\": \"AUTO\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/lon", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "lon" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-2cd1db55-02a5-471a-aa36-404faac8b659" }, { "id": "c29e9a58-5118-436d-aaa5-d9825c8e62cc", "name": "Request was not authenticated response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"channelUserId\": \"\"\n },\n \"content\": {\n \"title\": \"\",\n \"company\": \"\",\n \"icon\": \"planeDeparture\",\n \"emphasis\": {\n \"label\": \"\",\n \"content\": \"\"\n },\n \"list\": [\n {\n \"label\": \"\",\n \"content\": \"\"\n },\n {\n \"label\": \"\",\n \"content\": \"\"\n }\n ],\n \"greeting\": \"\",\n \"explanation\": \"\",\n \"actions\": [\n {\n \"title\": \"\",\n \"url\": \"\"\n },\n {\n \"title\": \"\",\n \"url\": \"\"\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"smsFallback\": {\n \"text\": \"\",\n \"source\": \"\",\n \"encoding\": \"AUTO\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/lon", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "lon" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-c29e9a58-5118-436d-aaa5-d9825c8e62cc" }, { "id": "907f68f6-8283-4393-8061-aab71b6e9a52", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"msisdn\": \"\",\n \"country\": \"\",\n \"channelUserId\": \"\"\n },\n \"content\": {\n \"title\": \"\",\n \"company\": \"\",\n \"icon\": \"planeDeparture\",\n \"emphasis\": {\n \"label\": \"\",\n \"content\": \"\"\n },\n \"list\": [\n {\n \"label\": \"\",\n \"content\": \"\"\n },\n {\n \"label\": \"\",\n \"content\": \"\"\n }\n ],\n \"greeting\": \"\",\n \"explanation\": \"\",\n \"actions\": [\n {\n \"title\": \"\",\n \"url\": \"\"\n },\n {\n \"title\": \"\",\n \"url\": \"\"\n }\n ]\n },\n \"clientMessageId\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"smsFallback\": {\n \"text\": \"\",\n \"source\": \"\",\n \"encoding\": \"AUTO\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/lon", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "lon" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-907f68f6-8283-4393-8061-aab71b6e9a52" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-b9f38724-0ac0-4a54-bb34-e91eefdea824" } ], "id": "07a6850f-6672-4d18-8aa0-f10cb47bc44b", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-07a6850f-6672-4d18-8aa0-f10cb47bc44b" }, { "name": "files", "item": [ { "name": "Upload file", "id": "0103716c-60b3-4e13-ab60-8ec50fce5afc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The file. Refer to https://developer.8x8.com/connect/reference/supported-chat-apps-content-type#whatsapp for the accepted file types and sizes.", "key": "file", "value": "[object Object]", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/files", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "files" ], "variable": [ { "id": "c0512ab8-f398-4a02-8fe5-9f2e6d2017c3", "key": "subAccountId", "value": "R9NaCkLgHIvQsJybeqo9xUk0Ea&9B5R.oGGhwosoeXqg4", "description": "(Required) You must replace *{subAccountId}* with the subaccountid that you want to use. By default this is generated once you signed up with a new account at [https://connect.8x8.com](https://connect.8x8.com)." } ] } }, "response": [ { "id": "76f1b631-94ce-40f1-88e0-43669dab7878", "name": "Success response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The file. Refer to https://developer.8x8.com/connect/reference/supported-chat-apps-content-type#whatsapp for the accepted file types and sizes.", "key": "file", "value": "[object Object]", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/files", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "files" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The relative path of the uploaded file. E.g., '/files/a35079cf316.txt?token=CfDJ8OYraJuXjBNOtG3'.", "type": "text/plain" }, "key": "Location", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"fileName\": \"\",\n \"token\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-76f1b631-94ce-40f1-88e0-43669dab7878" }, { "id": "92114547-66fe-494f-a357-3f084b7e8295", "name": "Bad request error response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The file. Refer to https://developer.8x8.com/connect/reference/supported-chat-apps-content-type#whatsapp for the accepted file types and sizes.", "key": "file", "value": "[object Object]", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/files", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "files" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-92114547-66fe-494f-a357-3f084b7e8295" }, { "id": "3b9da9ca-680e-4f7b-b961-37c4fb370f83", "name": "Request was not authenticated response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The file. Refer to https://developer.8x8.com/connect/reference/supported-chat-apps-content-type#whatsapp for the accepted file types and sizes.", "key": "file", "value": "[object Object]", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/files", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "files" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-3b9da9ca-680e-4f7b-b961-37c4fb370f83" }, { "id": "2fced351-6bbd-4863-91d1-3720730d4c60", "name": "Payload too large", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The file. Refer to https://developer.8x8.com/connect/reference/supported-chat-apps-content-type#whatsapp for the accepted file types and sizes.", "key": "file", "value": "[object Object]", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/files", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "files" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Request Entity Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-2fced351-6bbd-4863-91d1-3720730d4c60" }, { "id": "b6221cf8-fed8-4480-b991-0ffeb4471a59", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The file. Refer to https://developer.8x8.com/connect/reference/supported-chat-apps-content-type#whatsapp for the accepted file types and sizes.", "key": "file", "value": "[object Object]", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/files", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "files" ], "variable": [ { "key": "subAccountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-b6221cf8-fed8-4480-b991-0ffeb4471a59" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-0103716c-60b3-4e13-ab60-8ec50fce5afc" } ], "id": "ff252a21-d1ef-4908-9e82-1d9297ca561f", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-ff252a21-d1ef-4908-9e82-1d9297ca561f" } ], "id": "8e2cc8e4-d0a7-4625-af95-1c4a2bdf36bd", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-8e2cc8e4-d0a7-4625-af95-1c4a2bdf36bd" } ], "id": "232cef8b-16a2-4e8d-b56a-c9467313c5c2", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-232cef8b-16a2-4e8d-b56a-c9467313c5c2" }, { "name": "accounts", "item": [ { "name": "{accountId}", "item": [ { "name": "channels", "item": [ { "name": "{channelId}", "item": [ { "name": "templates", "item": [ { "name": "{templateName}", "item": [ { "name": "Remove WhatsApp template", "id": "512cb79e-37a7-47c2-8ad7-9d48e5e1d4f6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/templates/:templateName", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "templates", ":templateName" ], "variable": [ { "id": "84c75061-bf4a-45c3-9ffe-0a345bd1b2b8", "key": "accountId", "value": "", "description": "(Required) " }, { "id": "03433f52-bdcc-4322-adaf-339614401450", "key": "channelId", "value": "", "description": "(Required) " }, { "id": "a0feb316-5395-4917-a226-c5e990ef0d50", "key": "templateName", "value": "", "description": "(Required) " } ] }, "description": "This endpoint is used to remove an existing WhatsApp message template.\n\nWhatsApp Message Templates are message formats for common reusable messages a business may want to send. \nBusinesses must use Message Templates for sending notifications to customers.\nAny message sent outside the 24h customer service window, needs to be a template message, to be delivered. \nAdvertising, marketing, or promotional messages are not permitted." }, "response": [ { "id": "7a0815eb-9a92-479b-8a79-9e91edab2c1c", "name": "New Response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/templates/:templateName", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "templates", ":templateName" ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "templateName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-7a0815eb-9a92-479b-8a79-9e91edab2c1c" }, { "id": "7323013a-971f-42a2-8c33-ea30b2584342", "name": "Bad request error response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/templates/:templateName", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "templates", ":templateName" ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "templateName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-7323013a-971f-42a2-8c33-ea30b2584342" }, { "id": "ede23040-e681-4470-b436-9f4d1522a525", "name": "Request was not authenticated response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/templates/:templateName", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "templates", ":templateName" ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "templateName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-ede23040-e681-4470-b436-9f4d1522a525" }, { "id": "95549015-2d13-4c28-bf6e-3bf3c97af824", "name": "Internal server error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/templates/:templateName", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "templates", ":templateName" ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "templateName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-95549015-2d13-4c28-bf6e-3bf3c97af824" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-512cb79e-37a7-47c2-8ad7-9d48e5e1d4f6" } ], "id": "3452a21d-aaca-4769-a354-9e0b5128713e", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-3452a21d-aaca-4769-a354-9e0b5128713e" }, { "name": "Get WhatsApp templates", "id": "a59d6802-0265-43f5-ac44-b626fb45727b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "templates" ], "variable": [ { "id": "76322a0d-dc1e-4596-a75a-84b4d984f720", "key": "accountId", "value": "D4BFEC40-43bE7d3A-DEDaBc0Aa3230eB4", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." }, { "id": "d76206c2-3b42-4a80-b629-cb497348e776", "key": "channelId", "value": "", "description": "(Required) Channel identifier" } ] }, "description": "This endpoint is used to get your registered WhatsApp message template and their approval status. \n\nWhatsApp Message Templates are message formats for common reusable messages a business may want to send. \nBusinesses must use Message Templates for sending notifications to customers.\nAny message sent outside the 24h customer service window, needs to be a template message, to be delivered. \nAdvertising, marketing, or promotional messages are not permitted." }, "response": [ { "id": "ff20b682-de2e-41ae-9717-a3dc6b6d8a02", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "templates" ], "variable": [ { "key": "accountId" }, { "key": "channelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"templates\": [\n {\n \"channelId\": \"\",\n \"channelName\": \"\",\n \"templateName\": \"\",\n \"language\": \"\",\n \"languageName\": \"\",\n \"components\": [\n {\n \"type\": \"BODY\",\n \"format\": \"Image\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"FLOW\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n },\n {\n \"type\": \"PHONE_NUMBER\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n }\n ],\n \"example\": {\n \"headerText\": [\n \"\",\n \"\"\n ],\n \"bodyText\": [\n \"\",\n \"\"\n ],\n \"headerHandle\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"type\": \"BODY\",\n \"format\": \"Document\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"COPY_CODE\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n },\n {\n \"type\": \"REQUEST_CONTACT_INFO\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n }\n ],\n \"example\": {\n \"headerText\": [\n \"\",\n \"\"\n ],\n \"bodyText\": [\n \"\",\n \"\"\n ],\n \"headerHandle\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"category\": \"\",\n \"categoryName\": \"\",\n \"status\": \"\",\n \"statusName\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"channelId\": \"\",\n \"channelName\": \"\",\n \"templateName\": \"\",\n \"language\": \"\",\n \"languageName\": \"\",\n \"components\": [\n {\n \"type\": \"BODY\",\n \"format\": \"Document\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"PHONE_NUMBER\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n }\n ],\n \"example\": {\n \"headerText\": [\n \"\",\n \"\"\n ],\n \"bodyText\": [\n \"\",\n \"\"\n ],\n \"headerHandle\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"type\": \"BODY\",\n \"format\": \"Location\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"COPY_CODE\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n }\n ],\n \"example\": {\n \"headerText\": [\n \"\",\n \"\"\n ],\n \"bodyText\": [\n \"\",\n \"\"\n ],\n \"headerHandle\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"category\": \"\",\n \"categoryName\": \"\",\n \"status\": \"\",\n \"statusName\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-ff20b682-de2e-41ae-9717-a3dc6b6d8a02" }, { "id": "f07719be-0135-41b2-ab60-43f2457eaa3d", "name": "Request was not authenticated response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "templates" ], "variable": [ { "key": "accountId" }, { "key": "channelId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-f07719be-0135-41b2-ab60-43f2457eaa3d" }, { "id": "57b179cf-5851-438f-94c0-c86bda32029c", "name": "Internal server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "templates" ], "variable": [ { "key": "accountId" }, { "key": "channelId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-57b179cf-5851-438f-94c0-c86bda32029c" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-a59d6802-0265-43f5-ac44-b626fb45727b" }, { "name": "Add WhatsApp template", "id": "1d8a3d08-e5f4-4a8a-9859-1c412cb0c3e7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"language\": \"\",\n \"name\": \"\",\n \"category\": \"\",\n \"components\": [\n {\n \"type\": \"BODY\",\n \"format\": \"Video\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ],\n \"add_security_recommendation\": \"\",\n \"code_expiration_minutes\": 5,\n \"cards\": [\n {\n \"type\": \"BODY\",\n \"format\": \"Image\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"OTP\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"BODY\",\n \"format\": \"Video\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"PHONE_NUMBER\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"COPY_CODE\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"type\": \"BODY\",\n \"format\": \"Gif\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"PHONE_NUMBER\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ],\n \"add_security_recommendation\": \"\",\n \"code_expiration_minutes\": 5,\n \"cards\": [\n {\n \"type\": \"BODY\",\n \"format\": \"Video\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"OTP\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"BODY\",\n \"format\": \"Image\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"OTP\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ],\n \"allow_category_change\": true,\n \"message_send_ttl_seconds\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "templates" ], "variable": [ { "id": "5ab5ef7d-bd8e-47fc-bde8-f9a536f44bbb", "key": "accountId", "value": "D4BFEC40-43bE7d3A-DEDaBc0Aa3230eB4", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." }, { "id": "5bf52c97-1c68-4f76-8dc4-c4ab66773186", "key": "channelId", "value": "", "description": "(Required) Channel identifier" } ] }, "description": "This endpoint is used to register new WhatsApp message template.\n\nPlease note that special html entities should be unescaped.\n\nWhatsApp Message Templates are message formats for common reusable messages a business may want to send. \nBusinesses must use Message Templates for sending notifications to customers.\nAny message sent outside the 24h customer service window, needs to be a template message, to be delivered. \nAdvertising, marketing, or promotional messages are not permitted." }, "response": [ { "id": "52a01ed5-4b58-4ee4-a5b7-a3102440cf34", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"language\": \"\",\n \"name\": \"\",\n \"category\": \"\",\n \"components\": [\n {\n \"type\": \"BODY\",\n \"format\": \"Video\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ],\n \"add_security_recommendation\": \"\",\n \"code_expiration_minutes\": 5,\n \"cards\": [\n {\n \"type\": \"BODY\",\n \"format\": \"Image\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"OTP\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"BODY\",\n \"format\": \"Video\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"PHONE_NUMBER\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"COPY_CODE\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"type\": \"BODY\",\n \"format\": \"Gif\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"PHONE_NUMBER\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ],\n \"add_security_recommendation\": \"\",\n \"code_expiration_minutes\": 5,\n \"cards\": [\n {\n \"type\": \"BODY\",\n \"format\": \"Video\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"OTP\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"BODY\",\n \"format\": \"Image\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"OTP\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ],\n \"allow_category_change\": true,\n \"message_send_ttl_seconds\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "templates" ], "variable": [ { "key": "accountId" }, { "key": "channelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-52a01ed5-4b58-4ee4-a5b7-a3102440cf34" }, { "id": "2dd3dd8b-32d5-429f-84a8-2b4f62d2aad7", "name": "Bad request error response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"language\": \"\",\n \"name\": \"\",\n \"category\": \"\",\n \"components\": [\n {\n \"type\": \"BODY\",\n \"format\": \"Video\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ],\n \"add_security_recommendation\": \"\",\n \"code_expiration_minutes\": 5,\n \"cards\": [\n {\n \"type\": \"BODY\",\n \"format\": \"Image\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"OTP\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"BODY\",\n \"format\": \"Video\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"PHONE_NUMBER\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"COPY_CODE\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"type\": \"BODY\",\n \"format\": \"Gif\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"PHONE_NUMBER\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ],\n \"add_security_recommendation\": \"\",\n \"code_expiration_minutes\": 5,\n \"cards\": [\n {\n \"type\": \"BODY\",\n \"format\": \"Video\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"OTP\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"BODY\",\n \"format\": \"Image\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"OTP\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ],\n \"allow_category_change\": true,\n \"message_send_ttl_seconds\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "templates" ], "variable": [ { "key": "accountId" }, { "key": "channelId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-2dd3dd8b-32d5-429f-84a8-2b4f62d2aad7" }, { "id": "c1030fdd-4348-4725-af1b-4285f36479fa", "name": "Request was not authenticated response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"language\": \"\",\n \"name\": \"\",\n \"category\": \"\",\n \"components\": [\n {\n \"type\": \"BODY\",\n \"format\": \"Video\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ],\n \"add_security_recommendation\": \"\",\n \"code_expiration_minutes\": 5,\n \"cards\": [\n {\n \"type\": \"BODY\",\n \"format\": \"Image\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"OTP\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"BODY\",\n \"format\": \"Video\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"PHONE_NUMBER\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"COPY_CODE\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"type\": \"BODY\",\n \"format\": \"Gif\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"PHONE_NUMBER\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ],\n \"add_security_recommendation\": \"\",\n \"code_expiration_minutes\": 5,\n \"cards\": [\n {\n \"type\": \"BODY\",\n \"format\": \"Video\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"OTP\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"BODY\",\n \"format\": \"Image\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"OTP\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ],\n \"allow_category_change\": true,\n \"message_send_ttl_seconds\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "templates" ], "variable": [ { "key": "accountId" }, { "key": "channelId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-c1030fdd-4348-4725-af1b-4285f36479fa" }, { "id": "74ddcc07-f129-4b46-881e-8bc8c3b1e051", "name": "Template name cannot be reused within 30 days of deletion", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"language\": \"\",\n \"name\": \"\",\n \"category\": \"\",\n \"components\": [\n {\n \"type\": \"BODY\",\n \"format\": \"Video\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ],\n \"add_security_recommendation\": \"\",\n \"code_expiration_minutes\": 5,\n \"cards\": [\n {\n \"type\": \"BODY\",\n \"format\": \"Image\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"OTP\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"BODY\",\n \"format\": \"Video\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"PHONE_NUMBER\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"COPY_CODE\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"type\": \"BODY\",\n \"format\": \"Gif\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"PHONE_NUMBER\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ],\n \"add_security_recommendation\": \"\",\n \"code_expiration_minutes\": 5,\n \"cards\": [\n {\n \"type\": \"BODY\",\n \"format\": \"Video\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"OTP\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"BODY\",\n \"format\": \"Image\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"OTP\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ],\n \"allow_category_change\": true,\n \"message_send_ttl_seconds\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "templates" ], "variable": [ { "key": "accountId" }, { "key": "channelId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-74ddcc07-f129-4b46-881e-8bc8c3b1e051" }, { "id": "a1d01074-b349-472c-816f-504e190751ee", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"language\": \"\",\n \"name\": \"\",\n \"category\": \"\",\n \"components\": [\n {\n \"type\": \"BODY\",\n \"format\": \"Video\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ],\n \"add_security_recommendation\": \"\",\n \"code_expiration_minutes\": 5,\n \"cards\": [\n {\n \"type\": \"BODY\",\n \"format\": \"Image\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"OTP\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"BODY\",\n \"format\": \"Video\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"PHONE_NUMBER\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"COPY_CODE\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"type\": \"BODY\",\n \"format\": \"Gif\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"PHONE_NUMBER\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ],\n \"flowId\": \"\",\n \"flowAction\": \"navigate\",\n \"navigateScreen\": \"FIRST_ENTRY_SCREEN\",\n \"ttlMinutes\": \"\"\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ],\n \"add_security_recommendation\": \"\",\n \"code_expiration_minutes\": 5,\n \"cards\": [\n {\n \"type\": \"BODY\",\n \"format\": \"Video\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"OTP\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"BODY\",\n \"format\": \"Image\",\n \"text\": \"\",\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"OTP\",\n \"text\": \"\",\n \"phoneNumber\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"example\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"examples\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ],\n \"allow_category_change\": true,\n \"message_send_ttl_seconds\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "templates" ], "variable": [ { "key": "accountId" }, { "key": "channelId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-a1d01074-b349-472c-816f-504e190751ee" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-1d8a3d08-e5f4-4a8a-9859-1c412cb0c3e7" } ], "id": "dafe351f-0198-4679-8d11-3578eec03a8c", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-dafe351f-0198-4679-8d11-3578eec03a8c" }, { "name": "flows", "item": [ { "name": "{flowId}", "item": [ { "name": "preview", "item": [ { "name": "Preview WhatsApp Flow", "id": "0651e809-df30-4931-b677-713d8a25b3e3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId/preview?refresh=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId", "preview" ], "query": [ { "description": "Set to `true` to force Meta to regenerate the preview. Defaults to `false`.", "key": "refresh", "value": "false" } ], "variable": [ { "id": "11ed4ef6-fe15-4315-9a5c-78c9eb290db8", "key": "accountId", "value": "ca343dCB-Ec9e-4094b0bdfD99FC0E1DC3", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." }, { "id": "a0279705-6979-4249-9ae0-1432bbe378ec", "key": "channelId", "value": "", "description": "(Required) Channel identifier" }, { "id": "e25790db-3852-47e9-aa4b-2b07e810dc9e", "key": "flowId", "value": "", "description": "(Required) Flow identifier" } ] }, "description": "This endpoint is used to generate a preview URL for a WhatsApp Flow.\n\nThe preview allows you to visualize and interact with your flow before publishing it. You can force regeneration of the preview by setting the `refresh` query parameter to `true`.\n\nFor interactive previews with custom parameters, you can add query parameters to the generated preview URL. For a list of supported query parameters, refer to the 'Visualizing and interacting with your Flow using the Web Preview' section of the [WhatsApp Flows API documentation](https://developers.facebook.com/docs/whatsapp/flows/reference/flowsapi)." }, "response": [ { "id": "aee37051-4138-4add-9345-22507b8ca210", "name": "Preview URL generated successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId/preview?refresh=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId", "preview" ], "query": [ { "description": "Set to `true` to force Meta to regenerate the preview. Defaults to `false`.", "key": "refresh", "value": "false" } ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "flowId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"preview_url\": \"\",\n \"expires_at\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-aee37051-4138-4add-9345-22507b8ca210" }, { "id": "191d0fc7-b45f-4d1d-bbe8-624527635c92", "name": "Bad request error response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId/preview?refresh=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId", "preview" ], "query": [ { "description": "Set to `true` to force Meta to regenerate the preview. Defaults to `false`.", "key": "refresh", "value": "false" } ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "flowId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-191d0fc7-b45f-4d1d-bbe8-624527635c92" }, { "id": "1a01dc83-1297-4707-8323-4bab84861d0e", "name": "Request was not authenticated response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId/preview?refresh=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId", "preview" ], "query": [ { "description": "Set to `true` to force Meta to regenerate the preview. Defaults to `false`.", "key": "refresh", "value": "false" } ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "flowId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-1a01dc83-1297-4707-8323-4bab84861d0e" }, { "id": "d083229b-474e-4da0-974e-7ec71b31e4f9", "name": "Internal server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId/preview?refresh=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId", "preview" ], "query": [ { "description": "Set to `true` to force Meta to regenerate the preview. Defaults to `false`.", "key": "refresh", "value": "false" } ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "flowId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-d083229b-474e-4da0-974e-7ec71b31e4f9" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-0651e809-df30-4931-b677-713d8a25b3e3" } ], "id": "f427a76d-7a1d-4903-8c7f-189241c77d18", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-f427a76d-7a1d-4903-8c7f-189241c77d18" }, { "name": "publish", "item": [ { "name": "Publish WhatsApp Flow", "id": "7e960fd7-d057-4ee1-afe7-a99acde828cf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId/publish", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId", "publish" ], "variable": [ { "id": "d0c0bfe8-b9af-48d7-95c7-9b9aab45ab05", "key": "accountId", "value": "ca343dCB-Ec9e-4094b0bdfD99FC0E1DC3", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." }, { "id": "368e4f6f-d6af-44f9-aeb3-a4187e7026e9", "key": "channelId", "value": "", "description": "(Required) Channel identifier" }, { "id": "70508c4d-d953-42da-85ed-1948f7e7eb83", "key": "flowId", "value": "", "description": "(Required) Flow identifier" } ] }, "description": "This endpoint is used to publish a WhatsApp Flow.\n\nPublishing a flow makes it available for use in WhatsApp conversations. Once published, the flow can be sent to customers through WhatsApp messages(Template message and Interactive messages). A flow must be in DRAFT status and pass all validations before it can be published." }, "response": [ { "id": "da276e32-2cb6-4655-ba8c-89946dd6d682", "name": "Flow published successfully. No response body is returned.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId/publish", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId", "publish" ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "flowId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-da276e32-2cb6-4655-ba8c-89946dd6d682" }, { "id": "2d0a66a6-a533-433a-80cd-f749024c541e", "name": "Bad request error response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId/publish", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId", "publish" ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "flowId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-2d0a66a6-a533-433a-80cd-f749024c541e" }, { "id": "8f5b5997-c795-4734-8d38-b84bce99ca4f", "name": "Request was not authenticated response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId/publish", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId", "publish" ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "flowId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-8f5b5997-c795-4734-8d38-b84bce99ca4f" }, { "id": "272f6aea-dd34-43ab-bb96-f96404a1acf1", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId/publish", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId", "publish" ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "flowId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-272f6aea-dd34-43ab-bb96-f96404a1acf1" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-7e960fd7-d057-4ee1-afe7-a99acde828cf" } ], "id": "6b83edfd-6ca5-4ba9-a9e9-a15b50fb3872", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-6b83edfd-6ca5-4ba9-a9e9-a15b50fb3872" }, { "name": "deprecate", "item": [ { "name": "Deprecate WhatsApp Flow", "id": "f8d2807b-333b-406e-94f0-9786f76c10fc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId/deprecate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId", "deprecate" ], "variable": [ { "id": "36fc98a0-b09f-437c-8bf4-39e81f951296", "key": "accountId", "value": "ca343dCB-Ec9e-4094b0bdfD99FC0E1DC3", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." }, { "id": "628f9b42-fd5c-4666-b24f-fc3bb93da951", "key": "channelId", "value": "", "description": "(Required) Channel identifier" }, { "id": "4c417fb3-c73b-49bc-8abd-afef61afbb0d", "key": "flowId", "value": "", "description": "(Required) Flow identifier" } ] }, "description": "This endpoint is used to deprecate a WhatsApp Flow.\n\nDeprecating a flow marks it as no longer recommended for use, but keeps it accessible for existing integrations. This allows you to phase out a flow gracefully without breaking active implementations. Once deprecated, the flow status will be updated to reflect its deprecated state." }, "response": [ { "id": "82fc5eb3-eee7-40ca-b675-ca6a192e2f21", "name": "Flow deprecated successfully. No response body is returned.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId/deprecate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId", "deprecate" ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "flowId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-82fc5eb3-eee7-40ca-b675-ca6a192e2f21" }, { "id": "f25b6d79-afb9-40c8-af9d-a0fb24735cb1", "name": "Bad request error response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId/deprecate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId", "deprecate" ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "flowId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-f25b6d79-afb9-40c8-af9d-a0fb24735cb1" }, { "id": "6fbbcf54-2bd7-4348-ab1a-602881f5b866", "name": "Request was not authenticated response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId/deprecate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId", "deprecate" ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "flowId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-6fbbcf54-2bd7-4348-ab1a-602881f5b866" }, { "id": "fa6e0358-ffc2-4701-b823-23f6f0eeae74", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId/deprecate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId", "deprecate" ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "flowId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-fa6e0358-ffc2-4701-b823-23f6f0eeae74" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-f8d2807b-333b-406e-94f0-9786f76c10fc" } ], "id": "87cd16bb-1114-4030-a090-4c6427c8c8eb", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-87cd16bb-1114-4030-a090-4c6427c8c8eb" }, { "name": "Get WhatsApp Flow details", "id": "8b8405f1-9800-465c-96eb-3f8aefbf8f8b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId" ], "variable": [ { "id": "b72ba671-dc36-4128-a5a8-a21bc3addc26", "key": "accountId", "value": "ca343dCB-Ec9e-4094b0bdfD99FC0E1DC3", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." }, { "id": "10dcc485-8561-4e51-a4d8-8f4bd5831aaa", "key": "channelId", "value": "", "description": "(Required) Channel identifier" }, { "id": "65b03fdc-3e40-4920-ab10-bc3212267703", "key": "flowId", "value": "", "description": "(Required) Flow identifier" } ] }, "description": "This endpoint is used to retrieve details of a specific WhatsApp Flow.\n\nWhatsApp Flows are interactive experiences that businesses can use to collect information from customers through WhatsApp conversations. This endpoint returns comprehensive information about a flow including its current status, validation errors, and flow JSON URL." }, "response": [ { "id": "e8282953-f243-40c4-96e0-a2036c2cbf8b", "name": "Flow details retrieved successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId" ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "flowId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"flowId\": \"\",\n \"flowJsonUrl\": \"\",\n \"name\": \"\",\n \"status\": \"PUBLISHED\",\n \"categories\": [\n \"SURVEY\",\n \"APPOINTMENT_BOOKING\"\n ],\n \"validationErrors\": [\n {\n \"error\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"lineStart\": \"\",\n \"lineEnd\": \"\",\n \"columnStart\": \"\",\n \"columnEnd\": \"\",\n \"pointers\": [\n {\n \"lineStart\": \"\",\n \"lineEnd\": \"\",\n \"columnStart\": \"\",\n \"columnEnd\": \"\",\n \"path\": \"\"\n },\n {\n \"lineStart\": \"\",\n \"lineEnd\": \"\",\n \"columnStart\": \"\",\n \"columnEnd\": \"\",\n \"path\": \"\"\n }\n ]\n },\n {\n \"error\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"lineStart\": \"\",\n \"lineEnd\": \"\",\n \"columnStart\": \"\",\n \"columnEnd\": \"\",\n \"pointers\": [\n {\n \"lineStart\": \"\",\n \"lineEnd\": \"\",\n \"columnStart\": \"\",\n \"columnEnd\": \"\",\n \"path\": \"\"\n },\n {\n \"lineStart\": \"\",\n \"lineEnd\": \"\",\n \"columnStart\": \"\",\n \"columnEnd\": \"\",\n \"path\": \"\"\n }\n ]\n }\n ]\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-e8282953-f243-40c4-96e0-a2036c2cbf8b" }, { "id": "a963d7c0-9d31-47df-bf29-c436e7c03b75", "name": "Bad request error response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId" ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "flowId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-a963d7c0-9d31-47df-bf29-c436e7c03b75" }, { "id": "7f75afa9-ea40-41af-901f-5b98ab3a8b34", "name": "Request was not authenticated response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId" ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "flowId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-7f75afa9-ea40-41af-901f-5b98ab3a8b34" }, { "id": "455375bf-120c-4c3a-a42c-dd8e72c40404", "name": "Internal server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId" ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "flowId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-455375bf-120c-4c3a-a42c-dd8e72c40404" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-8b8405f1-9800-465c-96eb-3f8aefbf8f8b" }, { "name": "Update WhatsApp Flow", "id": "9379bf44-5bca-438e-b2cf-78f4bd67a306", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"categories\": [\n \"CONTACT_US\",\n \"OTHER\"\n ],\n \"publish\": false,\n \"flowJson\": \"\",\n \"cloneFlowId\": \"\",\n \"endPointUri\": \"\",\n \"applicationId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId" ], "variable": [ { "id": "8525fb65-aad5-4894-95f9-9e988d20e2bc", "key": "accountId", "value": "ca343dCB-Ec9e-4094b0bdfD99FC0E1DC3", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." }, { "id": "46c92d30-e9d7-484b-bc55-34699f5dc432", "key": "channelId", "value": "", "description": "(Required) Channel identifier" }, { "id": "94733a24-39bd-4a97-b652-42546a135e96", "key": "flowId", "value": "", "description": "(Required) Flow identifier" } ] }, "description": "This endpoint is used to update an existing WhatsApp Flow. The flow must be in draft state.\n\nWhatsApp Flows are interactive experiences that businesses can use to collect information from customers through WhatsApp conversations. This endpoint allows you to update flow properties including name, categories, flow JSON definition, endpoint URI, and application ID.\n\nAt least one property must be present in the request body." }, "response": [ { "id": "0dbcc441-49d4-4225-bd05-e20e7dfeedd7", "name": "Flow updated successfully", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"categories\": [\n \"CONTACT_US\",\n \"OTHER\"\n ],\n \"publish\": false,\n \"flowJson\": \"\",\n \"cloneFlowId\": \"\",\n \"endPointUri\": \"\",\n \"applicationId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId" ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "flowId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"success\": \"\",\n \"validationErrors\": [\n {\n \"error\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"lineStart\": \"\",\n \"lineEnd\": \"\",\n \"columnStart\": \"\",\n \"columnEnd\": \"\",\n \"pointers\": [\n {\n \"lineStart\": \"\",\n \"lineEnd\": \"\",\n \"columnStart\": \"\",\n \"columnEnd\": \"\",\n \"path\": \"\"\n },\n {\n \"lineStart\": \"\",\n \"lineEnd\": \"\",\n \"columnStart\": \"\",\n \"columnEnd\": \"\",\n \"path\": \"\"\n }\n ]\n },\n {\n \"error\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"lineStart\": \"\",\n \"lineEnd\": \"\",\n \"columnStart\": \"\",\n \"columnEnd\": \"\",\n \"pointers\": [\n {\n \"lineStart\": \"\",\n \"lineEnd\": \"\",\n \"columnStart\": \"\",\n \"columnEnd\": \"\",\n \"path\": \"\"\n },\n {\n \"lineStart\": \"\",\n \"lineEnd\": \"\",\n \"columnStart\": \"\",\n \"columnEnd\": \"\",\n \"path\": \"\"\n }\n ]\n }\n ]\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-0dbcc441-49d4-4225-bd05-e20e7dfeedd7" }, { "id": "2e17ea1d-2217-4b5b-93c5-99fa4595d7b8", "name": "Bad request error response", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"categories\": [\n \"CONTACT_US\",\n \"OTHER\"\n ],\n \"publish\": false,\n \"flowJson\": \"\",\n \"cloneFlowId\": \"\",\n \"endPointUri\": \"\",\n \"applicationId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId" ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "flowId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-2e17ea1d-2217-4b5b-93c5-99fa4595d7b8" }, { "id": "8c535387-cf93-4b87-9161-baa2eae8f7d6", "name": "Request was not authenticated response", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"categories\": [\n \"CONTACT_US\",\n \"OTHER\"\n ],\n \"publish\": false,\n \"flowJson\": \"\",\n \"cloneFlowId\": \"\",\n \"endPointUri\": \"\",\n \"applicationId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId" ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "flowId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-8c535387-cf93-4b87-9161-baa2eae8f7d6" }, { "id": "147a0c3f-e5e7-43b6-8f1b-ec525c3429ff", "name": "Internal server error", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"categories\": [\n \"CONTACT_US\",\n \"OTHER\"\n ],\n \"publish\": false,\n \"flowJson\": \"\",\n \"cloneFlowId\": \"\",\n \"endPointUri\": \"\",\n \"applicationId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId" ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "flowId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-147a0c3f-e5e7-43b6-8f1b-ec525c3429ff" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-9379bf44-5bca-438e-b2cf-78f4bd67a306" }, { "name": "Delete WhatsApp Flow", "id": "d0a0a5c1-73cb-496b-afe8-54c2c51e0af5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId" ], "variable": [ { "id": "5ccf55c0-8555-4a71-861b-897d7d41608c", "key": "accountId", "value": "ca343dCB-Ec9e-4094b0bdfD99FC0E1DC3", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." }, { "id": "6f9e30d0-dcfa-4836-84bb-80ff00c18f76", "key": "channelId", "value": "", "description": "(Required) Channel identifier" }, { "id": "bd384945-5c1c-408d-a55e-c7ab08791f5e", "key": "flowId", "value": "", "description": "(Required) Flow identifier" } ] }, "description": "This endpoint is used to delete a WhatsApp Flow.\n\nOnly flows that are not published can be deleted. If a flow has been published, it cannot be deleted and the API will return an error. This operation is permanent and cannot be undone." }, "response": [ { "id": "b17d53de-ea81-40c0-b979-88642aca3744", "name": "Flow deleted successfully. No response body is returned.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId" ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "flowId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-b17d53de-ea81-40c0-b979-88642aca3744" }, { "id": "0ee6d562-c890-4619-b1d9-74ba3dc3f65c", "name": "Bad request error response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId" ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "flowId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-0ee6d562-c890-4619-b1d9-74ba3dc3f65c" }, { "id": "d8704016-23f1-4ab3-a087-2b0756c71154", "name": "Request was not authenticated response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId" ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "flowId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-d8704016-23f1-4ab3-a087-2b0756c71154" }, { "id": "d7925449-7481-4bbb-936d-99f0a1fe236e", "name": "Internal server error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows", ":flowId" ], "variable": [ { "key": "accountId" }, { "key": "channelId" }, { "key": "flowId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-d7925449-7481-4bbb-936d-99f0a1fe236e" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-d0a0a5c1-73cb-496b-afe8-54c2c51e0af5" } ], "id": "2f62a532-1ab1-4955-a0d2-ee1f0ccf6bb6", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-2f62a532-1ab1-4955-a0d2-ee1f0ccf6bb6" }, { "name": "Get WhatsApp Flows", "id": "6c4e5392-ffde-42b5-82d4-6cadeef57bcd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows?limit=100", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows" ], "query": [ { "description": "Maximum number of flows to return", "key": "limit", "value": "100" } ], "variable": [ { "id": "2b8dbabc-a987-4b03-a347-76c420668f5c", "key": "accountId", "value": "ca343dCB-Ec9e-4094b0bdfD99FC0E1DC3", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." }, { "id": "79d35754-ea04-4d9f-8ad4-246ff8d79094", "key": "channelId", "value": "", "description": "(Required) Channel identifier" } ] }, "description": "This endpoint is used to retrieve the list of WhatsApp Flows and their status for the channel." }, "response": [ { "id": "1a8baba6-63a0-4f84-9834-06e3b3c34fed", "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows?limit=100", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows" ], "query": [ { "description": "Maximum number of flows to return", "key": "limit", "value": "100" } ], "variable": [ { "key": "accountId" }, { "key": "channelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"flows\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"PUBLISHED\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"DEPRECATED\"\n }\n ]\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-1a8baba6-63a0-4f84-9834-06e3b3c34fed" }, { "id": "79e9c2ec-039a-45b5-b1f3-01a58adfb539", "name": "Request was not authenticated response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows?limit=100", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows" ], "query": [ { "description": "Maximum number of flows to return", "key": "limit", "value": "100" } ], "variable": [ { "key": "accountId" }, { "key": "channelId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-79e9c2ec-039a-45b5-b1f3-01a58adfb539" }, { "id": "65030a79-6737-4cfc-9b58-ba4b95b400db", "name": "Internal server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows?limit=100", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows" ], "query": [ { "description": "Maximum number of flows to return", "key": "limit", "value": "100" } ], "variable": [ { "key": "accountId" }, { "key": "channelId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-65030a79-6737-4cfc-9b58-ba4b95b400db" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-6c4e5392-ffde-42b5-82d4-6cadeef57bcd" }, { "name": "Create WhatsApp Flow", "id": "46c2334e-f7ab-447a-a194-238ddacac01b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"categories\": [\n \"CONTACT_US\",\n \"SIGN_IN\"\n ],\n \"publish\": false,\n \"flowJson\": \"\",\n \"cloneFlowId\": \"\",\n \"endPointUri\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows" ], "variable": [ { "id": "d85efdce-2414-4615-8ff7-398a3602cb2d", "key": "accountId", "value": "ca343dCB-Ec9e-4094b0bdfD99FC0E1DC3", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." }, { "id": "53ec7755-7eeb-4913-8fd4-f13b5f2c4e1a", "key": "channelId", "value": "", "description": "(Required) Channel identifier" } ] }, "description": "This endpoint is used to create a new WhatsApp Flow.\n\nWhatsApp Flows are interactive experiences that businesses can use to collect information from customers through WhatsApp conversations. Flows provide a structured way to guide users through multi-step processes like booking appointments, collecting feedback, or processing orders." }, "response": [ { "id": "4e9fca84-6b7e-4bc7-849e-75661e3af100", "name": "Flow created successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"categories\": [\n \"CONTACT_US\",\n \"SIGN_IN\"\n ],\n \"publish\": false,\n \"flowJson\": \"\",\n \"cloneFlowId\": \"\",\n \"endPointUri\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows" ], "variable": [ { "key": "accountId" }, { "key": "channelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"success\": \"\",\n \"validationErrors\": [\n {\n \"error\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"lineStart\": \"\",\n \"lineEnd\": \"\",\n \"columnStart\": \"\",\n \"columnEnd\": \"\",\n \"pointers\": [\n {\n \"lineStart\": \"\",\n \"lineEnd\": \"\",\n \"columnStart\": \"\",\n \"columnEnd\": \"\",\n \"path\": \"\"\n },\n {\n \"lineStart\": \"\",\n \"lineEnd\": \"\",\n \"columnStart\": \"\",\n \"columnEnd\": \"\",\n \"path\": \"\"\n }\n ]\n },\n {\n \"error\": \"\",\n \"errorType\": \"\",\n \"message\": \"\",\n \"lineStart\": \"\",\n \"lineEnd\": \"\",\n \"columnStart\": \"\",\n \"columnEnd\": \"\",\n \"pointers\": [\n {\n \"lineStart\": \"\",\n \"lineEnd\": \"\",\n \"columnStart\": \"\",\n \"columnEnd\": \"\",\n \"path\": \"\"\n },\n {\n \"lineStart\": \"\",\n \"lineEnd\": \"\",\n \"columnStart\": \"\",\n \"columnEnd\": \"\",\n \"path\": \"\"\n }\n ]\n }\n ]\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-4e9fca84-6b7e-4bc7-849e-75661e3af100" }, { "id": "e4479dd2-c2da-47e0-b815-c1fb71b80a7e", "name": "Bad request error response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"categories\": [\n \"CONTACT_US\",\n \"SIGN_IN\"\n ],\n \"publish\": false,\n \"flowJson\": \"\",\n \"cloneFlowId\": \"\",\n \"endPointUri\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows" ], "variable": [ { "key": "accountId" }, { "key": "channelId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-e4479dd2-c2da-47e0-b815-c1fb71b80a7e" }, { "id": "b55b3412-8e7f-4883-8bfa-f1ef2e3501c2", "name": "Request was not authenticated response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"categories\": [\n \"CONTACT_US\",\n \"SIGN_IN\"\n ],\n \"publish\": false,\n \"flowJson\": \"\",\n \"cloneFlowId\": \"\",\n \"endPointUri\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows" ], "variable": [ { "key": "accountId" }, { "key": "channelId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-b55b3412-8e7f-4883-8bfa-f1ef2e3501c2" }, { "id": "8d0f7b9f-63e1-49f0-a528-4dfdf379622d", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"categories\": [\n \"CONTACT_US\",\n \"SIGN_IN\"\n ],\n \"publish\": false,\n \"flowJson\": \"\",\n \"cloneFlowId\": \"\",\n \"endPointUri\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/channels/:channelId/flows", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "channels", ":channelId", "flows" ], "variable": [ { "key": "accountId" }, { "key": "channelId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-8d0f7b9f-63e1-49f0-a528-4dfdf379622d" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-46c2334e-f7ab-447a-a194-238ddacac01b" } ], "id": "90d2a0ef-ec52-417a-bc5c-e152de68cf5b", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-90d2a0ef-ec52-417a-bc5c-e152de68cf5b" } ], "id": "80a1e00f-d4fb-4afa-b2a1-0514340fa632", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-80a1e00f-d4fb-4afa-b2a1-0514340fa632" } ], "id": "01f4b27a-b0fd-43a4-ad1e-82371585dda6", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-01f4b27a-b0fd-43a4-ad1e-82371585dda6" }, { "name": "webhooks", "item": [ { "name": "Get all Webhooks for Account", "id": "acaa8274-23a8-40b6-a8c5-1720080eeb42", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "id": "cdf1f872-453f-402a-a9d6-51eee2582f46", "key": "accountId", "value": "D4BFEC40-43bE7d3A-DEDaBc0Aa3230eB4", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." } ] }, "description": "Sending a GET request on this endpoint allows to **retrieve a list of all the webhooks or a specific webhook configured for an account**." }, "response": [ { "id": "5c8dcf17-fa38-4039-bd7f-624217510ce2", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"subAccountId\": \"\",\n \"url\": \"\",\n \"httpAuthorization\": \"\",\n \"enabled\": true,\n \"oauth\": {\n \"url\": \"\",\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"credentialsLocation\": \"body\",\n \"scope\": \"\"\n }\n },\n {\n \"subAccountId\": \"\",\n \"url\": \"\",\n \"httpAuthorization\": \"\",\n \"enabled\": true,\n \"oauth\": {\n \"url\": \"\",\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"credentialsLocation\": \"header\",\n \"scope\": \"\"\n }\n }\n]", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-5c8dcf17-fa38-4039-bd7f-624217510ce2" }, { "id": "87bee2b8-fc4a-49cd-9f60-b8df7c2a263a", "name": "Bad request error response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-87bee2b8-fc4a-49cd-9f60-b8df7c2a263a" }, { "id": "821b1a83-8c5f-4c4f-bc31-24d1ebf3d9e3", "name": "Request was not authenticated response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-821b1a83-8c5f-4c4f-bc31-24d1ebf3d9e3" }, { "id": "fe1a50bb-e1c5-4b02-9cd1-44747fd3ef35", "name": "Internal server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "key": "accountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-fe1a50bb-e1c5-4b02-9cd1-44747fd3ef35" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-acaa8274-23a8-40b6-a8c5-1720080eeb42" }, { "name": "Create or Replace webhooks", "id": "9208f4fe-8b38-495c-b7c0-3ea6550368a8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"subAccountId\": \"\",\n \"url\": \"\",\n \"httpAuthorization\": \"\",\n \"enabled\": true,\n \"type\": \"MSG\",\n \"oauth\": {\n \"url\": \"\",\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"credentialsLocation\": \"body\",\n \"scope\": \"\"\n }\n },\n {\n \"subAccountId\": \"\",\n \"url\": \"\",\n \"httpAuthorization\": \"\",\n \"enabled\": true,\n \"type\": \"CABM\",\n \"oauth\": {\n \"url\": \"\",\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"credentialsLocation\": \"header\",\n \"scope\": \"\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "id": "974ba52f-8ce6-4c06-a7c5-d7d8b7e3d043", "key": "accountId", "value": "D4BFEC40-43bE7d3A-DEDaBc0Aa3230eB4", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." } ] }, "description": "Sending a POST request on this endpoint allows to **add a new webhook for an account or modify the configuration of an existing one** . \n\nWebhooks can be given an account-wide and/or a type-wide scope using the \\* character \n\nFor example: if a webhook is created with subAccount=\\* , this webhook will receive events across all the subaccounts of an account." }, "response": [ { "id": "74426f5a-6096-4894-a778-712ae33eaf7f", "name": "The webhook was created or updated successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"subAccountId\": \"\",\n \"url\": \"\",\n \"httpAuthorization\": \"\",\n \"enabled\": true,\n \"type\": \"MSG\",\n \"oauth\": {\n \"url\": \"\",\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"credentialsLocation\": \"body\",\n \"scope\": \"\"\n }\n },\n {\n \"subAccountId\": \"\",\n \"url\": \"\",\n \"httpAuthorization\": \"\",\n \"enabled\": true,\n \"type\": \"CABM\",\n \"oauth\": {\n \"url\": \"\",\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"credentialsLocation\": \"header\",\n \"scope\": \"\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-74426f5a-6096-4894-a778-712ae33eaf7f" }, { "id": "1233f545-dbf1-4dc0-8525-3480ca030789", "name": "Bad request error response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"subAccountId\": \"\",\n \"url\": \"\",\n \"httpAuthorization\": \"\",\n \"enabled\": true,\n \"type\": \"MSG\",\n \"oauth\": {\n \"url\": \"\",\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"credentialsLocation\": \"body\",\n \"scope\": \"\"\n }\n },\n {\n \"subAccountId\": \"\",\n \"url\": \"\",\n \"httpAuthorization\": \"\",\n \"enabled\": true,\n \"type\": \"CABM\",\n \"oauth\": {\n \"url\": \"\",\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"credentialsLocation\": \"header\",\n \"scope\": \"\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-1233f545-dbf1-4dc0-8525-3480ca030789" }, { "id": "543cf3d4-cc70-4d8c-917f-fad858c61b12", "name": "Request was not authenticated response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"subAccountId\": \"\",\n \"url\": \"\",\n \"httpAuthorization\": \"\",\n \"enabled\": true,\n \"type\": \"MSG\",\n \"oauth\": {\n \"url\": \"\",\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"credentialsLocation\": \"body\",\n \"scope\": \"\"\n }\n },\n {\n \"subAccountId\": \"\",\n \"url\": \"\",\n \"httpAuthorization\": \"\",\n \"enabled\": true,\n \"type\": \"CABM\",\n \"oauth\": {\n \"url\": \"\",\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"credentialsLocation\": \"header\",\n \"scope\": \"\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-543cf3d4-cc70-4d8c-917f-fad858c61b12" }, { "id": "c7684e25-939e-423a-a8c8-3345aac4d577", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"subAccountId\": \"\",\n \"url\": \"\",\n \"httpAuthorization\": \"\",\n \"enabled\": true,\n \"type\": \"MSG\",\n \"oauth\": {\n \"url\": \"\",\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"credentialsLocation\": \"body\",\n \"scope\": \"\"\n }\n },\n {\n \"subAccountId\": \"\",\n \"url\": \"\",\n \"httpAuthorization\": \"\",\n \"enabled\": true,\n \"type\": \"CABM\",\n \"oauth\": {\n \"url\": \"\",\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"credentialsLocation\": \"header\",\n \"scope\": \"\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "key": "accountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-c7684e25-939e-423a-a8c8-3345aac4d577" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-9208f4fe-8b38-495c-b7c0-3ea6550368a8" }, { "name": "Delete webhooks", "id": "f8fcd8e7-07a4-491b-9b11-8b0aaa973b64", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"subAccountId\": \"\",\n \"type\": \"CADR\"\n },\n {\n \"subAccountId\": \"\",\n \"type\": \"CADR\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "id": "3d5ee882-e03a-487c-9ebf-543a3225eb47", "key": "accountId", "value": "D4BFEC40-43bE7d3A-DEDaBc0Aa3230eB4", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." } ] }, "description": "Sending a DELETE request on this endpoint allows to **remove a configured webhook for an account or a subaccount** ." }, "response": [ { "id": "f95e5f8a-ec66-49e7-9441-0aaac9645983", "name": "The webhook was deleted successfully", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"subAccountId\": \"\",\n \"type\": \"CADR\"\n },\n {\n \"subAccountId\": \"\",\n \"type\": \"CADR\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-f95e5f8a-ec66-49e7-9441-0aaac9645983" }, { "id": "6f22f16f-643f-4e3f-946f-a381850a472d", "name": "Bad request error response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"subAccountId\": \"\",\n \"type\": \"CADR\"\n },\n {\n \"subAccountId\": \"\",\n \"type\": \"CADR\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-6f22f16f-643f-4e3f-946f-a381850a472d" }, { "id": "1bc03142-0d01-4245-a06c-80dffa99f890", "name": "Request was not authenticated response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"subAccountId\": \"\",\n \"type\": \"CADR\"\n },\n {\n \"subAccountId\": \"\",\n \"type\": \"CADR\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-1bc03142-0d01-4245-a06c-80dffa99f890" }, { "id": "a2e80635-7809-4834-a82c-ae4de5043913", "name": "Internal server error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"subAccountId\": \"\",\n \"type\": \"CADR\"\n },\n {\n \"subAccountId\": \"\",\n \"type\": \"CADR\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "key": "accountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-a2e80635-7809-4834-a82c-ae4de5043913" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-f8fcd8e7-07a4-491b-9b11-8b0aaa973b64" } ], "id": "7904c1df-2604-4481-b81f-54347e24cfef", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-7904c1df-2604-4481-b81f-54347e24cfef" }, { "name": "usage", "item": [ { "name": "messages", "item": [ { "name": "Get message usage", "id": "6e411f41-ff72-4b40-bc94-2dcf7b7ec0e0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/usage/messages?billingPeriod=5262-11&channel=whatsapp&groupBy=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "usage", "messages" ], "query": [ { "description": "(Required) The billing month to query, in `YYYY-MM` format (e.g. `2026-03`). Must be a closed billing period from February 2026 or later. Maximum lookback is 6 months.", "key": "billingPeriod", "value": "5262-11" }, { "description": "Filter results by messaging channel. Currently, only `whatsapp` is supported. Defaults to `whatsapp` if omitted.", "key": "channel", "value": "whatsapp" }, { "description": "Comma-separated list of dimensions to group results by. When omitted, a single aggregated total is returned. `pricing` is included when `groupBy` contains `channel`, `businessAccountId`, `pricingCategory`, and `country`.\n\nAvailable values: `subAccountId`, `channel`, `businessAccountId`, `pricingCategory`, `country`.", "key": "groupBy", "value": "" } ], "variable": [ { "id": "20598b13-a363-4874-b50a-370d1e4960e5", "key": "accountId", "value": "", "description": "(Required) You must replace *{accountId}* with the account ID that you want to use." } ] }, "description": "Returns monthly per-message usage totals for the specified billing period. Results can be filtered and grouped by subaccount, business account, channel, pricing category, and destination country.\n\nCurrently, only WhatsApp is supported.\n\n**Constraints:**\n- Data is available from **February 2026** onwards\n- Only **closed billing periods** can be queried\n- Maximum lookback: **6 months**\n\n**Grouping behavior:**\n- If `groupBy` is omitted, a single aggregated total is returned\n- `pricing` is included when `groupBy` contains `channel`, `businessAccountId`, `pricingCategory`, and `country`" }, "response": [ { "id": "a65dc4b9-2cac-4850-b2d8-6638b5b2480e", "name": "Successful response containing message usage data.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/usage/messages?billingPeriod=5262-11&channel=whatsapp&groupBy=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "usage", "messages" ], "query": [ { "description": "(Required) The billing month to query, in `YYYY-MM` format (e.g. `2026-03`). Must be a closed billing period from February 2026 or later. Maximum lookback is 6 months.", "key": "billingPeriod", "value": "5262-11" }, { "description": "Filter results by messaging channel. Currently, only `whatsapp` is supported. Defaults to `whatsapp` if omitted.", "key": "channel", "value": "whatsapp" }, { "description": "Comma-separated list of dimensions to group results by. When omitted, a single aggregated total is returned. `pricing` is included when `groupBy` contains `channel`, `businessAccountId`, `pricingCategory`, and `country`.\n\nAvailable values: `subAccountId`, `channel`, `businessAccountId`, `pricingCategory`, `country`.", "key": "groupBy", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"subAccountId\": \"\",\n \"channel\": \"whatsapp\",\n \"country\": \"\",\n \"businessAccountId\": \"\",\n \"pricingCategory\": \"\",\n \"volume\": {\n \"delivered\": \"\",\n \"charged\": \"\",\n \"free\": \"\"\n },\n \"pricing\": {\n \"rateModel\": \"flat\",\n \"tiers\": [\n {\n \"from\": \"\",\n \"to\": \"\",\n \"quantity\": \"\",\n \"status\": \"completed\"\n },\n {\n \"from\": \"\",\n \"to\": \"\",\n \"quantity\": \"\",\n \"status\": \"completed\"\n }\n ]\n }\n },\n {\n \"subAccountId\": \"\",\n \"channel\": \"whatsapp\",\n \"country\": \"\",\n \"businessAccountId\": \"\",\n \"pricingCategory\": \"\",\n \"volume\": {\n \"delivered\": \"\",\n \"charged\": \"\",\n \"free\": \"\"\n },\n \"pricing\": {\n \"rateModel\": \"flat\",\n \"tiers\": [\n {\n \"from\": \"\",\n \"to\": \"\",\n \"quantity\": \"\",\n \"status\": \"completed\"\n },\n {\n \"from\": \"\",\n \"to\": \"\",\n \"quantity\": \"\",\n \"status\": \"completed\"\n }\n ]\n }\n }\n ],\n \"meta\": {\n \"accountId\": \"\",\n \"billingPeriod\": {\n \"start\": \"\",\n \"end\": \"\",\n \"status\": \"closed\"\n },\n \"dataAsOf\": \"\",\n \"groupBy\": [\n \"\",\n \"\"\n ],\n \"currency\": \"\"\n }\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-a65dc4b9-2cac-4850-b2d8-6638b5b2480e" }, { "id": "6368031b-edbd-45e3-b6c8-4d517c51d060", "name": "Bad request. The billing period format is invalid, the period is not yet closed, the date is before February 2026, or the lookback exceeds 6 months.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/usage/messages?billingPeriod=5262-11&channel=whatsapp&groupBy=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "usage", "messages" ], "query": [ { "description": "(Required) The billing month to query, in `YYYY-MM` format (e.g. `2026-03`). Must be a closed billing period from February 2026 or later. Maximum lookback is 6 months.", "key": "billingPeriod", "value": "5262-11" }, { "description": "Filter results by messaging channel. Currently, only `whatsapp` is supported. Defaults to `whatsapp` if omitted.", "key": "channel", "value": "whatsapp" }, { "description": "Comma-separated list of dimensions to group results by. When omitted, a single aggregated total is returned. `pricing` is included when `groupBy` contains `channel`, `businessAccountId`, `pricingCategory`, and `country`.\n\nAvailable values: `subAccountId`, `channel`, `businessAccountId`, `pricingCategory`, `country`.", "key": "groupBy", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-6368031b-edbd-45e3-b6c8-4d517c51d060" }, { "id": "6d5ca7f1-dea4-4e28-801d-123e472ef579", "name": "Request was not authenticated.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/usage/messages?billingPeriod=5262-11&channel=whatsapp&groupBy=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "usage", "messages" ], "query": [ { "description": "(Required) The billing month to query, in `YYYY-MM` format (e.g. `2026-03`). Must be a closed billing period from February 2026 or later. Maximum lookback is 6 months.", "key": "billingPeriod", "value": "5262-11" }, { "description": "Filter results by messaging channel. Currently, only `whatsapp` is supported. Defaults to `whatsapp` if omitted.", "key": "channel", "value": "whatsapp" }, { "description": "Comma-separated list of dimensions to group results by. When omitted, a single aggregated total is returned. `pricing` is included when `groupBy` contains `channel`, `businessAccountId`, `pricingCategory`, and `country`.\n\nAvailable values: `subAccountId`, `channel`, `businessAccountId`, `pricingCategory`, `country`.", "key": "groupBy", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-6d5ca7f1-dea4-4e28-801d-123e472ef579" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-6e411f41-ff72-4b40-bc94-2dcf7b7ec0e0" } ], "id": "f8d3c6c1-268e-4a6d-b796-47a7ad67af8c", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-f8d3c6c1-268e-4a6d-b796-47a7ad67af8c" } ], "id": "81aea40e-e506-4d04-92cf-41b360d3463b", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-81aea40e-e506-4d04-92cf-41b360d3463b" } ], "id": "0205d084-328e-42f5-8f7c-b5de7e23e54d", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-0205d084-328e-42f5-8f7c-b5de7e23e54d" } ], "id": "27151c91-c69b-4b4b-9cbc-3d8dbf64dd14", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-27151c91-c69b-4b4b-9cbc-3d8dbf64dd14" }, { "name": "whatsapp", "item": [ { "name": "subaccounts", "item": [ { "name": "{subAccountId}", "item": [ { "name": "channels", "item": [ { "name": "{channelId}", "item": [ { "name": "callPermissions", "item": [ { "name": "Get Call Permission Status", "id": "863abd71-abe2-475f-af50-f682c8f911d7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/subaccounts/:subAccountId/channels/:channelId/callPermissions?destination=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "subaccounts", ":subAccountId", "channels", ":channelId", "callPermissions" ], "query": [ { "description": "(Required) Destination phone number to check call permission status (E.164 format)", "key": "destination", "value": "" } ], "variable": [ { "id": "5473510b-1ae9-4eab-85ee-c6a487cd959a", "key": "subAccountId", "value": "", "description": "(Required) Sub-account identifier" }, { "id": "e2cb7974-ebd0-40bc-8b2e-7b2c9aea6d50", "key": "channelId", "value": "", "description": "(Required) Channel identifier" } ] }, "description": "This endpoint is used to check the status of call permission for a specific destination on WhatsApp. It returns whether the business is allowed to initiate voice calls to the specified phone number." }, "response": [ { "id": "86c2c44e-2208-48be-ac5d-31964315f956", "name": "Success response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/subaccounts/:subAccountId/channels/:channelId/callPermissions?destination=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "subaccounts", ":subAccountId", "channels", ":channelId", "callPermissions" ], "query": [ { "description": "(Required) Destination phone number to check call permission status (E.164 format)", "key": "destination", "value": "" } ], "variable": [ { "key": "subAccountId" }, { "key": "channelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"permanent\",\n \"actions\": [\n {\n \"actionName\": \"start_call\",\n \"canPerformAction\": \"\",\n \"limits\": [\n {\n \"timePeriod\": \"\",\n \"maxAllowed\": \"\",\n \"currentUsage\": \"\"\n },\n {\n \"timePeriod\": \"\",\n \"maxAllowed\": \"\",\n \"currentUsage\": \"\"\n }\n ]\n },\n {\n \"actionName\": \"start_call\",\n \"canPerformAction\": \"\",\n \"limits\": [\n {\n \"timePeriod\": \"\",\n \"maxAllowed\": \"\",\n \"currentUsage\": \"\"\n },\n {\n \"timePeriod\": \"\",\n \"maxAllowed\": \"\",\n \"currentUsage\": \"\"\n }\n ]\n }\n ],\n \"expirationTime\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-86c2c44e-2208-48be-ac5d-31964315f956" }, { "id": "c0ec5d3a-9ce3-4dc8-80d2-5862786062d8", "name": "Bad request error response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/subaccounts/:subAccountId/channels/:channelId/callPermissions?destination=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "subaccounts", ":subAccountId", "channels", ":channelId", "callPermissions" ], "query": [ { "description": "(Required) Destination phone number to check call permission status (E.164 format)", "key": "destination", "value": "" } ], "variable": [ { "key": "subAccountId" }, { "key": "channelId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-c0ec5d3a-9ce3-4dc8-80d2-5862786062d8" }, { "id": "4fcfbb3b-bf4c-4198-b350-4aee1c9defe6", "name": "Request was not authenticated response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/subaccounts/:subAccountId/channels/:channelId/callPermissions?destination=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "subaccounts", ":subAccountId", "channels", ":channelId", "callPermissions" ], "query": [ { "description": "(Required) Destination phone number to check call permission status (E.164 format)", "key": "destination", "value": "" } ], "variable": [ { "key": "subAccountId" }, { "key": "channelId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-4fcfbb3b-bf4c-4198-b350-4aee1c9defe6" }, { "id": "bfae389e-7c78-4ec8-8c70-c88774cca1a0", "name": "Internal server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/subaccounts/:subAccountId/channels/:channelId/callPermissions?destination=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "subaccounts", ":subAccountId", "channels", ":channelId", "callPermissions" ], "query": [ { "description": "(Required) Destination phone number to check call permission status (E.164 format)", "key": "destination", "value": "" } ], "variable": [ { "key": "subAccountId" }, { "key": "channelId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-bfae389e-7c78-4ec8-8c70-c88774cca1a0" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-863abd71-abe2-475f-af50-f682c8f911d7" } ], "id": "a1e94005-b20b-4fdd-b0ad-34b79c8e9e60", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-a1e94005-b20b-4fdd-b0ad-34b79c8e9e60" }, { "name": "directSend", "item": [ { "name": "sample", "item": [ { "name": "Submit WhatsApp Direct Send Sample", "id": "e03ea497-c9c0-410e-9bfd-e152f08b06ab", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"interactive\",\n \"text\": {\n \"body\": \"\"\n },\n \"interactive\": {\n \"type\": \"cta_url\",\n \"body\": {\n \"text\": \"\"\n },\n \"action\": {\n \"name\": \"cta_url\",\n \"parameters\": {\n \"display_text\": \"\",\n \"url\": \"\"\n },\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n },\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n }\n ]\n },\n \"header\": {\n \"type\": \"text\",\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/subaccounts/:subAccountId/channels/:channelId/directSend/sample", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "subaccounts", ":subAccountId", "channels", ":channelId", "directSend", "sample" ], "variable": [ { "id": "f71447b7-7372-4db8-ba2b-5e924aee3280", "key": "subAccountId", "value": "", "description": "(Required) Sub-account identifier" }, { "id": "f35c17cd-cee1-4e8f-8d86-d3a6a49f5d0e", "key": "channelId", "value": "", "description": "(Required) Channel identifier" } ] }, "description": "This endpoint is used to submit a sample of a WhatsApp Direct Send message to Meta for review and classification.\n\nDirect Send auto-creates WhatsApp templates on the fly and matches incoming messages against them. Submitting sample messages will ensure that the messages you send through Direct Send are accurately classified and transformed into templates that are useful for your use cases.\n\nThe response indicates whether the sample was processed successfully and the category Meta assigned to it. Possible categories are `UTILITY`, `MARKETING`, and `AUTHENTICATION`.\n\nSamples can be of two types:\n* `text` \u2014 a plain text body.\n* `interactive` \u2014 an interactive message with a call-to-action URL (`cta_url`) or reply buttons (`button`)." }, "response": [ { "id": "bb7937e9-6515-47dd-b13c-222e9c42b585", "name": "Sample submitted successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"interactive\",\n \"text\": {\n \"body\": \"\"\n },\n \"interactive\": {\n \"type\": \"cta_url\",\n \"body\": {\n \"text\": \"\"\n },\n \"action\": {\n \"name\": \"cta_url\",\n \"parameters\": {\n \"display_text\": \"\",\n \"url\": \"\"\n },\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n },\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n }\n ]\n },\n \"header\": {\n \"type\": \"text\",\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/subaccounts/:subAccountId/channels/:channelId/directSend/sample", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "subaccounts", ":subAccountId", "channels", ":channelId", "directSend", "sample" ], "variable": [ { "key": "subAccountId" }, { "key": "channelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"category\": \"MARKETING\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-bb7937e9-6515-47dd-b13c-222e9c42b585" }, { "id": "e0820cb4-6d3c-4839-8ce4-58795691ca29", "name": "Bad request error response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"interactive\",\n \"text\": {\n \"body\": \"\"\n },\n \"interactive\": {\n \"type\": \"cta_url\",\n \"body\": {\n \"text\": \"\"\n },\n \"action\": {\n \"name\": \"cta_url\",\n \"parameters\": {\n \"display_text\": \"\",\n \"url\": \"\"\n },\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n },\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n }\n ]\n },\n \"header\": {\n \"type\": \"text\",\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/subaccounts/:subAccountId/channels/:channelId/directSend/sample", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "subaccounts", ":subAccountId", "channels", ":channelId", "directSend", "sample" ], "variable": [ { "key": "subAccountId" }, { "key": "channelId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-e0820cb4-6d3c-4839-8ce4-58795691ca29" }, { "id": "a3e1edea-3e7e-4172-aa66-66fee4f68cca", "name": "Request was not authenticated response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"interactive\",\n \"text\": {\n \"body\": \"\"\n },\n \"interactive\": {\n \"type\": \"cta_url\",\n \"body\": {\n \"text\": \"\"\n },\n \"action\": {\n \"name\": \"cta_url\",\n \"parameters\": {\n \"display_text\": \"\",\n \"url\": \"\"\n },\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n },\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n }\n ]\n },\n \"header\": {\n \"type\": \"text\",\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/subaccounts/:subAccountId/channels/:channelId/directSend/sample", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "subaccounts", ":subAccountId", "channels", ":channelId", "directSend", "sample" ], "variable": [ { "key": "subAccountId" }, { "key": "channelId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-a3e1edea-3e7e-4172-aa66-66fee4f68cca" }, { "id": "82ce322d-cc2f-4227-a5a4-217475e90149", "name": "Request was not authenticated response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"interactive\",\n \"text\": {\n \"body\": \"\"\n },\n \"interactive\": {\n \"type\": \"cta_url\",\n \"body\": {\n \"text\": \"\"\n },\n \"action\": {\n \"name\": \"cta_url\",\n \"parameters\": {\n \"display_text\": \"\",\n \"url\": \"\"\n },\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n },\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n }\n ]\n },\n \"header\": {\n \"type\": \"text\",\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/subaccounts/:subAccountId/channels/:channelId/directSend/sample", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "subaccounts", ":subAccountId", "channels", ":channelId", "directSend", "sample" ], "variable": [ { "key": "subAccountId" }, { "key": "channelId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-82ce322d-cc2f-4227-a5a4-217475e90149" }, { "id": "72263e02-9e9d-4e08-8375-dfd955d9d823", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"interactive\",\n \"text\": {\n \"body\": \"\"\n },\n \"interactive\": {\n \"type\": \"cta_url\",\n \"body\": {\n \"text\": \"\"\n },\n \"action\": {\n \"name\": \"cta_url\",\n \"parameters\": {\n \"display_text\": \"\",\n \"url\": \"\"\n },\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n },\n {\n \"type\": \"reply\",\n \"reply\": {\n \"id\": \"\",\n \"title\": \"\"\n }\n }\n ]\n },\n \"header\": {\n \"type\": \"text\",\n \"text\": \"\"\n },\n \"footer\": {\n \"text\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/whatsapp/subaccounts/:subAccountId/channels/:channelId/directSend/sample", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "whatsapp", "subaccounts", ":subAccountId", "channels", ":channelId", "directSend", "sample" ], "variable": [ { "key": "subAccountId" }, { "key": "channelId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-72263e02-9e9d-4e08-8375-dfd955d9d823" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-e03ea497-c9c0-410e-9bfd-e152f08b06ab" } ], "id": "3d53476a-f4ae-4012-bc1d-dd5ef1abc879", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-3d53476a-f4ae-4012-bc1d-dd5ef1abc879" } ], "id": "df2abfff-5f32-4229-8a5f-b15f4d5cd130", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-df2abfff-5f32-4229-8a5f-b15f4d5cd130" } ], "id": "9f461cb2-be25-42c1-87d5-559b96deab68", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-9f461cb2-be25-42c1-87d5-559b96deab68" } ], "id": "10214e16-645b-4183-a528-8c8542a7e746", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-10214e16-645b-4183-a528-8c8542a7e746" } ], "id": "b166e3da-81b1-4d18-b887-68df16beaf71", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-b166e3da-81b1-4d18-b887-68df16beaf71" } ], "id": "fa3a938b-be6f-49b5-9596-70b140f63f77", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-fa3a938b-be6f-49b5-9596-70b140f63f77" } ], "id": "07cc39b3-d63f-4927-b807-64ddc88e9e4e", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-07cc39b3-d63f-4927-b807-64ddc88e9e4e" } ], "id": "9e95fe76-84e2-4e96-880f-d6df7553170e", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-9e95fe76-84e2-4e96-880f-d6df7553170e" } ], "id": "73e48ffe-a86a-4447-80d6-7fea1ec429bd", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-73e48ffe-a86a-4447-80d6-7fea1ec429bd" }, { "name": "files", "item": [ { "name": "{filename}", "item": [ { "name": "Download file", "id": "d26b5262-ad09-40db-ac08-54cd95aa042a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:filename?token=", "host": [ "{{baseUrl}}" ], "path": [ "files", ":filename" ], "query": [ { "description": "File token", "key": "token", "value": "" } ], "variable": [ { "id": "1241c9e2-104f-466f-9785-247b1821bd1b", "key": "filename", "value": "", "description": "(Required) File name with extension" } ] } }, "response": [ { "id": "ccfc5666-c3ba-4281-9f9f-3920ab83cfa2", "name": "Redirect to download URL if the file is found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/files/:filename?token=", "host": [ "{{baseUrl}}" ], "path": [ "files", ":filename" ], "query": [ { "description": "File token", "key": "token", "value": "" } ], "variable": [ { "key": "filename" } ] } }, "status": "Found", "code": 302, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-ccfc5666-c3ba-4281-9f9f-3920ab83cfa2" }, { "id": "83045f22-d430-44e0-baf4-2d861e423b30", "name": "The entity doesn't exist", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/files/:filename?token=", "host": [ "{{baseUrl}}" ], "path": [ "files", ":filename" ], "query": [ { "description": "File token", "key": "token", "value": "" } ], "variable": [ { "key": "filename" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-83045f22-d430-44e0-baf4-2d861e423b30" }, { "id": "7c20bbfb-2053-4641-b7f7-b44c89f8fa44", "name": "Internal server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/files/:filename?token=", "host": [ "{{baseUrl}}" ], "path": [ "files", ":filename" ], "query": [ { "description": "File token", "key": "token", "value": "" } ], "variable": [ { "key": "filename" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-7c20bbfb-2053-4641-b7f7-b44c89f8fa44" } ], "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-d26b5262-ad09-40db-ac08-54cd95aa042a" } ], "id": "263a859a-ca21-4c36-97fd-321d8d024a76", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-263a859a-ca21-4c36-97fd-321d8d024a76" } ], "id": "aa969feb-ed37-4016-ac72-e606b83bd229", "createdAt": "2026-07-28T00:28:16.000Z", "updatedAt": "2026-07-28T00:28:16.000Z", "uid": "35240-aa969feb-ed37-4016-ac72-e606b83bd229" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://chatapps.8x8.com" } ] }