{ "info": { "_postman_id": "4723b10f-d94f-459d-b472-ac67ff97a86e", "name": "SMS API", "description": "API to send SMS messages\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:40.000Z", "updatedAt": "2026-07-28T00:28:40.000Z", "lastUpdatedBy": "35240", "uid": "35240-4723b10f-d94f-459d-b472-ac67ff97a86e" }, "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 SMS", "id": "f326bcff-5fed-4141-9602-0b707f29aa72", "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": "664ef571-baf6-4276-874e-eff26e669fd1", "key": "subAccountId", "value": "JWp8kfUy_Ye3kgbpf6R30tQKn4X", "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": "dab58bb2-f396-480e-b85e-2d249839d008", "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://sms.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": "f05e5bec-6533-435a-a4b3-00c772d88668", "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-f05e5bec-6533-435a-a4b3-00c772d88668" }, { "id": "d108778a-747e-4da6-9255-1571335d3544", "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-d108778a-747e-4da6-9255-1571335d3544" }, { "id": "449e1f6d-25e9-451b-b5a3-38995406a35d", "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-449e1f6d-25e9-451b-b5a3-38995406a35d" }, { "id": "fdc65dd6-c159-4eaa-95d7-7f95bb36af7b", "name": "Upgrade Required \u2014 client is using an unsupported TLS version", "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": "Upgrade Required (RFC 2817)", "code": 426, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Upgrade", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-fdc65dd6-c159-4eaa-95d7-7f95bb36af7b" }, { "id": "78fb724e-87c6-4396-8917-661d1d1531b6", "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-78fb724e-87c6-4396-8917-661d1d1531b6" } ], "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-f326bcff-5fed-4141-9602-0b707f29aa72" } ], "id": "61e1c7ac-bb1f-4cc5-9704-e1f78c05f630", "createdAt": "2026-07-28T00:28:40.000Z", "updatedAt": "2026-07-28T00:28:40.000Z", "uid": "35240-61e1c7ac-bb1f-4cc5-9704-e1f78c05f630" }, { "name": "Send SMS batch", "id": "3db6039f-da67-4bfd-8991-1b451292d4bc", "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 \"destination\": \"+537549901565\",\n \"text\": \"\",\n \"country\": \"\",\n \"source\": \"\",\n \"clientMessageId\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"clientIp\": \"\",\n \"track\": null\n }\n ],\n \"clientBatchId\": \"\",\n \"destinations\": [\n \"\"\n ],\n \"template\": {\n \"source\": \"\",\n \"text\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\"\n },\n \"includeMessagesInResponse\": \"\",\n \"clientIp\": \"\"\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": "8e316f47-692c-4910-afb2-16127753b8ef", "key": "subAccountId", "value": "JWp8kfUy_Ye3kgbpf6R30tQKn4X", "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 to this endpoint allows you to **send SMS by batches (1 request for multiple SMS) with shared or personalized contents/properties**. \n* Personalized content is ideal for sending marketing campaigns or any mass personalized announcement.\n* Shared content is easier to use for such cases as an announcement, message broadcasting, etc.\n* It only accepts messages with the same properties (source, text, encoding, scheduling time, and expiry time). \n* Using this endpoint, it is possible to send up to 10,000 SMS per request.\n\n### URL\nThe 8x8 SMS subaccountid to use is defined in the URL where you send your POST request as shown below:\n\n`https://sms.8x8.com/api/v1/subaccounts/{subAccountId}/messages/batch`\n\n\n> You must replace `{subAccountId}` in the URL above with the subaccountid that you want to use." }, "response": [ { "id": "b29b06a7-e40c-48b5-be0b-0af462c79308", "name": "- The response returns **two different IDs for the batch**:\n + **batchId**: the unique batch ID generated automatically by 8x8\n + **clientBatchId**: the batch ID that you submitted in the request (if any)\n- It also returns a **summary of the batch submi", "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 \"destination\": \"+537549901565\",\n \"text\": \"\",\n \"country\": \"\",\n \"source\": \"\",\n \"clientMessageId\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"clientIp\": \"\",\n \"track\": null\n }\n ],\n \"clientBatchId\": \"\",\n \"destinations\": [\n \"\"\n ],\n \"template\": {\n \"source\": \"\",\n \"text\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\"\n },\n \"includeMessagesInResponse\": \"\",\n \"clientIp\": \"\"\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 \"acceptedCount\": \"\",\n \"batchId\": \"\",\n \"rejectedCount\": \"\",\n \"clientBatchId\": \"\",\n \"messages\": [\n {\n \"destination\": \"+5730977021\",\n \"encoding\": \"AUTO\",\n \"status\": {\n \"code\": \"QUEUED\",\n \"description\": \"\"\n },\n \"umid\": \"\",\n \"clientMessageId\": \"\"\n },\n {\n \"destination\": \"8518043547592\",\n \"encoding\": \"GSM7\",\n \"status\": {\n \"code\": \"QUEUED\",\n \"description\": \"\"\n },\n \"umid\": \"\",\n \"clientMessageId\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-b29b06a7-e40c-48b5-be0b-0af462c79308" }, { "id": "3f73b4cd-3c4b-40d4-b15e-64a25ba182ff", "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 \"destination\": \"+537549901565\",\n \"text\": \"\",\n \"country\": \"\",\n \"source\": \"\",\n \"clientMessageId\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"clientIp\": \"\",\n \"track\": null\n }\n ],\n \"clientBatchId\": \"\",\n \"destinations\": [\n \"\"\n ],\n \"template\": {\n \"source\": \"\",\n \"text\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\"\n },\n \"includeMessagesInResponse\": \"\",\n \"clientIp\": \"\"\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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-3f73b4cd-3c4b-40d4-b15e-64a25ba182ff" }, { "id": "3552c37a-d009-42be-80d7-6427ac6e1a24", "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 \"destination\": \"+537549901565\",\n \"text\": \"\",\n \"country\": \"\",\n \"source\": \"\",\n \"clientMessageId\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"clientIp\": \"\",\n \"track\": null\n }\n ],\n \"clientBatchId\": \"\",\n \"destinations\": [\n \"\"\n ],\n \"template\": {\n \"source\": \"\",\n \"text\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\"\n },\n \"includeMessagesInResponse\": \"\",\n \"clientIp\": \"\"\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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-3552c37a-d009-42be-80d7-6427ac6e1a24" }, { "id": "422001c2-526e-4e3b-8be2-b2671ad9e16f", "name": "Upgrade Required \u2014 client is using an unsupported TLS version", "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 \"destination\": \"+537549901565\",\n \"text\": \"\",\n \"country\": \"\",\n \"source\": \"\",\n \"clientMessageId\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"clientIp\": \"\",\n \"track\": null\n }\n ],\n \"clientBatchId\": \"\",\n \"destinations\": [\n \"\"\n ],\n \"template\": {\n \"source\": \"\",\n \"text\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\"\n },\n \"includeMessagesInResponse\": \"\",\n \"clientIp\": \"\"\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": "Upgrade Required (RFC 2817)", "code": 426, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Upgrade", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-422001c2-526e-4e3b-8be2-b2671ad9e16f" }, { "id": "d654d7af-47a0-435e-a23e-a708d224f3a7", "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 \"destination\": \"+537549901565\",\n \"text\": \"\",\n \"country\": \"\",\n \"source\": \"\",\n \"clientMessageId\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"clientIp\": \"\",\n \"track\": null\n }\n ],\n \"clientBatchId\": \"\",\n \"destinations\": [\n \"\"\n ],\n \"template\": {\n \"source\": \"\",\n \"text\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\"\n },\n \"includeMessagesInResponse\": \"\",\n \"clientIp\": \"\"\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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-d654d7af-47a0-435e-a23e-a708d224f3a7" } ], "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-3db6039f-da67-4bfd-8991-1b451292d4bc" } ], "id": "e0c85f9f-4a46-4b9e-a742-54852986de0b", "createdAt": "2026-07-28T00:28:40.000Z", "updatedAt": "2026-07-28T00:28:40.000Z", "uid": "35240-e0c85f9f-4a46-4b9e-a742-54852986de0b" }, { "name": "{umid}", "item": [ { "name": "feedback", "item": [ { "name": "SMS Success Feedback", "id": "b4cc0a09-5abd-47ad-83e0-6f38c7c90cb0", "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 \"outcome\": \"failure\",\n \"timestamp\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid/feedback", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid", "feedback" ], "variable": [ { "id": "75169f7e-fba7-4dd1-afe8-312c7ee801c6", "key": "subAccountId", "value": "JWp8kfUy_Ye3kgbpf6R30tQKn4X", "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": "f6b4e906-43aa-4d16-bf71-30bc1f69e500", "key": "umid", "value": "", "description": "(Required) Unique message Id, generated by 8x8 API." } ] }, "description": "### About SMS Feedback\n\nMost of the time, programmatic SMS are meant to trigger a specific outcome (_ex: authenticate a user via OTP_).\nWhen the outcome does not happen it can have any number of user-related cause but what we seek to avoid is for SMS deliverability or latency to be the reason for failure.\nTo avoid this, use this endpoint to transmit the outcome to 8x8 and let 8x8 monitor your SMS performance for you.\nIt benefits you by allowing 8x8 to: \n\n- **Monitor your application QoS for any SMS-related failure** happening in your workflows \n- **Act faster to restore the quality** of service you experiment\n- **Prevent any further issue**\n- Provide more advanced analytics by displaying **SMS outcome performance and latency metrics**\n\n### About the API endpoint / method\n* Sending a POST request on this endpoint allows to **convey the outcome of an SMS to 8x8**.\n* Sharing that feedback with 8x8 is straightforward, your POST request only has to contain:\n\t1. The 8x8 **UMID - Unique Message ID** (included in the API response when sending the SMS)\n\t2. A status for **the outcome** \n\t3. For more accuracy and to get latency information: the **timestamp of the event triggered by the SMS**\n\n### URL \nComplete endpoint URL:`https://sms.8x8.com/api/v1/subaccounts/{subAccountId}/messages/{umid}/feedback`\n\n> You must replace `{subAccountId}` in the URL above with the subaccountid that you used originally to send the SMS." }, "response": [ { "id": "632eef47-4a95-4b0f-b08e-ff329a9f0dbb", "name": "New Response", "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 \"outcome\": \"failure\",\n \"timestamp\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid/feedback", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid", "feedback" ], "variable": [ { "key": "subAccountId" }, { "key": "umid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-632eef47-4a95-4b0f-b08e-ff329a9f0dbb" }, { "id": "324a258e-5a95-4e9f-ae23-c97effe9fa21", "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 \"outcome\": \"failure\",\n \"timestamp\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid/feedback", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid", "feedback" ], "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-324a258e-5a95-4e9f-ae23-c97effe9fa21" }, { "id": "90eb18f4-bb23-48d4-956c-bff378646415", "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 \"outcome\": \"failure\",\n \"timestamp\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid/feedback", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid", "feedback" ], "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-90eb18f4-bb23-48d4-956c-bff378646415" }, { "id": "61f31833-c989-4f79-ba98-a760919c3844", "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 \"outcome\": \"failure\",\n \"timestamp\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid/feedback", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid", "feedback" ], "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-61f31833-c989-4f79-ba98-a760919c3844" } ], "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-b4cc0a09-5abd-47ad-83e0-6f38c7c90cb0" } ], "id": "2813ac5f-da34-4999-a0a5-80461bb807ee", "createdAt": "2026-07-28T00:28:40.000Z", "updatedAt": "2026-07-28T00:28:40.000Z", "uid": "35240-2813ac5f-da34-4999-a0a5-80461bb807ee" }, { "name": "pii", "item": [ { "name": "Remove Personally Identifiable Information (PII)", "id": "357e6865-9f15-44e0-a650-20477faad7dc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid/pii", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid", "pii" ], "variable": [ { "id": "9cf7e44e-650f-42fa-ab79-671705021d20", "key": "subAccountId", "value": "JWp8kfUy_Ye3kgbpf6R30tQKn4X", "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": "c9da05d1-678d-44f1-99f9-68855707e3ff", "key": "umid", "value": "", "description": "(Required) Unique message Id, generated by 8x8 API." } ] }, "description": "Remove Personally Identifiable Information (PII) for particular message from 8x8 SMS database." }, "response": [ { "id": "87a29305-03a2-43e0-8026-f11d591330af", "name": "Request to remove PII from message accepted and will be executed shortly.", "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/:umid/pii", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid", "pii" ], "variable": [ { "key": "subAccountId" }, { "key": "umid" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-87a29305-03a2-43e0-8026-f11d591330af" }, { "id": "15ad20ef-08d7-485c-b22c-bbc5953df5e2", "name": "New Response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid/pii", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid", "pii" ], "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 \"example\": {\n \"code\": 1300,\n \"message\": \"Message not found.\",\n \"errorId\": \"57c9a4b2-ece5-ea11-826a-00155d264ac1\",\n \"timestamp\": \"2020-08-24T09:32:17.05Z\"\n }\n}", "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-15ad20ef-08d7-485c-b22c-bbc5953df5e2" }, { "id": "a8388f3b-9023-4993-bf54-f2f8373fe532", "name": "Rate limiting quota exceeded error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid/pii", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid", "pii" ], "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 \"example\": {\n \"code\": 429,\n \"message\": \"Quota exceeded. Please try again in 1 second(s).\",\n \"errorId\": \"c8a41b47-57bf-ea11-8273-00155d466a31\",\n \"timestamp\": \"2020-07-06T07:07:00.30Z\"\n }\n}", "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-a8388f3b-9023-4993-bf54-f2f8373fe532" }, { "id": "f659690e-07a8-4fa1-a9dc-91b165d10906", "name": "Internal server error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/messages/:umid/pii", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "messages", ":umid", "pii" ], "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 \"example\": {\n \"code\": 2000,\n \"message\": \"Internal server error\",\n \"errorId\": \"db9dced4-3534-4d86-9d18-6b448af0d621\",\n \"timestamp\": \"2018-07-02T09:42:38.8988997+00:00\"\n }\n}", "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-f659690e-07a8-4fa1-a9dc-91b165d10906" } ], "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-357e6865-9f15-44e0-a650-20477faad7dc" } ], "id": "c78a5e48-dccb-455c-8cb5-2e28f9b7d71c", "createdAt": "2026-07-28T00:28:40.000Z", "updatedAt": "2026-07-28T00:28:40.000Z", "uid": "35240-c78a5e48-dccb-455c-8cb5-2e28f9b7d71c" }, { "name": "Retrieve SMS details", "id": "d2a2c30e-e4cf-4fc9-bb91-2e565ae23672", "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": "970ebad7-dbea-45d8-a591-85bfe94d84fa", "key": "subAccountId", "value": "JWp8kfUy_Ye3kgbpf6R30tQKn4X", "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": "a78629ae-cce4-48df-851c-771c9de0496c", "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 *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\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": "498d3b22-5f57-4c0a-ae13-747ed4f89b66", "name": "Response returned with the message details if a message with the UMID is found for the specified sub account.", "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 \"umid\": \"\",\n \"subAccountId\": \"\",\n \"direction\": \"\",\n \"status\": {\n \"state\": \"\",\n \"detail\": \"\",\n \"errorCode\": \"\",\n \"errorMessage\": \"\",\n \"timestamp\": \"\"\n },\n \"msisdn\": \"\",\n \"source\": \"\",\n \"body\": \"**MASKED**\",\n \"encoding\": \"\",\n \"createdAt\": \"\",\n \"smsCount\": \"\",\n \"price\": {\n \"total\": \"\",\n \"perSms\": \"\",\n \"currency\": \"\"\n },\n \"country\": \"\",\n \"clientMessageId\": \"\",\n \"clientBatchId\": \"\",\n \"batchId\": \"\"\n}", "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-498d3b22-5f57-4c0a-ae13-747ed4f89b66" }, { "id": "244441d8-ab5e-4568-86b1-fe1c1eb4d942", "name": "This error response is returned if the request is invalid (e.g. umid is not a valid uuid).", "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 \"message\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-244441d8-ab5e-4568-86b1-fe1c1eb4d942" }, { "id": "eb550f73-4b3d-40ae-a7f5-c8ab14e02074", "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-eb550f73-4b3d-40ae-a7f5-c8ab14e02074" }, { "id": "0e5971d0-f2ff-42ce-a105-fd33bcd55f95", "name": "This error response is returned if there is a message by the specified sub account and umid does not 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 \"message\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-0e5971d0-f2ff-42ce-a105-fd33bcd55f95" }, { "id": "a5369f96-60a9-48e7-aac5-f508d28a2283", "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-a5369f96-60a9-48e7-aac5-f508d28a2283" } ], "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-d2a2c30e-e4cf-4fc9-bb91-2e565ae23672" }, { "name": "Cancel the scheduled SMS", "id": "3ae480c8-fcde-477c-a0b5-5d12683a03d4", "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": "94344a4a-ffd1-4117-a7f5-83db9b42600a", "key": "subAccountId", "value": "JWp8kfUy_Ye3kgbpf6R30tQKn4X", "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": "36f4ac2f-0a9c-4060-a1ca-9c62a3a82d22", "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": "6b15f57d-6827-41e0-b98f-e31e8980d158", "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-6b15f57d-6827-41e0-b98f-e31e8980d158" }, { "id": "501b4475-250c-44c1-9534-7efa05fc8951", "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 \"message\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-501b4475-250c-44c1-9534-7efa05fc8951" }, { "id": "97cfbd2a-9c28-498a-88f2-de3d9617bbd7", "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-97cfbd2a-9c28-498a-88f2-de3d9617bbd7" }, { "id": "203867ba-64da-4694-bd9b-7bd49fd52897", "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 \"message\": \"\",\n \"timestamp\": \"\"\n}", "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-203867ba-64da-4694-bd9b-7bd49fd52897" }, { "id": "80e7e69e-58d7-4f3f-98fa-738fb9e3d502", "name": "Upgrade Required \u2014 client is using an unsupported TLS version", "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": "Upgrade Required (RFC 2817)", "code": 426, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Upgrade", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-80e7e69e-58d7-4f3f-98fa-738fb9e3d502" } ], "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-3ae480c8-fcde-477c-a0b5-5d12683a03d4" } ], "id": "43e41c1d-4e02-4460-9183-b13a7d682406", "createdAt": "2026-07-28T00:28:40.000Z", "updatedAt": "2026-07-28T00:28:40.000Z", "uid": "35240-43e41c1d-4e02-4460-9183-b13a7d682406" }, { "name": "exports", "item": [ { "name": "{jobId}", "item": [ { "name": "Get log export job result", "id": "ef599171-485b-4ca3-a03a-d246bbbd6d86", "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": "7390b633-ff4e-4759-888d-50ad5c425f03", "key": "subAccountId", "value": "JWp8kfUy_Ye3kgbpf6R30tQKn4X", "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": "1ddb91ee-d593-4089-a76d-23412d4a9418", "key": "jobId", "value": "", "description": "(Required) Export job identifier" } ] }, "description": "* Sending a **GET** request on this endpoint allows to **check the status of an SMS 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://sms.8x8.com/api/v1/subaccounts/{subAccountID}/messages/exports/{jobId}`\n\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.\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": "feb6bed3-28de-4e37-bb1c-479e4df186ae", "name": "In case of successful request which comes with a 200 code, you will be presented with a **status** parameter value (string). Here are the possible cases and their meaning:\n\n- **queued** - request for report creation is waiting in the queue\n\n- **running** ", "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\": \"succeeded\",\n \"data\": [\n \"\",\n \"\"\n ],\n \"expires\": \"\"\n}", "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-feb6bed3-28de-4e37-bb1c-479e4df186ae" }, { "id": "06f0f094-4e2f-440c-87d2-bf25a2a13129", "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-06f0f094-4e2f-440c-87d2-bf25a2a13129" } ], "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-ef599171-485b-4ca3-a03a-d246bbbd6d86" }, { "name": "Cancel the log export job ", "id": "958e564d-3e17-4e67-a1e2-b024c1c4132d", "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": "28a17d71-c042-4067-97b4-ec2c90088352", "key": "subAccountId", "value": "JWp8kfUy_Ye3kgbpf6R30tQKn4X", "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": "0e6d20bf-6133-4c26-aa14-5f29cd453b3e", "key": "jobId", "value": "", "description": "(Required) Export job identifier" } ] }, "description": "* Sending a **DELETE** request on this endpoint allows to **cancel a SMS 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 API in the path as well as the 8x8 SMS subaccountid you used in the previous request.\n`https://sms.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": "3d5daef5-79d6-4922-a584-3089a39cd194", "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-3d5daef5-79d6-4922-a584-3089a39cd194" }, { "id": "ebc4183c-492f-4707-b687-3fcd10e4ce2b", "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-ebc4183c-492f-4707-b687-3fcd10e4ce2b" } ], "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-958e564d-3e17-4e67-a1e2-b024c1c4132d" } ], "id": "5c1bc766-2fa3-4bca-a06d-9eeeba61ba7b", "createdAt": "2026-07-28T00:28:40.000Z", "updatedAt": "2026-07-28T00:28:40.000Z", "uid": "35240-5c1bc766-2fa3-4bca-a06d-9eeeba61ba7b" }, { "name": "Start SMS log export job", "id": "f077939d-acf4-4265-a1a0-ef0b8d7c09d1", "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\": \"\"\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": "bc1437a1-3f96-49c7-95bc-5809312e7846", "key": "subAccountId", "value": "JWp8kfUy_Ye3kgbpf6R30tQKn4X", "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 SMS logs file**.\n\n### URL\n\nThe 8x8 SMS `subAccountId` needs to be provided in the URL as shown below:\n`https://sms.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": "0d39a009-6526-4772-9c23-383af1ac5311", "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\": \"\"\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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-0d39a009-6526-4772-9c23-383af1ac5311" } ], "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-f077939d-acf4-4265-a1a0-ef0b8d7c09d1" } ], "id": "97f87c8e-2869-4a17-bfa4-97b463302207", "createdAt": "2026-07-28T00:28:40.000Z", "updatedAt": "2026-07-28T00:28:40.000Z", "uid": "35240-97f87c8e-2869-4a17-bfa4-97b463302207" }, { "name": "Send SMS", "id": "0d3b797c-6f61-4e12-aeea-fa8a1bdc1a97", "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 \"destination\": \"14208361239\",\n \"text\": \"\",\n \"country\": \"\",\n \"source\": \"\",\n \"clientMessageId\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"clientIp\": \"\",\n \"track\": null\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": "ce7871de-5ab4-496c-b9c8-59a79090ccf8", "key": "subAccountId", "value": "JWp8kfUy_Ye3kgbpf6R30tQKn4X", "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 **send SMS individually (1 request per SMS)**.\n* It is ideal to send single personalized messages for use-cases like notifications or alerts.\n\n### URL\nThe 8x8 SMS subaccountid to use is defined in the URL where you send your POST request as shown below:\n`https://sms.8x8.com/api/v1/subaccounts/{subAccountId}/messages`\n\n> You must replace `{subAccountId}` in the URL above with the subaccountid that you want to use." }, "response": [ { "id": "f24619cd-3660-4fca-9ec5-82ba5170e3bc", "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 \"destination\": \"14208361239\",\n \"text\": \"\",\n \"country\": \"\",\n \"source\": \"\",\n \"clientMessageId\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"clientIp\": \"\",\n \"track\": null\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 \"destination\": \"+66741124950348\",\n \"encoding\": \"AUTO\",\n \"status\": {\n \"code\": \"QUEUED\",\n \"description\": \"\"\n },\n \"umid\": \"\",\n \"clientMessageId\": \"\"\n}", "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-f24619cd-3660-4fca-9ec5-82ba5170e3bc" }, { "id": "2c6905b9-2f8e-415f-9e45-adba02422675", "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 \"destination\": \"14208361239\",\n \"text\": \"\",\n \"country\": \"\",\n \"source\": \"\",\n \"clientMessageId\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"clientIp\": \"\",\n \"track\": null\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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-2c6905b9-2f8e-415f-9e45-adba02422675" }, { "id": "fd03d9cc-1ae4-4701-a109-1e59a4004c66", "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 \"destination\": \"14208361239\",\n \"text\": \"\",\n \"country\": \"\",\n \"source\": \"\",\n \"clientMessageId\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"clientIp\": \"\",\n \"track\": null\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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-fd03d9cc-1ae4-4701-a109-1e59a4004c66" }, { "id": "fc07de3a-5bc0-470a-a4ad-2d67defc8e2e", "name": "Upgrade Required \u2014 client is using an unsupported TLS version", "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 \"destination\": \"14208361239\",\n \"text\": \"\",\n \"country\": \"\",\n \"source\": \"\",\n \"clientMessageId\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"clientIp\": \"\",\n \"track\": null\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": "Upgrade Required (RFC 2817)", "code": 426, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Upgrade", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-fc07de3a-5bc0-470a-a4ad-2d67defc8e2e" }, { "id": "35b7ad5f-71fb-4bf6-b575-e3e336fdb744", "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 \"destination\": \"14208361239\",\n \"text\": \"\",\n \"country\": \"\",\n \"source\": \"\",\n \"clientMessageId\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\",\n \"clientIp\": \"\",\n \"track\": null\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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-35b7ad5f-71fb-4bf6-b575-e3e336fdb744" } ], "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-0d3b797c-6f61-4e12-aeea-fa8a1bdc1a97" } ], "id": "f6231957-996e-4fca-9401-377f233ec5ea", "createdAt": "2026-07-28T00:28:40.000Z", "updatedAt": "2026-07-28T00:28:40.000Z", "uid": "35240-f6231957-996e-4fca-9401-377f233ec5ea" }, { "name": "surveys", "item": [ { "name": "{surveyId}", "item": [ { "name": "messages", "item": [ { "name": "batch", "item": [ { "name": "Send SMS Engage surveys as batch", "id": "91f6bf4a-b077-48e2-bc57-987a7a31c8b5", "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 \"destination\": \"75334563\",\n \"country\": \"\",\n \"templateBody\": \"\",\n \"templateVariables\": {},\n \"source\": \"\",\n \"clientMessageId\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\"\n }\n ],\n \"clientBatchId\": \"\",\n \"template\": {\n \"templateBody\": \"\",\n \"source\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\"\n },\n \"includeMessagesInResponse\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/surveys/:surveyId/messages/batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "surveys", ":surveyId", "messages", "batch" ], "variable": [ { "id": "d81d1653-d782-45ad-a6b1-a8717b8a78db", "key": "subAccountId", "value": "JWp8kfUy_Ye3kgbpf6R30tQKn4X", "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": "956eb9b8-93eb-42b1-a450-feac27ab822f", "key": "surveyId", "value": "", "description": "(Required) The surveyId will be provided to you by 8x8. This Id is a unique name of your SMS-to-Form which 8x8 creates based on the use-cases you defined." } ] }, "description": "* Sending a POST request on this endpoint allows to **send SMS Engage surveys by batch (multiple messages per request)**.\n* It is ideal when you want to send a batch of surveys on a recurring manner or based on time parameters (_eg: Order collection at the end of the month_)\n\n### URL\n* The 8x8 subaccountid to use is defined in the URL where you send your POST request as shown below:\n`https://sms.8x8.com/api/v1/subaccounts/{subAccountId}/surveys/{surveyId}/messages/batch`\n" }, "response": [ { "id": "c7d9df03-3c01-409e-8868-c86878ce4011", "name": "OK", "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 \"destination\": \"75334563\",\n \"country\": \"\",\n \"templateBody\": \"\",\n \"templateVariables\": {},\n \"source\": \"\",\n \"clientMessageId\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\"\n }\n ],\n \"clientBatchId\": \"\",\n \"template\": {\n \"templateBody\": \"\",\n \"source\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\"\n },\n \"includeMessagesInResponse\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/surveys/:surveyId/messages/batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "surveys", ":surveyId", "messages", "batch" ], "variable": [ { "key": "subAccountId" }, { "key": "surveyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"acceptedCount\": \"\",\n \"batchId\": \"\",\n \"rejectedCount\": \"\",\n \"clientBatchId\": \"\",\n \"messages\": [\n {\n \"destination\": \"+5730977021\",\n \"encoding\": \"AUTO\",\n \"status\": {\n \"code\": \"QUEUED\",\n \"description\": \"\"\n },\n \"umid\": \"\",\n \"clientMessageId\": \"\"\n },\n {\n \"destination\": \"8518043547592\",\n \"encoding\": \"GSM7\",\n \"status\": {\n \"code\": \"QUEUED\",\n \"description\": \"\"\n },\n \"umid\": \"\",\n \"clientMessageId\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-c7d9df03-3c01-409e-8868-c86878ce4011" }, { "id": "56c877ec-8a2a-45d6-9916-ce7346ee8bd3", "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 \"destination\": \"75334563\",\n \"country\": \"\",\n \"templateBody\": \"\",\n \"templateVariables\": {},\n \"source\": \"\",\n \"clientMessageId\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\"\n }\n ],\n \"clientBatchId\": \"\",\n \"template\": {\n \"templateBody\": \"\",\n \"source\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\"\n },\n \"includeMessagesInResponse\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/surveys/:surveyId/messages/batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "surveys", ":surveyId", "messages", "batch" ], "variable": [ { "key": "subAccountId" }, { "key": "surveyId" } ] } }, "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-56c877ec-8a2a-45d6-9916-ce7346ee8bd3" }, { "id": "8ba10ccf-ba59-4035-a8f8-023ccd3a5ea4", "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 \"destination\": \"75334563\",\n \"country\": \"\",\n \"templateBody\": \"\",\n \"templateVariables\": {},\n \"source\": \"\",\n \"clientMessageId\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\"\n }\n ],\n \"clientBatchId\": \"\",\n \"template\": {\n \"templateBody\": \"\",\n \"source\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\"\n },\n \"includeMessagesInResponse\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/surveys/:surveyId/messages/batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "surveys", ":surveyId", "messages", "batch" ], "variable": [ { "key": "subAccountId" }, { "key": "surveyId" } ] } }, "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-8ba10ccf-ba59-4035-a8f8-023ccd3a5ea4" }, { "id": "de9f5b70-1761-4e65-a58b-a597110907ba", "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 \"destination\": \"75334563\",\n \"country\": \"\",\n \"templateBody\": \"\",\n \"templateVariables\": {},\n \"source\": \"\",\n \"clientMessageId\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\"\n }\n ],\n \"clientBatchId\": \"\",\n \"template\": {\n \"templateBody\": \"\",\n \"source\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\"\n },\n \"includeMessagesInResponse\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/surveys/:surveyId/messages/batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "surveys", ":surveyId", "messages", "batch" ], "variable": [ { "key": "subAccountId" }, { "key": "surveyId" } ] } }, "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-de9f5b70-1761-4e65-a58b-a597110907ba" } ], "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-91f6bf4a-b077-48e2-bc57-987a7a31c8b5" } ], "id": "3d608bc4-2d6a-4db0-83cf-f5a44299f4a3", "createdAt": "2026-07-28T00:28:40.000Z", "updatedAt": "2026-07-28T00:28:40.000Z", "uid": "35240-3d608bc4-2d6a-4db0-83cf-f5a44299f4a3" }, { "name": "Send SMS Engage survey", "id": "0f6a43d8-7b0e-4841-8d34-8e6f3270612d", "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 \"destination\": \"562735336311031\",\n \"country\": \"\",\n \"templateBody\": \"\",\n \"templateVariables\": {},\n \"source\": \"\",\n \"clientMessageId\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/surveys/:surveyId/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "surveys", ":surveyId", "messages" ], "variable": [ { "id": "5a179aae-9dfc-4e73-bf38-9f6d4cf5920e", "key": "subAccountId", "value": "JWp8kfUy_Ye3kgbpf6R30tQKn4X", "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": "edb93fa7-6d44-46aa-a0de-8c2b85ca4111", "key": "surveyId", "value": "", "description": "(Required) The surveyId will be provided to you by 8x8. This Id is a unique name of your SMS-to-Form which 8x8 creates based on the use-cases you defined." } ] }, "description": "### About SMS Engage\n* **SMS Engage** combines the reach of SMS and the power of interactive web surveys\n* Using the API endpoint lets you send SMS containing special links to surveys for any use case: \n\t* Satisfaction feedback (NPS, CSAT, CES..)\n\t* Interactive marketing landing page\n\t* E-commerce confirmations (Order, Delivery, Payment)\n\t* and much more: reach out to learn more! \n* SMS Engage surveys are linked to your 8x8 account: each individual survey response can be tracked back to the original SMS or SMS campaigns: get individual response logs and aggregated analytics in your 8x8 Customer Portal\n* You can also retrieve the SMS Engage response programmatically using the dedicated webhook\n\n### About the API endpoint / method\n* Sending a POST request on this endpoint allows to **send SMS Engage individually (1 message per request)**.\n* It is ideal when you want to integrate surveys as part of your customer experience and trigger an SMS Engage following an event occurring in your application (_eg: NPS survey sent after customer support interaction_)\n\n### URL\nThe 8x8 SMS subaccountid to use is defined in the URL where you send your POST request as shown below:\n`https://sms.8x8.com/api/v1/subaccounts/{subAccountId}/surveys/{surveyId}/messages`\n\n> You must replace `{subAccountId}` in the URL above with the subaccountid that you want to use.\n\n### Before you start\n\n* You must have your account activated to use SMS Engage and at least one SMS Engage form created for you by 8x8. SMS Engage forms are created based on your use-cases. Once they are created, 8x8 will provide you a **surveyid** and **url**.\n* Please note that the variable **url** is your default SMS Engage link which 8x8 has set up for you (e.g. http://smstoweb.net?sid=1234). The url is shortened once the message has been sent.\n* The shortened url is always 21 characters in length.\n* If you want to get the data via Webhooks, simply provide us a specific url where we will post the data. \n* For more information please contact your account manager or customer support team." }, "response": [ { "id": "ce4e9524-0c45-43b3-bcf3-52ed8e952833", "name": "OK", "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 \"destination\": \"562735336311031\",\n \"country\": \"\",\n \"templateBody\": \"\",\n \"templateVariables\": {},\n \"source\": \"\",\n \"clientMessageId\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/surveys/:surveyId/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "surveys", ":surveyId", "messages" ], "variable": [ { "key": "subAccountId" }, { "key": "surveyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"destination\": \"+66741124950348\",\n \"encoding\": \"AUTO\",\n \"status\": {\n \"code\": \"QUEUED\",\n \"description\": \"\"\n },\n \"umid\": \"\",\n \"clientMessageId\": \"\"\n}", "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-ce4e9524-0c45-43b3-bcf3-52ed8e952833" }, { "id": "aaae1bd7-4399-4ec2-be1c-2c3fc960b1f2", "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 \"destination\": \"562735336311031\",\n \"country\": \"\",\n \"templateBody\": \"\",\n \"templateVariables\": {},\n \"source\": \"\",\n \"clientMessageId\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/surveys/:surveyId/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "surveys", ":surveyId", "messages" ], "variable": [ { "key": "subAccountId" }, { "key": "surveyId" } ] } }, "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-aaae1bd7-4399-4ec2-be1c-2c3fc960b1f2" }, { "id": "906242ea-deef-45b5-bbf1-6fd4e1b22988", "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 \"destination\": \"562735336311031\",\n \"country\": \"\",\n \"templateBody\": \"\",\n \"templateVariables\": {},\n \"source\": \"\",\n \"clientMessageId\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/surveys/:surveyId/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "surveys", ":surveyId", "messages" ], "variable": [ { "key": "subAccountId" }, { "key": "surveyId" } ] } }, "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-906242ea-deef-45b5-bbf1-6fd4e1b22988" }, { "id": "24bc21ea-70db-4a65-94ae-8549eb1c5f76", "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 \"destination\": \"562735336311031\",\n \"country\": \"\",\n \"templateBody\": \"\",\n \"templateVariables\": {},\n \"source\": \"\",\n \"clientMessageId\": \"\",\n \"encoding\": \"AUTO\",\n \"scheduled\": \"\",\n \"expiry\": \"\",\n \"dlrCallbackUrl\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/subaccounts/:subAccountId/surveys/:surveyId/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "subaccounts", ":subAccountId", "surveys", ":surveyId", "messages" ], "variable": [ { "key": "subAccountId" }, { "key": "surveyId" } ] } }, "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-24bc21ea-70db-4a65-94ae-8549eb1c5f76" } ], "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-0f6a43d8-7b0e-4841-8d34-8e6f3270612d" } ], "id": "46452b03-e117-4045-b854-27f8293455b5", "createdAt": "2026-07-28T00:28:40.000Z", "updatedAt": "2026-07-28T00:28:40.000Z", "uid": "35240-46452b03-e117-4045-b854-27f8293455b5" } ], "id": "9fa41085-4338-46bc-af7e-cd04427912b4", "createdAt": "2026-07-28T00:28:40.000Z", "updatedAt": "2026-07-28T00:28:40.000Z", "uid": "35240-9fa41085-4338-46bc-af7e-cd04427912b4" } ], "id": "8d4cd75f-845c-49b6-8dc1-5e92f5d6a7c7", "createdAt": "2026-07-28T00:28:40.000Z", "updatedAt": "2026-07-28T00:28:40.000Z", "uid": "35240-8d4cd75f-845c-49b6-8dc1-5e92f5d6a7c7" } ], "id": "ad17d30a-83bd-4533-91c0-9d9a850652d2", "createdAt": "2026-07-28T00:28:40.000Z", "updatedAt": "2026-07-28T00:28:40.000Z", "uid": "35240-ad17d30a-83bd-4533-91c0-9d9a850652d2" } ], "id": "82b19981-9b39-4f91-9f4f-c216bdb818db", "createdAt": "2026-07-28T00:28:40.000Z", "updatedAt": "2026-07-28T00:28:40.000Z", "uid": "35240-82b19981-9b39-4f91-9f4f-c216bdb818db" }, { "name": "accounts", "item": [ { "name": "{accountId}", "item": [ { "name": "prices", "item": [ { "name": "Get SMS price list", "id": "a2b492da-34c4-40d1-8f95-4e26fdcc1847", "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/prices?country=&mcc=&mnc=&direction=inbound&subAccountId=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "prices" ], "query": [ { "description": "Country code. Should be 2-letter ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)) code.", "key": "country", "value": "" }, { "description": "[Mobile country code](https://en.wikipedia.org/wiki/Mobile_country_code).\n**MCC should always come in pair with MNC parameter.**", "key": "mcc", "value": "" }, { "description": "Mobile network code.\n**MNC should always come in pair with MCC parameter.**", "key": "mnc", "value": "" }, { "description": "Direction: outbound or inbound.", "key": "direction", "value": "inbound" }, { "description": "Filter price list by subaccount id.", "key": "subAccountId", "value": "" } ], "variable": [ { "id": "23e3d601-a155-4b2b-8df3-4b2302085374", "key": "accountId", "value": "aA95F4a8cEC19BD4c07905EabDdEbDDE", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." } ] }, "description": "* Sending a **GET** request on this endpoint allows to **get prices** based on different criteria.\n" }, "response": [ { "id": "9cdf2294-36b4-423f-8b6c-534ee7e2148d", "name": "Price list 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/prices?country=&mcc=&mnc=&direction=inbound&subAccountId=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "prices" ], "query": [ { "description": "Country code. Should be 2-letter ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)) code.", "key": "country", "value": "" }, { "description": "[Mobile country code](https://en.wikipedia.org/wiki/Mobile_country_code).\n**MCC should always come in pair with MNC parameter.**", "key": "mcc", "value": "" }, { "description": "Mobile network code.\n**MNC should always come in pair with MCC parameter.**", "key": "mnc", "value": "" }, { "description": "Direction: outbound or inbound.", "key": "direction", "value": "inbound" }, { "description": "Filter price list by subaccount id.", "key": "subAccountId", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"subAccounts\": [\n {\n \"subAccountId\": \"\",\n \"outbound\": [\n {\n \"countries\": [\n {\n \"alpha2Code\": \"\",\n \"countryName\": \"\",\n \"dialingPrefix\": \"\",\n \"operators\": [\n {\n \"operatorName\": \"\",\n \"operatorId\": \"\",\n \"hni\": [\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n },\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n }\n ],\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"operatorName\": \"\",\n \"operatorId\": \"\",\n \"hni\": [\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n },\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n }\n ],\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n },\n {\n \"alpha2Code\": \"\",\n \"countryName\": \"\",\n \"dialingPrefix\": \"\",\n \"operators\": [\n {\n \"operatorName\": \"\",\n \"operatorId\": \"\",\n \"hni\": [\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n },\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n }\n ],\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"operatorName\": \"\",\n \"operatorId\": \"\",\n \"hni\": [\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n },\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n }\n ],\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n }\n ]\n },\n {\n \"countries\": [\n {\n \"alpha2Code\": \"\",\n \"countryName\": \"\",\n \"dialingPrefix\": \"\",\n \"operators\": [\n {\n \"operatorName\": \"\",\n \"operatorId\": \"\",\n \"hni\": [\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n },\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n }\n ],\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"operatorName\": \"\",\n \"operatorId\": \"\",\n \"hni\": [\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n },\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n }\n ],\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n },\n {\n \"alpha2Code\": \"\",\n \"countryName\": \"\",\n \"dialingPrefix\": \"\",\n \"operators\": [\n {\n \"operatorName\": \"\",\n \"operatorId\": \"\",\n \"hni\": [\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n },\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n }\n ],\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"operatorName\": \"\",\n \"operatorId\": \"\",\n \"hni\": [\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n },\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n }\n ],\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n }\n ]\n }\n ],\n \"inbound\": [\n {\n \"alpha2Code\": \"\",\n \"countryName\": \"\",\n \"dialingPrefix\": \"\",\n \"numberTypes\": [\n {\n \"type\": \"tollfree\",\n \"defaultPrice\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"type\": \"longcode\",\n \"defaultPrice\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n },\n {\n \"alpha2Code\": \"\",\n \"countryName\": \"\",\n \"dialingPrefix\": \"\",\n \"numberTypes\": [\n {\n \"type\": \"longcode\",\n \"defaultPrice\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"type\": \"shortCodeFTEU\",\n \"defaultPrice\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n }\n ]\n },\n {\n \"subAccountId\": \"\",\n \"outbound\": [\n {\n \"countries\": [\n {\n \"alpha2Code\": \"\",\n \"countryName\": \"\",\n \"dialingPrefix\": \"\",\n \"operators\": [\n {\n \"operatorName\": \"\",\n \"operatorId\": \"\",\n \"hni\": [\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n },\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n }\n ],\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"operatorName\": \"\",\n \"operatorId\": \"\",\n \"hni\": [\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n },\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n }\n ],\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n },\n {\n \"alpha2Code\": \"\",\n \"countryName\": \"\",\n \"dialingPrefix\": \"\",\n \"operators\": [\n {\n \"operatorName\": \"\",\n \"operatorId\": \"\",\n \"hni\": [\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n },\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n }\n ],\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"operatorName\": \"\",\n \"operatorId\": \"\",\n \"hni\": [\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n },\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n }\n ],\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n }\n ]\n },\n {\n \"countries\": [\n {\n \"alpha2Code\": \"\",\n \"countryName\": \"\",\n \"dialingPrefix\": \"\",\n \"operators\": [\n {\n \"operatorName\": \"\",\n \"operatorId\": \"\",\n \"hni\": [\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n },\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n }\n ],\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"operatorName\": \"\",\n \"operatorId\": \"\",\n \"hni\": [\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n },\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n }\n ],\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n },\n {\n \"alpha2Code\": \"\",\n \"countryName\": \"\",\n \"dialingPrefix\": \"\",\n \"operators\": [\n {\n \"operatorName\": \"\",\n \"operatorId\": \"\",\n \"hni\": [\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n },\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n }\n ],\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"operatorName\": \"\",\n \"operatorId\": \"\",\n \"hni\": [\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n },\n {\n \"mcc\": \"\",\n \"mnc\": \"\"\n }\n ],\n \"price\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n }\n ]\n }\n ],\n \"inbound\": [\n {\n \"alpha2Code\": \"\",\n \"countryName\": \"\",\n \"dialingPrefix\": \"\",\n \"numberTypes\": [\n {\n \"type\": \"shortCodePremium\",\n \"defaultPrice\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"type\": \"shortCodePremium\",\n \"defaultPrice\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n },\n {\n \"alpha2Code\": \"\",\n \"countryName\": \"\",\n \"dialingPrefix\": \"\",\n \"numberTypes\": [\n {\n \"type\": \"shortCodeP2P\",\n \"defaultPrice\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n {\n \"type\": \"longcode\",\n \"defaultPrice\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n }\n ]\n }\n ]\n}", "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-9cdf2294-36b4-423f-8b6c-534ee7e2148d" }, { "id": "6ff892c9-3785-489c-8787-85b5457be40b", "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/prices?country=&mcc=&mnc=&direction=inbound&subAccountId=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "prices" ], "query": [ { "description": "Country code. Should be 2-letter ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)) code.", "key": "country", "value": "" }, { "description": "[Mobile country code](https://en.wikipedia.org/wiki/Mobile_country_code).\n**MCC should always come in pair with MNC parameter.**", "key": "mcc", "value": "" }, { "description": "Mobile network code.\n**MNC should always come in pair with MCC parameter.**", "key": "mnc", "value": "" }, { "description": "Direction: outbound or inbound.", "key": "direction", "value": "inbound" }, { "description": "Filter price list by subaccount id.", "key": "subAccountId", "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-6ff892c9-3785-489c-8787-85b5457be40b" }, { "id": "ae0af77c-c157-4f38-8019-1a8d012d1e7e", "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/prices?country=&mcc=&mnc=&direction=inbound&subAccountId=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "prices" ], "query": [ { "description": "Country code. Should be 2-letter ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)) code.", "key": "country", "value": "" }, { "description": "[Mobile country code](https://en.wikipedia.org/wiki/Mobile_country_code).\n**MCC should always come in pair with MNC parameter.**", "key": "mcc", "value": "" }, { "description": "Mobile network code.\n**MNC should always come in pair with MCC parameter.**", "key": "mnc", "value": "" }, { "description": "Direction: outbound or inbound.", "key": "direction", "value": "inbound" }, { "description": "Filter price list by subaccount id.", "key": "subAccountId", "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-ae0af77c-c157-4f38-8019-1a8d012d1e7e" }, { "id": "c9479a14-c725-4ca4-841d-6c12b89b8907", "name": "Upgrade Required \u2014 client is using an unsupported TLS version", "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/prices?country=&mcc=&mnc=&direction=inbound&subAccountId=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "prices" ], "query": [ { "description": "Country code. Should be 2-letter ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)) code.", "key": "country", "value": "" }, { "description": "[Mobile country code](https://en.wikipedia.org/wiki/Mobile_country_code).\n**MCC should always come in pair with MNC parameter.**", "key": "mcc", "value": "" }, { "description": "Mobile network code.\n**MNC should always come in pair with MCC parameter.**", "key": "mnc", "value": "" }, { "description": "Direction: outbound or inbound.", "key": "direction", "value": "inbound" }, { "description": "Filter price list by subaccount id.", "key": "subAccountId", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Upgrade Required (RFC 2817)", "code": 426, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Upgrade", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"errorId\": \"\",\n \"timestamp\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-c9479a14-c725-4ca4-841d-6c12b89b8907" }, { "id": "de80a713-2a79-4238-a7ff-869cd09308f3", "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/accounts/:accountId/prices?country=&mcc=&mnc=&direction=inbound&subAccountId=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "prices" ], "query": [ { "description": "Country code. Should be 2-letter ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)) code.", "key": "country", "value": "" }, { "description": "[Mobile country code](https://en.wikipedia.org/wiki/Mobile_country_code).\n**MCC should always come in pair with MNC parameter.**", "key": "mcc", "value": "" }, { "description": "Mobile network code.\n**MNC should always come in pair with MCC parameter.**", "key": "mnc", "value": "" }, { "description": "Direction: outbound or inbound.", "key": "direction", "value": "inbound" }, { "description": "Filter price list by subaccount id.", "key": "subAccountId", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-de80a713-2a79-4238-a7ff-869cd09308f3" }, { "id": "7fd50020-15af-40a7-9e43-e4914e2ee220", "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/prices?country=&mcc=&mnc=&direction=inbound&subAccountId=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "prices" ], "query": [ { "description": "Country code. Should be 2-letter ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)) code.", "key": "country", "value": "" }, { "description": "[Mobile country code](https://en.wikipedia.org/wiki/Mobile_country_code).\n**MCC should always come in pair with MNC parameter.**", "key": "mcc", "value": "" }, { "description": "Mobile network code.\n**MNC should always come in pair with MCC parameter.**", "key": "mnc", "value": "" }, { "description": "Direction: outbound or inbound.", "key": "direction", "value": "inbound" }, { "description": "Filter price list by subaccount id.", "key": "subAccountId", "value": "" } ], "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-7fd50020-15af-40a7-9e43-e4914e2ee220" } ], "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-a2b492da-34c4-40d1-8f95-4e26fdcc1847" } ], "id": "26fa415c-42f2-4245-b598-5a4f6f21bdd2", "createdAt": "2026-07-28T00:28:40.000Z", "updatedAt": "2026-07-28T00:28:40.000Z", "uid": "35240-26fa415c-42f2-4245-b598-5a4f6f21bdd2" }, { "name": "balance", "item": [ { "name": "Get account balance", "id": "c8c70d53-ff85-4232-b7fa-7aca0b0099b2", "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/balance", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "balance" ], "variable": [ { "id": "aeb15f6b-740d-4b55-858f-97da1f62eae6", "key": "accountId", "value": "aA95F4a8cEC19BD4c07905EabDdEbDDE", "description": "(Required) You must replace *{accountId}* with the accountid that you want to use." } ] }, "description": "* Sending a **GET** request on this endpoint allows to **get account balance**.\n\n\n> Note: this resource is available for prepaid customers only." }, "response": [ { "id": "4a6135af-c418-474f-af97-e4a958a97f5d", "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/balance", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "balance" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"balance\": \"\",\n \"currency\": \"\"\n}", "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-4a6135af-c418-474f-af97-e4a958a97f5d" }, { "id": "3aed4edc-d63c-4b38-a2d7-fb04967f33a1", "name": "Resource is available for prepaid customers only", "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/balance", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "balance" ], "variable": [ { "key": "accountId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"example\": {\n \"code\": 1201,\n \"message\": \"Account not in prepaid mode\",\n \"errorId\": \"c388daa9-980e-eb11-81f8-0433c2195dfb\",\n \"timestamp\": \"2020-10-15T03:44:02.25Z\"\n }\n}", "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-3aed4edc-d63c-4b38-a2d7-fb04967f33a1" }, { "id": "fbb15e7c-4c3f-40c0-b19e-dc6163361a71", "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/accounts/:accountId/balance", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "balance" ], "variable": [ { "key": "accountId" } ] } }, "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-fbb15e7c-4c3f-40c0-b19e-dc6163361a71" }, { "id": "2b6856cf-b296-43f8-8170-c3b7e22dfc2e", "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/balance", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "balance" ], "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-2b6856cf-b296-43f8-8170-c3b7e22dfc2e" } ], "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-c8c70d53-ff85-4232-b7fa-7aca0b0099b2" } ], "id": "fc2e4dbb-421b-433f-bc57-46c91e0928c1", "createdAt": "2026-07-28T00:28:40.000Z", "updatedAt": "2026-07-28T00:28:40.000Z", "uid": "35240-fc2e4dbb-421b-433f-bc57-46c91e0928c1" }, { "name": "webhooks", "item": [ { "name": "Get all Webhooks for Account", "id": "16908605-14bc-4099-b417-98eb35589085", "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": "15a91f7f-8988-43bf-82f4-0681157660d6", "key": "accountId", "value": "aA95F4a8cEC19BD4c07905EabDdEbDDE", "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": "f36a3172-c1ce-4312-8064-c9e3f11bde7e", "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\": \"header\",\n \"scope\": \"\"\n }\n },\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]", "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-f36a3172-c1ce-4312-8064-c9e3f11bde7e" }, { "id": "50e968d1-12b4-418a-815c-9fb7d325dfb6", "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-50e968d1-12b4-418a-815c-9fb7d325dfb6" }, { "id": "18bcbb5b-9338-41d6-ae42-039019006397", "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-18bcbb5b-9338-41d6-ae42-039019006397" }, { "id": "316d78c0-e7b1-4e6d-a8a9-00b377747f2c", "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-316d78c0-e7b1-4e6d-a8a9-00b377747f2c" } ], "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-16908605-14bc-4099-b417-98eb35589085" }, { "name": "Create or Replace webhooks", "id": "450fcf16-555c-4392-bfd8-acc7cc97046e", "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 \"oauth\": {\n \"url\": \"\",\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"credentialsLocation\": \"header\",\n \"scope\": \"\"\n }\n },\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]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/accounts/:accountId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":accountId", "webhooks" ], "variable": [ { "id": "3b4bc841-253d-41d3-8a8f-a2b1c3d12200", "key": "accountId", "value": "aA95F4a8cEC19BD4c07905EabDdEbDDE", "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": "b853c888-aa27-4314-9407-f9feb82f74d4", "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 \"oauth\": {\n \"url\": \"\",\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"credentialsLocation\": \"header\",\n \"scope\": \"\"\n }\n },\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]", "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-b853c888-aa27-4314-9407-f9feb82f74d4" }, { "id": "478bf153-0513-4267-9f93-cd30cdcd9ae6", "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 \"oauth\": {\n \"url\": \"\",\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"credentialsLocation\": \"header\",\n \"scope\": \"\"\n }\n },\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]", "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-478bf153-0513-4267-9f93-cd30cdcd9ae6" }, { "id": "475f5a16-6930-4e87-88ee-54c7d2e4770e", "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 \"oauth\": {\n \"url\": \"\",\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"credentialsLocation\": \"header\",\n \"scope\": \"\"\n }\n },\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]", "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-475f5a16-6930-4e87-88ee-54c7d2e4770e" }, { "id": "198b35b5-f9d0-43fb-8cff-98e9d3ae95bb", "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 \"oauth\": {\n \"url\": \"\",\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"credentialsLocation\": \"header\",\n \"scope\": \"\"\n }\n },\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]", "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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-198b35b5-f9d0-43fb-8cff-98e9d3ae95bb" } ], "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-450fcf16-555c-4392-bfd8-acc7cc97046e" }, { "name": "Delete webhooks", "id": "6e3ee270-67ea-404d-88dc-e3975b03f22a", "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 },\n {\n \"subAccountId\": \"\"\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": "8e48c053-4bf9-45b1-af11-e766914d9f70", "key": "accountId", "value": "aA95F4a8cEC19BD4c07905EabDdEbDDE", "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": "aa4f30ca-39f3-45c4-a629-dd369ad1f99d", "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 },\n {\n \"subAccountId\": \"\"\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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-aa4f30ca-39f3-45c4-a629-dd369ad1f99d" }, { "id": "144c7f02-025c-4d26-bd73-50e271db2758", "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 },\n {\n \"subAccountId\": \"\"\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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-144c7f02-025c-4d26-bd73-50e271db2758" }, { "id": "f8aaa1ec-8e3a-476e-afc4-950b4ca23ac7", "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 },\n {\n \"subAccountId\": \"\"\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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-f8aaa1ec-8e3a-476e-afc4-950b4ca23ac7" }, { "id": "b66444b6-3775-4131-8626-a54e35c44b1d", "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 },\n {\n \"subAccountId\": \"\"\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:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-b66444b6-3775-4131-8626-a54e35c44b1d" } ], "createdAt": "2026-07-28T00:28:41.000Z", "updatedAt": "2026-07-28T00:28:41.000Z", "uid": "35240-6e3ee270-67ea-404d-88dc-e3975b03f22a" } ], "id": "0f896878-3c49-42dd-bb4a-0b7d693f06b7", "createdAt": "2026-07-28T00:28:40.000Z", "updatedAt": "2026-07-28T00:28:40.000Z", "uid": "35240-0f896878-3c49-42dd-bb4a-0b7d693f06b7" } ], "id": "b2eae4c9-a6bd-4c1d-ac9d-9c27140474c8", "createdAt": "2026-07-28T00:28:40.000Z", "updatedAt": "2026-07-28T00:28:40.000Z", "uid": "35240-b2eae4c9-a6bd-4c1d-ac9d-9c27140474c8" } ], "id": "4be47649-b065-4ee9-8887-00b7c22be6d2", "createdAt": "2026-07-28T00:28:40.000Z", "updatedAt": "2026-07-28T00:28:40.000Z", "uid": "35240-4be47649-b065-4ee9-8887-00b7c22be6d2" } ], "id": "89b671d7-4f5b-430c-9a64-fd34f23bb182", "createdAt": "2026-07-28T00:28:40.000Z", "updatedAt": "2026-07-28T00:28:40.000Z", "uid": "35240-89b671d7-4f5b-430c-9a64-fd34f23bb182" } ], "id": "89a03c08-3dc5-4b32-958b-cb5402b82a32", "createdAt": "2026-07-28T00:28:40.000Z", "updatedAt": "2026-07-28T00:28:40.000Z", "uid": "35240-89a03c08-3dc5-4b32-958b-cb5402b82a32" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://sms.8x8.com" } ] }