{ "info": { "_postman_id": "17f6b1c8-94be-4d29-bd48-61eabee3c871", "name": "Transmit Message API", "description": "Transmit APIs", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:01:22.000Z", "updatedAt": "2026-07-28T02:01:22.000Z", "lastUpdatedBy": "35240", "uid": "35240-17f6b1c8-94be-4d29-bd48-61eabee3c871" }, "item": [ { "name": "v2", "item": [ { "name": "whatsapp", "item": [ { "name": "messages", "item": [ { "name": "{id}", "item": [ { "name": "Get WhatsApp message", "id": "650d1ecd-295c-4199-ba4f-aa399942eded", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/whatsapp/messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "whatsapp", "messages", ":id" ], "variable": [ { "id": "dcd50484-4164-422a-acc6-1d44da2fbc80", "key": "id", "value": "", "description": "(Required) Unique identifier of the WhatsApp message to retrieve" } ] }, "description": "Retrieves details of a previously sent WhatsApp message by its unique identifier.\nReturns message content, delivery status, and metadata.\n" }, "response": [ { "id": "fbc555ee-06d6-4007-a4c5-e86ffe37ace5", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/whatsapp/messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "whatsapp", "messages", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"account_id\": \"\",\n \"sender\": \"\",\n \"recipient\": \"\",\n \"content_type\": \"custom\",\n \"content\": {\n \"text\": {\n \"message\": \"\"\n }\n },\n \"created_at\": \"\",\n \"status\": \"DELIVERED\",\n \"message_ref\": \"\",\n \"campaign_id\": \"\",\n \"sms_fallback\": {\n \"message\": \"\",\n \"sender\": \"\"\n },\n \"events\": [\n {\n \"event_type\": \"SENT\",\n \"created_at\": \"\",\n \"details\": \"\"\n },\n {\n \"event_type\": \"READ\",\n \"created_at\": \"\",\n \"details\": \"\"\n }\n ]\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-fbc555ee-06d6-4007-a4c5-e86ffe37ace5" }, { "id": "def2180d-2fbc-486b-a3f8-30d2541b823e", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/whatsapp/messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "whatsapp", "messages", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-def2180d-2fbc-486b-a3f8-30d2541b823e" }, { "id": "a45be48c-5019-44a5-9837-7186dc66ac13", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/whatsapp/messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "whatsapp", "messages", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-a45be48c-5019-44a5-9837-7186dc66ac13" }, { "id": "676cac36-e400-4b17-8f10-63c989560595", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/whatsapp/messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "whatsapp", "messages", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-676cac36-e400-4b17-8f10-63c989560595" } ], "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-650d1ecd-295c-4199-ba4f-aa399942eded" } ], "id": "b2a97d96-3b3b-439d-a03e-7604301ac356", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-b2a97d96-3b3b-439d-a03e-7604301ac356" }, { "name": "List WhatsApp messages", "id": "02dd98b4-dc14-4889-93f6-99c857a34fee", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/whatsapp/messages?date_range=all&start_date=&end_date=&limit=25&cursor=&direction=next&campaign_id=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "whatsapp", "messages" ], "query": [ { "description": "Predefined date range filter. Preset ranges use your account timezone to calculate relative dates:\n- 'last_week': Last 7 days from midnight in your account timezone\n- 'last_thirty': Last 30 days from midnight in your account timezone\n- 'last_month': Previous calendar month in your account timezone\n- 'all': All dates (limited to last 365 days) - default\n- 'custom_date': Use start_date and end_date parameters with explicit RFC3339 timestamps\n", "key": "date_range", "value": "all" }, { "description": "Start date for custom date range in RFC3339 format (e.g., 2025-08-26T10:30:00Z).\nRequired when date_range is 'custom_date'.\nMust be before end_date.\n", "key": "start_date", "value": "" }, { "description": "End date for custom date range in RFC3339 format (e.g., 2025-08-26T23:59:59Z).\nRequired when date_range is 'custom_date'.\nMust be after start_date.\nThe range between start_date and end_date cannot exceed 90 days.\n", "key": "end_date", "value": "" }, { "description": "Maximum number of messages to return per page (1-100, default 25).", "key": "limit", "value": "25" }, { "description": "Pagination cursor returned from a previous request.\nPass the next_cursor or prev_cursor value from a previous response\nto fetch the next or previous page of results. Omit for the first page.\n", "key": "cursor", "value": "" }, { "description": "Pagination direction when using a cursor:\n- 'next': Get older messages (default, moves forward through history)\n- 'prev': Get newer messages (moves backward through history)\n", "key": "direction", "value": "next" }, { "description": "Restrict results to messages belonging to a single campaign (UUID).\nOmit to return messages across all campaigns.\n", "key": "campaign_id", "value": "" } ] }, "description": "Retrieves a list of WhatsApp messages for your account with flexible date filtering.\n\nMessages are returned in reverse chronological order (newest first).\n\n**Date Filtering:**\n- Preset ranges (last_week, last_thirty, last_month): Calculated using your account timezone\n- Custom date ranges: Use RFC3339 timestamps (max 90 days)\n- The 'all' option provides up to 365 days of history\n- All timestamps in responses are returned in UTC format\n\n**Pagination:**\n- Cursor-based pagination for efficient data retrieval\n- Control page size with the limit parameter (1-100 messages per page)\n" }, "response": [ { "id": "40206f3d-88eb-4e3e-a86d-a37f68ebfe4d", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/whatsapp/messages?date_range=all&start_date=&end_date=&limit=25&cursor=&direction=next&campaign_id=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "whatsapp", "messages" ], "query": [ { "description": "Predefined date range filter. Preset ranges use your account timezone to calculate relative dates:\n- 'last_week': Last 7 days from midnight in your account timezone\n- 'last_thirty': Last 30 days from midnight in your account timezone\n- 'last_month': Previous calendar month in your account timezone\n- 'all': All dates (limited to last 365 days) - default\n- 'custom_date': Use start_date and end_date parameters with explicit RFC3339 timestamps\n", "key": "date_range", "value": "all" }, { "description": "Start date for custom date range in RFC3339 format (e.g., 2025-08-26T10:30:00Z).\nRequired when date_range is 'custom_date'.\nMust be before end_date.\n", "key": "start_date", "value": "" }, { "description": "End date for custom date range in RFC3339 format (e.g., 2025-08-26T23:59:59Z).\nRequired when date_range is 'custom_date'.\nMust be after start_date.\nThe range between start_date and end_date cannot exceed 90 days.\n", "key": "end_date", "value": "" }, { "description": "Maximum number of messages to return per page (1-100, default 25).", "key": "limit", "value": "25" }, { "description": "Pagination cursor returned from a previous request.\nPass the next_cursor or prev_cursor value from a previous response\nto fetch the next or previous page of results. Omit for the first page.\n", "key": "cursor", "value": "" }, { "description": "Pagination direction when using a cursor:\n- 'next': Get older messages (default, moves forward through history)\n- 'prev': Get newer messages (moves backward through history)\n", "key": "direction", "value": "next" }, { "description": "Restrict results to messages belonging to a single campaign (UUID).\nOmit to return messages across all campaigns.\n", "key": "campaign_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"messages\": [\n {\n \"id\": \"\",\n \"sender\": \"\",\n \"recipient\": \"\",\n \"content_type\": \"custom\",\n \"content\": {\n \"text\": {\n \"message\": \"\"\n }\n },\n \"status\": \"FAILED\",\n \"created_at\": \"\",\n \"message_ref\": \"\",\n \"campaign_id\": \"\"\n },\n {\n \"id\": \"\",\n \"sender\": \"\",\n \"recipient\": \"\",\n \"content_type\": \"custom\",\n \"content\": {\n \"text\": {\n \"message\": \"\"\n }\n },\n \"status\": \"SENT\",\n \"created_at\": \"\",\n \"message_ref\": \"\",\n \"campaign_id\": \"\"\n }\n ]\n },\n \"request\": {},\n \"meta\": {\n \"pagination\": {\n \"type\": \"cursor\",\n \"has_next\": \"\",\n \"has_prev\": \"\",\n \"next_cursor\": \"\",\n \"prev_cursor\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-40206f3d-88eb-4e3e-a86d-a37f68ebfe4d" }, { "id": "233d4fd3-f33c-4c6c-a9c1-c70838272ea0", "name": "Input Validation Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/whatsapp/messages?date_range=all&start_date=&end_date=&limit=25&cursor=&direction=next&campaign_id=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "whatsapp", "messages" ], "query": [ { "description": "Predefined date range filter. Preset ranges use your account timezone to calculate relative dates:\n- 'last_week': Last 7 days from midnight in your account timezone\n- 'last_thirty': Last 30 days from midnight in your account timezone\n- 'last_month': Previous calendar month in your account timezone\n- 'all': All dates (limited to last 365 days) - default\n- 'custom_date': Use start_date and end_date parameters with explicit RFC3339 timestamps\n", "key": "date_range", "value": "all" }, { "description": "Start date for custom date range in RFC3339 format (e.g., 2025-08-26T10:30:00Z).\nRequired when date_range is 'custom_date'.\nMust be before end_date.\n", "key": "start_date", "value": "" }, { "description": "End date for custom date range in RFC3339 format (e.g., 2025-08-26T23:59:59Z).\nRequired when date_range is 'custom_date'.\nMust be after start_date.\nThe range between start_date and end_date cannot exceed 90 days.\n", "key": "end_date", "value": "" }, { "description": "Maximum number of messages to return per page (1-100, default 25).", "key": "limit", "value": "25" }, { "description": "Pagination cursor returned from a previous request.\nPass the next_cursor or prev_cursor value from a previous response\nto fetch the next or previous page of results. Omit for the first page.\n", "key": "cursor", "value": "" }, { "description": "Pagination direction when using a cursor:\n- 'next': Get older messages (default, moves forward through history)\n- 'prev': Get newer messages (moves backward through history)\n", "key": "direction", "value": "next" }, { "description": "Restrict results to messages belonging to a single campaign (UUID).\nOmit to return messages across all campaigns.\n", "key": "campaign_id", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"issues\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-233d4fd3-f33c-4c6c-a9c1-c70838272ea0" }, { "id": "e32b526c-0f2d-4086-ab3e-988a36ceee47", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/whatsapp/messages?date_range=all&start_date=&end_date=&limit=25&cursor=&direction=next&campaign_id=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "whatsapp", "messages" ], "query": [ { "description": "Predefined date range filter. Preset ranges use your account timezone to calculate relative dates:\n- 'last_week': Last 7 days from midnight in your account timezone\n- 'last_thirty': Last 30 days from midnight in your account timezone\n- 'last_month': Previous calendar month in your account timezone\n- 'all': All dates (limited to last 365 days) - default\n- 'custom_date': Use start_date and end_date parameters with explicit RFC3339 timestamps\n", "key": "date_range", "value": "all" }, { "description": "Start date for custom date range in RFC3339 format (e.g., 2025-08-26T10:30:00Z).\nRequired when date_range is 'custom_date'.\nMust be before end_date.\n", "key": "start_date", "value": "" }, { "description": "End date for custom date range in RFC3339 format (e.g., 2025-08-26T23:59:59Z).\nRequired when date_range is 'custom_date'.\nMust be after start_date.\nThe range between start_date and end_date cannot exceed 90 days.\n", "key": "end_date", "value": "" }, { "description": "Maximum number of messages to return per page (1-100, default 25).", "key": "limit", "value": "25" }, { "description": "Pagination cursor returned from a previous request.\nPass the next_cursor or prev_cursor value from a previous response\nto fetch the next or previous page of results. Omit for the first page.\n", "key": "cursor", "value": "" }, { "description": "Pagination direction when using a cursor:\n- 'next': Get older messages (default, moves forward through history)\n- 'prev': Get newer messages (moves backward through history)\n", "key": "direction", "value": "next" }, { "description": "Restrict results to messages belonging to a single campaign (UUID).\nOmit to return messages across all campaigns.\n", "key": "campaign_id", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-e32b526c-0f2d-4086-ab3e-988a36ceee47" }, { "id": "7d796cac-0d88-4897-9a80-449805f9ea43", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/whatsapp/messages?date_range=all&start_date=&end_date=&limit=25&cursor=&direction=next&campaign_id=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "whatsapp", "messages" ], "query": [ { "description": "Predefined date range filter. Preset ranges use your account timezone to calculate relative dates:\n- 'last_week': Last 7 days from midnight in your account timezone\n- 'last_thirty': Last 30 days from midnight in your account timezone\n- 'last_month': Previous calendar month in your account timezone\n- 'all': All dates (limited to last 365 days) - default\n- 'custom_date': Use start_date and end_date parameters with explicit RFC3339 timestamps\n", "key": "date_range", "value": "all" }, { "description": "Start date for custom date range in RFC3339 format (e.g., 2025-08-26T10:30:00Z).\nRequired when date_range is 'custom_date'.\nMust be before end_date.\n", "key": "start_date", "value": "" }, { "description": "End date for custom date range in RFC3339 format (e.g., 2025-08-26T23:59:59Z).\nRequired when date_range is 'custom_date'.\nMust be after start_date.\nThe range between start_date and end_date cannot exceed 90 days.\n", "key": "end_date", "value": "" }, { "description": "Maximum number of messages to return per page (1-100, default 25).", "key": "limit", "value": "25" }, { "description": "Pagination cursor returned from a previous request.\nPass the next_cursor or prev_cursor value from a previous response\nto fetch the next or previous page of results. Omit for the first page.\n", "key": "cursor", "value": "" }, { "description": "Pagination direction when using a cursor:\n- 'next': Get older messages (default, moves forward through history)\n- 'prev': Get newer messages (moves backward through history)\n", "key": "direction", "value": "next" }, { "description": "Restrict results to messages belonging to a single campaign (UUID).\nOmit to return messages across all campaigns.\n", "key": "campaign_id", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-7d796cac-0d88-4897-9a80-449805f9ea43" } ], "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-02dd98b4-dc14-4889-93f6-99c857a34fee" }, { "name": "Send WhatsApp message", "id": "d12f80c5-364d-4cea-ae92-90455805b0fd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"recipient\": \"\",\n \"content_type\": \"text\",\n \"content\": {\n \"text\": {\n \"message\": \"\"\n }\n },\n \"sender\": \"\",\n \"sms_fallback\": {\n \"message\": \"\",\n \"sender\": \"\"\n },\n \"message_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/whatsapp/messages", "host": [ "{{baseUrl}}" ], "path": [ "v2", "whatsapp", "messages" ] }, "description": "Sends a single templated message to a single recipient. Templates need to be registered and pre-approved by WhatsApp." }, "response": [ { "id": "e6662b18-df14-427e-bddf-e4d249204fef", "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: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"recipient\": \"\",\n \"content_type\": \"text\",\n \"content\": {\n \"text\": {\n \"message\": \"\"\n }\n },\n \"sender\": \"\",\n \"sms_fallback\": {\n \"message\": \"\",\n \"sender\": \"\"\n },\n \"message_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/whatsapp/messages", "host": [ "{{baseUrl}}" ], "path": [ "v2", "whatsapp", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"sender\": \"\",\n \"recipient\": \"\",\n \"content_type\": \"custom\",\n \"content\": {\n \"text\": {\n \"message\": \"\"\n }\n },\n \"created_at\": \"\",\n \"message_ref\": \"\",\n \"sms_fallback\": {\n \"message\": \"\",\n \"sender\": \"\"\n }\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-e6662b18-df14-427e-bddf-e4d249204fef" }, { "id": "def87941-b60d-4325-b966-f2846295b37d", "name": "Input Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"recipient\": \"\",\n \"content_type\": \"text\",\n \"content\": {\n \"text\": {\n \"message\": \"\"\n }\n },\n \"sender\": \"\",\n \"sms_fallback\": {\n \"message\": \"\",\n \"sender\": \"\"\n },\n \"message_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/whatsapp/messages", "host": [ "{{baseUrl}}" ], "path": [ "v2", "whatsapp", "messages" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"issues\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-def87941-b60d-4325-b966-f2846295b37d" }, { "id": "0d591037-cc76-4a55-aaa6-841c756b565f", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"recipient\": \"\",\n \"content_type\": \"text\",\n \"content\": {\n \"text\": {\n \"message\": \"\"\n }\n },\n \"sender\": \"\",\n \"sms_fallback\": {\n \"message\": \"\",\n \"sender\": \"\"\n },\n \"message_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/whatsapp/messages", "host": [ "{{baseUrl}}" ], "path": [ "v2", "whatsapp", "messages" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-0d591037-cc76-4a55-aaa6-841c756b565f" }, { "id": "45d0c111-f05b-46fc-bc99-b19af27c1908", "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: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"recipient\": \"\",\n \"content_type\": \"text\",\n \"content\": {\n \"text\": {\n \"message\": \"\"\n }\n },\n \"sender\": \"\",\n \"sms_fallback\": {\n \"message\": \"\",\n \"sender\": \"\"\n },\n \"message_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/whatsapp/messages", "host": [ "{{baseUrl}}" ], "path": [ "v2", "whatsapp", "messages" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-45d0c111-f05b-46fc-bc99-b19af27c1908" } ], "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-d12f80c5-364d-4cea-ae92-90455805b0fd" } ], "id": "8ab028a7-ffda-44a6-88c0-f84e31f163df", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-8ab028a7-ffda-44a6-88c0-f84e31f163df" } ], "id": "6bc6b0e0-d00e-41da-b847-ecb30eb94a51", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-6bc6b0e0-d00e-41da-b847-ecb30eb94a51" }, { "name": "rcs", "item": [ { "name": "messages", "item": [ { "name": "{id}", "item": [ { "name": "Get RCS message", "id": "26b24315-be22-4c1e-b51a-47920424ebd6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/rcs/messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "rcs", "messages", ":id" ], "variable": [ { "id": "3f9e5dd5-f968-4365-b870-0fd362b196e9", "key": "id", "value": "", "description": "(Required) Unique identifier of the RCS message to retrieve" } ] }, "description": "Retrieves details of a previously sent RCS message by its unique identifier.\nReturns message content, delivery status, and metadata.\n" }, "response": [ { "id": "6598da53-aa29-47ae-a51f-4d4f2cfc7281", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/rcs/messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "rcs", "messages", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"account_id\": \"\",\n \"sender\": \"\",\n \"recipient\": \"\",\n \"content_type\": \"text\",\n \"content\": {\n \"text\": {\n \"message\": \"\"\n }\n },\n \"created_at\": \"\",\n \"status\": \"SENT\",\n \"message_ref\": \"\",\n \"sms_fallback\": {\n \"message\": \"\",\n \"sender\": \"\"\n },\n \"events\": [\n {\n \"event_type\": \"FAILED\",\n \"created_at\": \"\",\n \"details\": \"\"\n },\n {\n \"event_type\": \"READ\",\n \"created_at\": \"\",\n \"details\": \"\"\n }\n ]\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-6598da53-aa29-47ae-a51f-4d4f2cfc7281" }, { "id": "23bf73b7-f342-4da2-aaca-645bded63e4b", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/rcs/messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "rcs", "messages", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-23bf73b7-f342-4da2-aaca-645bded63e4b" }, { "id": "f2c9d6fc-a54d-434c-886b-e8e653d90dd0", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/rcs/messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "rcs", "messages", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-f2c9d6fc-a54d-434c-886b-e8e653d90dd0" }, { "id": "f819fcfc-bdaf-4b7a-8b51-dfcc8e9312ae", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/rcs/messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "rcs", "messages", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-f819fcfc-bdaf-4b7a-8b51-dfcc8e9312ae" } ], "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-26b24315-be22-4c1e-b51a-47920424ebd6" } ], "id": "e9446662-8db8-402b-bb80-40cbcf4e415e", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-e9446662-8db8-402b-bb80-40cbcf4e415e" }, { "name": "List RCS messages", "id": "a5d76fc2-36ee-4b1b-89b3-2d12f74a32f9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/rcs/messages?date_range=all&start_date=&end_date=&limit=25&cursor=&direction=next", "host": [ "{{baseUrl}}" ], "path": [ "v2", "rcs", "messages" ], "query": [ { "description": "Predefined date range filter. Preset ranges use your account timezone to calculate relative dates:\n- 'last_week': Last 7 days from midnight in your account timezone\n- 'last_thirty': Last 30 days from midnight in your account timezone\n- 'last_month': Previous calendar month in your account timezone\n- 'all': All dates (limited to last 365 days) - default\n- 'custom_date': Use start_date and end_date parameters with explicit RFC3339 timestamps\n", "key": "date_range", "value": "all" }, { "description": "Start date for custom date range in RFC3339 format (e.g., 2025-08-26T10:30:00Z).\nRequired when date_range is 'custom_date'.\nMust be before end_date.\n", "key": "start_date", "value": "" }, { "description": "End date for custom date range in RFC3339 format (e.g., 2025-08-26T23:59:59Z).\nRequired when date_range is 'custom_date'.\nMust be after start_date.\nThe range between start_date and end_date cannot exceed 90 days.\n", "key": "end_date", "value": "" }, { "description": "Maximum number of messages to return per page (1-100, default 25).", "key": "limit", "value": "25" }, { "description": "Pagination cursor returned from a previous request.\nPass the next_cursor or prev_cursor value from a previous response\nto fetch the next or previous page of results. Omit for the first page.\n", "key": "cursor", "value": "" }, { "description": "Pagination direction when using a cursor:\n- 'next': Get older messages (default, moves forward through history)\n- 'prev': Get newer messages (moves backward through history)\n", "key": "direction", "value": "next" } ] }, "description": "Retrieves a list of RCS messages for your account with flexible date filtering.\n\nMessages are returned in reverse chronological order (newest first).\n\n**Date Filtering:**\n- Preset ranges (last_week, last_thirty, last_month): Calculated using your account timezone\n- Custom date ranges: Use RFC3339 timestamps (max 90 days)\n- The 'all' option provides up to 365 days of history\n- All timestamps in responses are returned in UTC format\n\n**Pagination:**\n- Cursor-based pagination for efficient data retrieval\n- Control page size with the limit parameter (1-100 messages per page)\n" }, "response": [ { "id": "66e1eb54-04df-40ba-ae0e-8b78a8192c09", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/rcs/messages?date_range=all&start_date=&end_date=&limit=25&cursor=&direction=next", "host": [ "{{baseUrl}}" ], "path": [ "v2", "rcs", "messages" ], "query": [ { "description": "Predefined date range filter. Preset ranges use your account timezone to calculate relative dates:\n- 'last_week': Last 7 days from midnight in your account timezone\n- 'last_thirty': Last 30 days from midnight in your account timezone\n- 'last_month': Previous calendar month in your account timezone\n- 'all': All dates (limited to last 365 days) - default\n- 'custom_date': Use start_date and end_date parameters with explicit RFC3339 timestamps\n", "key": "date_range", "value": "all" }, { "description": "Start date for custom date range in RFC3339 format (e.g., 2025-08-26T10:30:00Z).\nRequired when date_range is 'custom_date'.\nMust be before end_date.\n", "key": "start_date", "value": "" }, { "description": "End date for custom date range in RFC3339 format (e.g., 2025-08-26T23:59:59Z).\nRequired when date_range is 'custom_date'.\nMust be after start_date.\nThe range between start_date and end_date cannot exceed 90 days.\n", "key": "end_date", "value": "" }, { "description": "Maximum number of messages to return per page (1-100, default 25).", "key": "limit", "value": "25" }, { "description": "Pagination cursor returned from a previous request.\nPass the next_cursor or prev_cursor value from a previous response\nto fetch the next or previous page of results. Omit for the first page.\n", "key": "cursor", "value": "" }, { "description": "Pagination direction when using a cursor:\n- 'next': Get older messages (default, moves forward through history)\n- 'prev': Get newer messages (moves backward through history)\n", "key": "direction", "value": "next" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"messages\": [\n {\n \"id\": \"\",\n \"sender\": \"\",\n \"recipient\": \"\",\n \"content_type\": \"text\",\n \"content\": {\n \"text\": {\n \"message\": \"\"\n }\n },\n \"status\": \"DELIVERED\",\n \"created_at\": \"\",\n \"message_ref\": \"\"\n },\n {\n \"id\": \"\",\n \"sender\": \"\",\n \"recipient\": \"\",\n \"content_type\": \"text\",\n \"content\": {\n \"text\": {\n \"message\": \"\"\n }\n },\n \"status\": \"READ\",\n \"created_at\": \"\",\n \"message_ref\": \"\"\n }\n ]\n },\n \"request\": {},\n \"meta\": {\n \"pagination\": {\n \"type\": \"cursor\",\n \"has_next\": \"\",\n \"has_prev\": \"\",\n \"next_cursor\": \"\",\n \"prev_cursor\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-66e1eb54-04df-40ba-ae0e-8b78a8192c09" }, { "id": "19315a24-ac67-404a-8c88-11f890ca5d97", "name": "Input Validation Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/rcs/messages?date_range=all&start_date=&end_date=&limit=25&cursor=&direction=next", "host": [ "{{baseUrl}}" ], "path": [ "v2", "rcs", "messages" ], "query": [ { "description": "Predefined date range filter. Preset ranges use your account timezone to calculate relative dates:\n- 'last_week': Last 7 days from midnight in your account timezone\n- 'last_thirty': Last 30 days from midnight in your account timezone\n- 'last_month': Previous calendar month in your account timezone\n- 'all': All dates (limited to last 365 days) - default\n- 'custom_date': Use start_date and end_date parameters with explicit RFC3339 timestamps\n", "key": "date_range", "value": "all" }, { "description": "Start date for custom date range in RFC3339 format (e.g., 2025-08-26T10:30:00Z).\nRequired when date_range is 'custom_date'.\nMust be before end_date.\n", "key": "start_date", "value": "" }, { "description": "End date for custom date range in RFC3339 format (e.g., 2025-08-26T23:59:59Z).\nRequired when date_range is 'custom_date'.\nMust be after start_date.\nThe range between start_date and end_date cannot exceed 90 days.\n", "key": "end_date", "value": "" }, { "description": "Maximum number of messages to return per page (1-100, default 25).", "key": "limit", "value": "25" }, { "description": "Pagination cursor returned from a previous request.\nPass the next_cursor or prev_cursor value from a previous response\nto fetch the next or previous page of results. Omit for the first page.\n", "key": "cursor", "value": "" }, { "description": "Pagination direction when using a cursor:\n- 'next': Get older messages (default, moves forward through history)\n- 'prev': Get newer messages (moves backward through history)\n", "key": "direction", "value": "next" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"issues\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-19315a24-ac67-404a-8c88-11f890ca5d97" }, { "id": "b2ceb6d1-eb59-4cd0-b51d-22145e383832", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/rcs/messages?date_range=all&start_date=&end_date=&limit=25&cursor=&direction=next", "host": [ "{{baseUrl}}" ], "path": [ "v2", "rcs", "messages" ], "query": [ { "description": "Predefined date range filter. Preset ranges use your account timezone to calculate relative dates:\n- 'last_week': Last 7 days from midnight in your account timezone\n- 'last_thirty': Last 30 days from midnight in your account timezone\n- 'last_month': Previous calendar month in your account timezone\n- 'all': All dates (limited to last 365 days) - default\n- 'custom_date': Use start_date and end_date parameters with explicit RFC3339 timestamps\n", "key": "date_range", "value": "all" }, { "description": "Start date for custom date range in RFC3339 format (e.g., 2025-08-26T10:30:00Z).\nRequired when date_range is 'custom_date'.\nMust be before end_date.\n", "key": "start_date", "value": "" }, { "description": "End date for custom date range in RFC3339 format (e.g., 2025-08-26T23:59:59Z).\nRequired when date_range is 'custom_date'.\nMust be after start_date.\nThe range between start_date and end_date cannot exceed 90 days.\n", "key": "end_date", "value": "" }, { "description": "Maximum number of messages to return per page (1-100, default 25).", "key": "limit", "value": "25" }, { "description": "Pagination cursor returned from a previous request.\nPass the next_cursor or prev_cursor value from a previous response\nto fetch the next or previous page of results. Omit for the first page.\n", "key": "cursor", "value": "" }, { "description": "Pagination direction when using a cursor:\n- 'next': Get older messages (default, moves forward through history)\n- 'prev': Get newer messages (moves backward through history)\n", "key": "direction", "value": "next" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-b2ceb6d1-eb59-4cd0-b51d-22145e383832" }, { "id": "1dbbe3e5-b646-44a7-9256-7d3cea7a9b08", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/rcs/messages?date_range=all&start_date=&end_date=&limit=25&cursor=&direction=next", "host": [ "{{baseUrl}}" ], "path": [ "v2", "rcs", "messages" ], "query": [ { "description": "Predefined date range filter. Preset ranges use your account timezone to calculate relative dates:\n- 'last_week': Last 7 days from midnight in your account timezone\n- 'last_thirty': Last 30 days from midnight in your account timezone\n- 'last_month': Previous calendar month in your account timezone\n- 'all': All dates (limited to last 365 days) - default\n- 'custom_date': Use start_date and end_date parameters with explicit RFC3339 timestamps\n", "key": "date_range", "value": "all" }, { "description": "Start date for custom date range in RFC3339 format (e.g., 2025-08-26T10:30:00Z).\nRequired when date_range is 'custom_date'.\nMust be before end_date.\n", "key": "start_date", "value": "" }, { "description": "End date for custom date range in RFC3339 format (e.g., 2025-08-26T23:59:59Z).\nRequired when date_range is 'custom_date'.\nMust be after start_date.\nThe range between start_date and end_date cannot exceed 90 days.\n", "key": "end_date", "value": "" }, { "description": "Maximum number of messages to return per page (1-100, default 25).", "key": "limit", "value": "25" }, { "description": "Pagination cursor returned from a previous request.\nPass the next_cursor or prev_cursor value from a previous response\nto fetch the next or previous page of results. Omit for the first page.\n", "key": "cursor", "value": "" }, { "description": "Pagination direction when using a cursor:\n- 'next': Get older messages (default, moves forward through history)\n- 'prev': Get newer messages (moves backward through history)\n", "key": "direction", "value": "next" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-1dbbe3e5-b646-44a7-9256-7d3cea7a9b08" } ], "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-a5d76fc2-36ee-4b1b-89b3-2d12f74a32f9" }, { "name": "Send RCS message", "id": "d35d2554-12a0-4833-bf75-11f38ea6851f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"sender\": \"\",\n \"recipient\": \"\",\n \"content_type\": \"text\",\n \"content\": {\n \"text\": {\n \"message\": \"\"\n }\n },\n \"sms_fallback\": {\n \"message\": \"\",\n \"sender\": \"\"\n },\n \"message_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/rcs/messages", "host": [ "{{baseUrl}}" ], "path": [ "v2", "rcs", "messages" ] }, "description": "This endpoint is in beta and may change in future versions.\nSends an RCS message to a single recipient.\n" }, "response": [ { "id": "556f0aff-950e-496b-ade5-5ddcf8300712", "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: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"sender\": \"\",\n \"recipient\": \"\",\n \"content_type\": \"text\",\n \"content\": {\n \"text\": {\n \"message\": \"\"\n }\n },\n \"sms_fallback\": {\n \"message\": \"\",\n \"sender\": \"\"\n },\n \"message_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/rcs/messages", "host": [ "{{baseUrl}}" ], "path": [ "v2", "rcs", "messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"sender\": \"\",\n \"recipient\": \"\",\n \"content_type\": \"text\",\n \"content\": {\n \"text\": {\n \"message\": \"\"\n }\n },\n \"created_at\": \"\",\n \"message_ref\": \"\",\n \"sms_fallback\": {\n \"message\": \"\",\n \"sender\": \"\"\n }\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-556f0aff-950e-496b-ade5-5ddcf8300712" }, { "id": "ad37524c-fd0c-47ed-8c69-5947745a137a", "name": "Input Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"sender\": \"\",\n \"recipient\": \"\",\n \"content_type\": \"text\",\n \"content\": {\n \"text\": {\n \"message\": \"\"\n }\n },\n \"sms_fallback\": {\n \"message\": \"\",\n \"sender\": \"\"\n },\n \"message_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/rcs/messages", "host": [ "{{baseUrl}}" ], "path": [ "v2", "rcs", "messages" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"issues\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-ad37524c-fd0c-47ed-8c69-5947745a137a" }, { "id": "8e2be961-8c84-4e39-a161-3a509b3e78db", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"sender\": \"\",\n \"recipient\": \"\",\n \"content_type\": \"text\",\n \"content\": {\n \"text\": {\n \"message\": \"\"\n }\n },\n \"sms_fallback\": {\n \"message\": \"\",\n \"sender\": \"\"\n },\n \"message_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/rcs/messages", "host": [ "{{baseUrl}}" ], "path": [ "v2", "rcs", "messages" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-8e2be961-8c84-4e39-a161-3a509b3e78db" }, { "id": "d5e9195d-d2f8-425f-a92e-1b37f8088741", "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: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"sender\": \"\",\n \"recipient\": \"\",\n \"content_type\": \"text\",\n \"content\": {\n \"text\": {\n \"message\": \"\"\n }\n },\n \"sms_fallback\": {\n \"message\": \"\",\n \"sender\": \"\"\n },\n \"message_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/rcs/messages", "host": [ "{{baseUrl}}" ], "path": [ "v2", "rcs", "messages" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-d5e9195d-d2f8-425f-a92e-1b37f8088741" } ], "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-d35d2554-12a0-4833-bf75-11f38ea6851f" } ], "id": "7136bd55-5416-4afe-b410-d854251ffd92", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-7136bd55-5416-4afe-b410-d854251ffd92" }, { "name": "capabilities", "item": [ { "name": "Check RCS capability for phone numbers", "id": "dd949281-a4ea-4edd-a58b-b2469d3a62cb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"sender\": \"\",\n \"phone_numbers\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/rcs/capabilities", "host": [ "{{baseUrl}}" ], "path": [ "v2", "rcs", "capabilities" ] }, "description": "Synchronously checks whether a list of phone numbers can receive RCS from your sender.\n\nUse this **before** sending to decide between RCS and SMS fallback. Designed for routing-time lookups: small batches (1\u201310 numbers recommended for best latency), immediate response.\n\nResults are best-effort and reflect capability at the moment of the lookup. **Do not use this as a hard gate** on sending \u2014 treat `UNKNOWN` as reachable and rely on SMS fallback for hard delivery guarantees.\n" }, "response": [ { "id": "b76bdf03-1be3-40b9-8329-b4fd163c052d", "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: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"sender\": \"\",\n \"phone_numbers\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/rcs/capabilities", "host": [ "{{baseUrl}}" ], "path": [ "v2", "rcs", "capabilities" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"results\": [\n {\n \"phone_number\": \"\",\n \"code\": \"ENABLED\"\n },\n {\n \"phone_number\": \"\",\n \"code\": \"UNKNOWN\"\n }\n ]\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-b76bdf03-1be3-40b9-8329-b4fd163c052d" }, { "id": "be38e153-003e-4944-898a-6678a8ceede6", "name": "Input Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"sender\": \"\",\n \"phone_numbers\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/rcs/capabilities", "host": [ "{{baseUrl}}" ], "path": [ "v2", "rcs", "capabilities" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"issues\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-be38e153-003e-4944-898a-6678a8ceede6" }, { "id": "0c0605f6-5d13-4550-98b6-92278df7945f", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"sender\": \"\",\n \"phone_numbers\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/rcs/capabilities", "host": [ "{{baseUrl}}" ], "path": [ "v2", "rcs", "capabilities" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-0c0605f6-5d13-4550-98b6-92278df7945f" }, { "id": "8534d5d0-3f09-4f85-a310-4d28a4ed2718", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"sender\": \"\",\n \"phone_numbers\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/rcs/capabilities", "host": [ "{{baseUrl}}" ], "path": [ "v2", "rcs", "capabilities" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-8534d5d0-3f09-4f85-a310-4d28a4ed2718" }, { "id": "9ebcad1c-5e52-4845-86a2-ead6569ea0fc", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"sender\": \"\",\n \"phone_numbers\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/rcs/capabilities", "host": [ "{{baseUrl}}" ], "path": [ "v2", "rcs", "capabilities" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-9ebcad1c-5e52-4845-86a2-ead6569ea0fc" }, { "id": "a98e06ec-c619-48a5-ae8a-5f197c2cb222", "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: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"sender\": \"\",\n \"phone_numbers\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/rcs/capabilities", "host": [ "{{baseUrl}}" ], "path": [ "v2", "rcs", "capabilities" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-a98e06ec-c619-48a5-ae8a-5f197c2cb222" } ], "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-dd949281-a4ea-4edd-a58b-b2469d3a62cb" } ], "id": "3b6ffaf6-d774-4b69-9253-c5eb847887b3", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-3b6ffaf6-d774-4b69-9253-c5eb847887b3" } ], "id": "b19e24da-4920-46cc-b750-dad111707b41", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-b19e24da-4920-46cc-b750-dad111707b41" }, { "name": "sms", "item": [ { "name": "{id}", "item": [ { "name": "Get SMS", "id": "53d382f6-0b5c-4406-980a-fe4517924487", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/sms/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "sms", ":id" ], "variable": [ { "id": "c032a120-043a-4e34-a960-c6fafbcf44b9", "key": "id", "value": "", "description": "(Required) Unique ID of the sent SMS" } ] }, "description": "Retrieves information about an existing SMS message. You only need to supply the unique message id that was returned upon message creation." }, "response": [ { "id": "d8db6391-c76b-4648-954b-17be451489b7", "name": "A single SMS message", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/sms/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "sms", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"recipient\": \"\",\n \"recipient_country\": \"\",\n \"sender\": \"\",\n \"sender_country\": \"\",\n \"message_ref\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"sms_count\": \"\",\n \"is_gsm\": \"\",\n \"is_sandbox\": \"\",\n \"routed_via\": \"\",\n \"track_links\": \"\",\n \"direction\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-d8db6391-c76b-4648-954b-17be451489b7" }, { "id": "1f5f95ca-47e4-41d8-b07c-41fc4063adaa", "name": "SMS not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/sms/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "sms", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": \"\"\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-1f5f95ca-47e4-41d8-b07c-41fc4063adaa" } ], "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-53d382f6-0b5c-4406-980a-fe4517924487" } ], "id": "eabd9a8f-4139-40f4-8743-7728e7e1a268", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-eabd9a8f-4139-40f4-8743-7728e7e1a268" }, { "name": "List SMS", "id": "e5557d1e-d6f3-483c-aa69-8d8632938a0e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/sms?limit=&page=&start_date=&end_date=&recipient=&sender=&message_ref=&status=SUBMITTED&format=JSON&recipient_countries=,&direction=OUT&order_by=CREATED_AT_ASC,CREATED_AT_DESC", "host": [ "{{baseUrl}}" ], "path": [ "v2", "sms" ], "query": [ { "description": "Filter query parameters are added to the URL. Use as:\n?limit=1&page=2&start_date=2024-01-01T00:00:00Z\n", "key": "limit", "value": "" }, { "description": "Filter query parameters are added to the URL. Use as:\n?limit=1&page=2&start_date=2024-01-01T00:00:00Z\n", "key": "page", "value": "" }, { "description": "Filter query parameters are added to the URL. Use as:\n?limit=1&page=2&start_date=2024-01-01T00:00:00Z\n", "key": "start_date", "value": "" }, { "description": "Filter query parameters are added to the URL. Use as:\n?limit=1&page=2&start_date=2024-01-01T00:00:00Z\n", "key": "end_date", "value": "" }, { "description": "Filter query parameters are added to the URL. Use as:\n?limit=1&page=2&start_date=2024-01-01T00:00:00Z\n", "key": "recipient", "value": "" }, { "description": "Filter query parameters are added to the URL. Use as:\n?limit=1&page=2&start_date=2024-01-01T00:00:00Z\n", "key": "sender", "value": "" }, { "description": "Filter query parameters are added to the URL. Use as:\n?limit=1&page=2&start_date=2024-01-01T00:00:00Z\n", "key": "message_ref", "value": "" }, { "description": "Filter query parameters are added to the URL. Use as:\n?limit=1&page=2&start_date=2024-01-01T00:00:00Z\n", "key": "status", "value": "SUBMITTED" }, { "description": "Filter query parameters are added to the URL. Use as:\n?limit=1&page=2&start_date=2024-01-01T00:00:00Z\n", "key": "format", "value": "JSON" }, { "description": "Filter query parameters are added to the URL. Use as:\n?limit=1&page=2&start_date=2024-01-01T00:00:00Z\n", "key": "recipient_countries", "value": "," }, { "description": "Filter query parameters are added to the URL. Use as:\n?limit=1&page=2&start_date=2024-01-01T00:00:00Z\n", "key": "direction", "value": "OUT" }, { "description": "Filter query parameters are added to the URL. Use as:\n?limit=1&page=2&start_date=2024-01-01T00:00:00Z\n", "key": "order_by", "value": "CREATED_AT_ASC,CREATED_AT_DESC" } ] }, "description": "Retrieves a list of SMS messages. You can limit the number of messages returned and filter by properties listed in the parameters section." }, "response": [ { "id": "999ac35a-f9fc-46c8-88ba-b1ccea793684", "name": "A list of SMS messages", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/sms?limit=&page=&start_date=&end_date=&recipient=&sender=&message_ref=&status=SUBMITTED&format=JSON&recipient_countries=,&direction=OUT&order_by=CREATED_AT_ASC,CREATED_AT_DESC", "host": [ "{{baseUrl}}" ], "path": [ "v2", "sms" ], "query": [ { "description": "Filter query parameters are added to the URL. Use as:\n?limit=1&page=2&start_date=2024-01-01T00:00:00Z\n", "key": "limit", "value": "" }, { "description": "Filter query parameters are added to the URL. Use as:\n?limit=1&page=2&start_date=2024-01-01T00:00:00Z\n", "key": "page", "value": "" }, { "description": "Filter query parameters are added to the URL. Use as:\n?limit=1&page=2&start_date=2024-01-01T00:00:00Z\n", "key": "start_date", "value": "" }, { "description": "Filter query parameters are added to the URL. Use as:\n?limit=1&page=2&start_date=2024-01-01T00:00:00Z\n", "key": "end_date", "value": "" }, { "description": "Filter query parameters are added to the URL. Use as:\n?limit=1&page=2&start_date=2024-01-01T00:00:00Z\n", "key": "recipient", "value": "" }, { "description": "Filter query parameters are added to the URL. Use as:\n?limit=1&page=2&start_date=2024-01-01T00:00:00Z\n", "key": "sender", "value": "" }, { "description": "Filter query parameters are added to the URL. Use as:\n?limit=1&page=2&start_date=2024-01-01T00:00:00Z\n", "key": "message_ref", "value": "" }, { "description": "Filter query parameters are added to the URL. Use as:\n?limit=1&page=2&start_date=2024-01-01T00:00:00Z\n", "key": "status", "value": "SUBMITTED" }, { "description": "Filter query parameters are added to the URL. Use as:\n?limit=1&page=2&start_date=2024-01-01T00:00:00Z\n", "key": "format", "value": "JSON" }, { "description": "Filter query parameters are added to the URL. Use as:\n?limit=1&page=2&start_date=2024-01-01T00:00:00Z\n", "key": "recipient_countries", "value": "," }, { "description": "Filter query parameters are added to the URL. Use as:\n?limit=1&page=2&start_date=2024-01-01T00:00:00Z\n", "key": "direction", "value": "OUT" }, { "description": "Filter query parameters are added to the URL. Use as:\n?limit=1&page=2&start_date=2024-01-01T00:00:00Z\n", "key": "order_by", "value": "CREATED_AT_ASC,CREATED_AT_DESC" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"smses\": [\n {\n \"id\": \"\",\n \"recipient\": \"\",\n \"recipient_country\": \"\",\n \"sender\": \"\",\n \"sender_country\": \"\",\n \"message_ref\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"sms_count\": \"\",\n \"is_gsm\": \"\",\n \"is_sandbox\": \"\",\n \"routed_via\": \"\",\n \"track_links\": \"\",\n \"direction\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"recipient\": \"\",\n \"recipient_country\": \"\",\n \"sender\": \"\",\n \"sender_country\": \"\",\n \"message_ref\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"sms_count\": \"\",\n \"is_gsm\": \"\",\n \"is_sandbox\": \"\",\n \"routed_via\": \"\",\n \"track_links\": \"\",\n \"direction\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"total_records\": \"\",\n \"total_segments\": \"\"\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-999ac35a-f9fc-46c8-88ba-b1ccea793684" } ], "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-e5557d1e-d6f3-483c-aa69-8d8632938a0e" }, { "name": "Send SMS", "id": "8e610c8e-d05d-4162-bdce-aaff5a1663fa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"sender\": \"\",\n \"recipient\": \"\",\n \"message_ref\": \"\",\n \"track_links\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/sms", "host": [ "{{baseUrl}}" ], "path": [ "v2", "sms" ] }, "description": "Send a message from sender to recipient using the values shown in the parameters section." }, "response": [ { "id": "cfc5c6bf-f4df-44c7-858a-96a6b818d7b2", "name": "The SMS that was sent", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"sender\": \"\",\n \"recipient\": \"\",\n \"message_ref\": \"\",\n \"track_links\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/sms", "host": [ "{{baseUrl}}" ], "path": [ "v2", "sms" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"recipient\": \"\",\n \"recipient_country\": \"\",\n \"sender\": \"\",\n \"sender_country\": \"\",\n \"message_ref\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"sms_count\": \"\",\n \"is_gsm\": \"\",\n \"is_sandbox\": \"\",\n \"routed_via\": \"\",\n \"track_links\": \"\",\n \"direction\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-cfc5c6bf-f4df-44c7-858a-96a6b818d7b2" } ], "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-8e610c8e-d05d-4162-bdce-aaff5a1663fa" } ], "id": "ac41c386-300d-48dd-9abf-5659808f8a4e", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-ac41c386-300d-48dd-9abf-5659808f8a4e" }, { "name": "mms", "item": [ { "name": "{id}", "item": [ { "name": "Get MMS", "id": "d64fa5b2-96c0-4ce6-bf55-90aa1b260565", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/mms/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "mms", ":id" ], "variable": [ { "id": "cfd4e533-a97f-497b-a5f0-bb450f94f10e", "key": "id", "value": "", "description": "(Required) Unique ID of the sent MMS" } ] }, "description": "This request retrieves the information of an existing sent MMS message. You only need to supply the unique message id that was returned upon creation." }, "response": [ { "id": "749bbb70-74e3-434c-8f9d-6ef537f02480", "name": "A single MMS message", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/mms/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "mms", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"recipient\": \"\",\n \"sender\": \"\",\n \"country\": \"\",\n \"subject\": \"\",\n \"message\": \"\",\n \"message_ref\": \"\",\n \"content_urls\": [\n \"\",\n \"\"\n ],\n \"status\": \"\",\n \"track_links\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"is_sandbox\": \"\"\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-749bbb70-74e3-434c-8f9d-6ef537f02480" }, { "id": "bda246c8-bcad-4af1-9db3-2375f7f77ab5", "name": "Invalid MMS ID", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/mms/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "mms", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": \"\"\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-bda246c8-bcad-4af1-9db3-2375f7f77ab5" }, { "id": "194c31f9-9f64-453e-8dd2-570170e94edb", "name": "MMS not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/mms/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "mms", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": \"\"\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-194c31f9-9f64-453e-8dd2-570170e94edb" } ], "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-d64fa5b2-96c0-4ce6-bf55-90aa1b260565" } ], "id": "b8949bc3-754e-4c44-a17e-0cf5780bd6ae", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-b8949bc3-754e-4c44-a17e-0cf5780bd6ae" }, { "name": "Send MMS", "id": "5abe7871-663b-4a01-9673-c363e079c658", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"sender\": \"\",\n \"recipient\": \"\",\n \"content_urls\": [\n \"\",\n \"\"\n ],\n \"subject\": \"gq\\\\\",\n \"message\": \"\",\n \"message_ref\": \"\",\n \"track_links\": \"\",\n \"is_sandbox\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/mms", "host": [ "{{baseUrl}}" ], "path": [ "v2", "mms" ] }, "description": "The Send MMS endpoint allows you to send multimedia messages (MMS) to recipients. " }, "response": [ { "id": "81659836-01a1-4a4c-904f-73d0a25ffe65", "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: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"sender\": \"\",\n \"recipient\": \"\",\n \"content_urls\": [\n \"\",\n \"\"\n ],\n \"subject\": \"gq\\\\\",\n \"message\": \"\",\n \"message_ref\": \"\",\n \"track_links\": \"\",\n \"is_sandbox\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/mms", "host": [ "{{baseUrl}}" ], "path": [ "v2", "mms" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"recipient\": \"\",\n \"sender\": \"\",\n \"country\": \"\",\n \"subject\": \"\",\n \"message\": \"\",\n \"message_ref\": \"\",\n \"content_urls\": [\n \"\",\n \"\"\n ],\n \"status\": \"\",\n \"track_links\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"is_sandbox\": \"\"\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-81659836-01a1-4a4c-904f-73d0a25ffe65" } ], "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-5abe7871-663b-4a01-9673-c363e079c658" } ], "id": "9be0e23c-f297-49d2-9820-cb442f522e46", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-9be0e23c-f297-49d2-9820-cb442f522e46" }, { "name": "webhook", "item": [ { "name": "{id}", "item": [ { "name": "Get a webhook by ID", "id": "4a3a319c-ad05-41f8-87bc-3997ec61f95c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/webhook/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhook", ":id" ], "variable": [ { "id": "d77abeb5-cde9-4953-bc97-b8233c2ab3b8", "key": "id", "value": "", "description": "(Required) Unique ID of the webhook" } ] } }, "response": [ { "id": "b97875d8-fd5b-4871-b99b-9fed8e4deab5", "name": "A single webhook", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/webhook/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhook", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"url\": \"\",\n \"rate_limit\": \"\",\n \"is_sandbox\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"filter\": {\n \"event_type\": [\n \"LINK_HIT\",\n \"RCS_INBOUND\"\n ],\n \"sender\": [\n \"\",\n \"\"\n ],\n \"status\": [\n \"\",\n \"\"\n ],\n \"message_ref\": [\n \"\",\n \"\"\n ],\n \"campaign_id\": [\n \"\",\n \"\"\n ]\n }\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-b97875d8-fd5b-4871-b99b-9fed8e4deab5" }, { "id": "6f323a28-6990-4551-8799-bb9e5993c01f", "name": "Webhook not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/webhook/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhook", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": \"\"\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-6f323a28-6990-4551-8799-bb9e5993c01f" } ], "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-4a3a319c-ad05-41f8-87bc-3997ec61f95c" }, { "name": "Update Webhook", "id": "7875f25c-4a90-4bd9-870a-bb881645af20", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"event_type\": \"WHATSAPP_INBOUND\",\n \"filter\": {\n \"event_type\": [\n \"MMS_INBOUND\",\n \"MMS_INBOUND\"\n ],\n \"sender\": [\n \"\",\n \"\"\n ],\n \"status\": [\n \"\",\n \"\"\n ],\n \"message_ref\": [\n \"\",\n \"\"\n ],\n \"campaign_id\": [\n \"\",\n \"\"\n ]\n },\n \"rate_limit\": \"\",\n \"is_sandbox\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/webhook/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhook", ":id" ], "variable": [ { "id": "1e9f75d2-e83d-4330-b965-ed3deaa74070", "key": "id", "value": "", "description": "(Required) Unique identifier for the webhook" } ] }, "description": "Updates the webhook. Any fields not provided in the request body will reset to their default values." }, "response": [ { "id": "87bee9c2-26db-478b-b420-44102025f585", "name": "Webhook updated successfully", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"event_type\": \"WHATSAPP_INBOUND\",\n \"filter\": {\n \"event_type\": [\n \"MMS_INBOUND\",\n \"MMS_INBOUND\"\n ],\n \"sender\": [\n \"\",\n \"\"\n ],\n \"status\": [\n \"\",\n \"\"\n ],\n \"message_ref\": [\n \"\",\n \"\"\n ],\n \"campaign_id\": [\n \"\",\n \"\"\n ]\n },\n \"rate_limit\": \"\",\n \"is_sandbox\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/webhook/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhook", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"url\": \"\",\n \"rate_limit\": \"\",\n \"is_sandbox\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"filter\": {\n \"event_type\": [\n \"LINK_HIT\",\n \"RCS_INBOUND\"\n ],\n \"sender\": [\n \"\",\n \"\"\n ],\n \"status\": [\n \"\",\n \"\"\n ],\n \"message_ref\": [\n \"\",\n \"\"\n ],\n \"campaign_id\": [\n \"\",\n \"\"\n ]\n }\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-87bee9c2-26db-478b-b420-44102025f585" }, { "id": "44c6de5b-ecd5-4782-8023-838f7c7d46ab", "name": "Validation error", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"event_type\": \"WHATSAPP_INBOUND\",\n \"filter\": {\n \"event_type\": [\n \"MMS_INBOUND\",\n \"MMS_INBOUND\"\n ],\n \"sender\": [\n \"\",\n \"\"\n ],\n \"status\": [\n \"\",\n \"\"\n ],\n \"message_ref\": [\n \"\",\n \"\"\n ],\n \"campaign_id\": [\n \"\",\n \"\"\n ]\n },\n \"rate_limit\": \"\",\n \"is_sandbox\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/webhook/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhook", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": \"\"\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-44c6de5b-ecd5-4782-8023-838f7c7d46ab" } ], "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-7875f25c-4a90-4bd9-870a-bb881645af20" }, { "name": "Delete Webhook", "id": "ae7e1ce4-2aa3-446b-b3b6-2900be81c87e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/webhook/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhook", ":id" ], "variable": [ { "id": "fa192033-5fd6-4563-a015-47677331f8cf", "key": "id", "value": "", "description": "(Required) Unique ID of the webhook" } ] } }, "response": [ { "id": "e7b6ba57-cac3-4564-92a7-2899dc1f5753", "name": "Webhook deletion confirmation", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/webhook/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhook", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-e7b6ba57-cac3-4564-92a7-2899dc1f5753" }, { "id": "d744d804-bbdf-431a-b199-b8c5e7e4759a", "name": "Invalid webhook ID", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/webhook/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhook", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": \"\"\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-d744d804-bbdf-431a-b199-b8c5e7e4759a" }, { "id": "ac316193-d471-46fa-a58f-34f784c567af", "name": "Webhook not found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/webhook/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhook", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": \"\"\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-ac316193-d471-46fa-a58f-34f784c567af" } ], "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-ae7e1ce4-2aa3-446b-b3b6-2900be81c87e" } ], "id": "868d1293-5a94-448b-8259-7d8c2e8274d8", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-868d1293-5a94-448b-8259-7d8c2e8274d8" }, { "name": "Create Webhook", "id": "5325ef40-af1d-474d-8e28-3e8b57090c40", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"event_type\": \"WHATSAPP_INBOUND\",\n \"filter\": {\n \"event_type\": [\n \"MMS_INBOUND\",\n \"MMS_INBOUND\"\n ],\n \"sender\": [\n \"\",\n \"\"\n ],\n \"status\": [\n \"\",\n \"\"\n ],\n \"message_ref\": [\n \"\",\n \"\"\n ],\n \"campaign_id\": [\n \"\",\n \"\"\n ]\n },\n \"rate_limit\": \"\",\n \"is_sandbox\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/webhook", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhook" ] }, "description": "We use webhooks to let your application know when events happen, such as receiving an SMS message. When the event occurs, the system makes an HTTP request (usually a POST) to the URL you configured for the webhook. The request will include details of the event such as the incoming phone number or the body of an incoming message." }, "response": [ { "id": "eb15b952-b4c3-4b05-9f3f-578626ba545f", "name": "Webhook created successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"event_type\": \"WHATSAPP_INBOUND\",\n \"filter\": {\n \"event_type\": [\n \"MMS_INBOUND\",\n \"MMS_INBOUND\"\n ],\n \"sender\": [\n \"\",\n \"\"\n ],\n \"status\": [\n \"\",\n \"\"\n ],\n \"message_ref\": [\n \"\",\n \"\"\n ],\n \"campaign_id\": [\n \"\",\n \"\"\n ]\n },\n \"rate_limit\": \"\",\n \"is_sandbox\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/webhook", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhook" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"url\": \"\",\n \"rate_limit\": \"\",\n \"is_sandbox\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"filter\": {\n \"event_type\": [\n \"LINK_HIT\",\n \"RCS_INBOUND\"\n ],\n \"sender\": [\n \"\",\n \"\"\n ],\n \"status\": [\n \"\",\n \"\"\n ],\n \"message_ref\": [\n \"\",\n \"\"\n ],\n \"campaign_id\": [\n \"\",\n \"\"\n ]\n }\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-eb15b952-b4c3-4b05-9f3f-578626ba545f" }, { "id": "067a36ec-ba6a-4215-9368-6dc221528652", "name": "Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"event_type\": \"WHATSAPP_INBOUND\",\n \"filter\": {\n \"event_type\": [\n \"MMS_INBOUND\",\n \"MMS_INBOUND\"\n ],\n \"sender\": [\n \"\",\n \"\"\n ],\n \"status\": [\n \"\",\n \"\"\n ],\n \"message_ref\": [\n \"\",\n \"\"\n ],\n \"campaign_id\": [\n \"\",\n \"\"\n ]\n },\n \"rate_limit\": \"\",\n \"is_sandbox\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/webhook", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhook" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": \"\"\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-067a36ec-ba6a-4215-9368-6dc221528652" } ], "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-5325ef40-af1d-474d-8e28-3e8b57090c40" }, { "name": "Retrieve all webhooks", "id": "d7c33036-5359-46ed-80d4-b0fe92f27e0d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/webhook", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhook" ] } }, "response": [ { "id": "f28ded09-04c8-40b9-93c9-68f50526a8ff", "name": "A list of webhooks", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/webhook", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhook" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"webhooks\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"url\": \"\",\n \"rate_limit\": \"\",\n \"is_sandbox\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"filter\": {\n \"event_type\": [\n \"LINK_HIT\",\n \"WHATSAPP_INBOUND\"\n ],\n \"sender\": [\n \"\",\n \"\"\n ],\n \"status\": [\n \"\",\n \"\"\n ],\n \"message_ref\": [\n \"\",\n \"\"\n ],\n \"campaign_id\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"url\": \"\",\n \"rate_limit\": \"\",\n \"is_sandbox\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"filter\": {\n \"event_type\": [\n \"MMS_INBOUND\",\n \"SMS_INBOUND\"\n ],\n \"sender\": [\n \"\",\n \"\"\n ],\n \"status\": [\n \"\",\n \"\"\n ],\n \"message_ref\": [\n \"\",\n \"\"\n ],\n \"campaign_id\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-f28ded09-04c8-40b9-93c9-68f50526a8ff" } ], "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-d7c33036-5359-46ed-80d4-b0fe92f27e0d" } ], "id": "8e023402-cf8f-464d-b665-6828ab92c08a", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-8e023402-cf8f-464d-b665-6828ab92c08a" }, { "name": "senders", "item": [ { "name": "registrations", "item": [ { "name": "{registration_id}", "item": [ { "name": "verifications", "item": [ { "name": "confirmation", "item": [ { "name": "Confirm a verification code", "id": "69ed79d9-3fc6-4327-bc87-49db840fbba4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"849146\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/senders/registrations/:registration_id/verifications/confirmation", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations", ":registration_id", "verifications", "confirmation" ], "variable": [ { "id": "88a473fa-5782-41ea-bf57-e83b7c222177", "key": "registration_id", "value": "", "description": "(Required) Unique identifier of the sender registration." } ] }, "description": "Confirms a sender registration by submitting the verification code.\nOn success, the verification `status` becomes `CONFIRMED` and the sender registration `status` becomes `VERIFIED`.\nIf you exceed the allowed attempts, the verification becomes `FAILED`. Request a new verification code to try again.\n" }, "response": [ { "id": "bddacdb8-c7da-430e-9f28-64b6800b591f", "name": "Successful response containing the verification confirmation details.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"849146\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/senders/registrations/:registration_id/verifications/confirmation", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations", ":registration_id", "verifications", "confirmation" ], "variable": [ { "key": "registration_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"registration_id\": \"\",\n \"status\": \"SENT\",\n \"verified_at\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-bddacdb8-c7da-430e-9f28-64b6800b591f" }, { "id": "1afe43a8-7178-4a21-955e-c27a4a0086ba", "name": "400 response specific to the verification confirmation endpoint. The response includes\n`attempts_remaining` as a structured integer field alongside the standard `detail` and\n`issues` fields, so clients can display the remaining attempt count without strin", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"849146\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/senders/registrations/:registration_id/verifications/confirmation", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations", ":registration_id", "verifications", "confirmation" ], "variable": [ { "key": "registration_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"attempts_remaining\": \"\",\n \"issues\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-1afe43a8-7178-4a21-955e-c27a4a0086ba" }, { "id": "135c8e1b-5e5b-4f31-b6ad-a09e7c58b702", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"849146\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/senders/registrations/:registration_id/verifications/confirmation", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations", ":registration_id", "verifications", "confirmation" ], "variable": [ { "key": "registration_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-135c8e1b-5e5b-4f31-b6ad-a09e7c58b702" }, { "id": "a6ed27c4-1f6a-40e9-bea9-3c7d67ec2b56", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"849146\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/senders/registrations/:registration_id/verifications/confirmation", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations", ":registration_id", "verifications", "confirmation" ], "variable": [ { "key": "registration_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-a6ed27c4-1f6a-40e9-bea9-3c7d67ec2b56" }, { "id": "47cf4e2d-d069-462d-ae51-405df6c58653", "name": "Conflict", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"849146\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/senders/registrations/:registration_id/verifications/confirmation", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations", ":registration_id", "verifications", "confirmation" ], "variable": [ { "key": "registration_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-47cf4e2d-d069-462d-ae51-405df6c58653" }, { "id": "91cfbb37-8409-4e84-84b5-a382b6e7dea2", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"849146\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/senders/registrations/:registration_id/verifications/confirmation", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations", ":registration_id", "verifications", "confirmation" ], "variable": [ { "key": "registration_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-91cfbb37-8409-4e84-84b5-a382b6e7dea2" }, { "id": "844860b0-46c3-4e81-b537-af9e8156da17", "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: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"849146\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/senders/registrations/:registration_id/verifications/confirmation", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations", ":registration_id", "verifications", "confirmation" ], "variable": [ { "key": "registration_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-844860b0-46c3-4e81-b537-af9e8156da17" } ], "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-69ed79d9-3fc6-4327-bc87-49db840fbba4" } ], "id": "9f79b453-8fbd-4e38-bccd-ade73ce21899", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-9f79b453-8fbd-4e38-bccd-ade73ce21899" }, { "name": "Request a verification code", "id": "de1363d6-29d0-4164-976f-69c71a6d9e1a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"method\": \"SMS\",\n \"originating_sender\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/senders/registrations/:registration_id/verifications", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations", ":registration_id", "verifications" ], "variable": [ { "id": "788521b1-a314-4a1d-a304-6cd69e40806a", "key": "registration_id", "value": "", "description": "(Required) Unique identifier for the sender registration." } ] }, "description": "Requests a verification code for a sender registration. This endpoint supports registrations with `type` = `PERSONAL_MOBILE_NUMBER` only.\n\n - The API delivers the code to the registered sender number using the selected `method`, such as `SMS`.\n - Codes expire after 30 minutes.\n - You have a maximum of 5 attempts to confirm the code.\n" }, "response": [ { "id": "8175b32a-ca46-498a-a37a-7ac7f689a627", "name": "Successful response containing the verification details.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"method\": \"SMS\",\n \"originating_sender\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/senders/registrations/:registration_id/verifications", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations", ":registration_id", "verifications" ], "variable": [ { "key": "registration_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"registration_id\": \"\",\n \"method\": \"SMS\",\n \"originating_sender\": \"\",\n \"status\": \"FAILED\",\n \"expires_at\": \"\",\n \"attempts_remaining\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-8175b32a-ca46-498a-a37a-7ac7f689a627" }, { "id": "0a1de968-9bd0-406c-a2df-a5a581b02bff", "name": "Input Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"method\": \"SMS\",\n \"originating_sender\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/senders/registrations/:registration_id/verifications", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations", ":registration_id", "verifications" ], "variable": [ { "key": "registration_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"issues\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-0a1de968-9bd0-406c-a2df-a5a581b02bff" }, { "id": "f68a7f84-e5c4-4f27-9451-4945933fd959", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"method\": \"SMS\",\n \"originating_sender\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/senders/registrations/:registration_id/verifications", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations", ":registration_id", "verifications" ], "variable": [ { "key": "registration_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-f68a7f84-e5c4-4f27-9451-4945933fd959" }, { "id": "22c7b141-5a88-4ec6-94ab-fa2a91e4fbe2", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"method\": \"SMS\",\n \"originating_sender\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/senders/registrations/:registration_id/verifications", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations", ":registration_id", "verifications" ], "variable": [ { "key": "registration_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-22c7b141-5a88-4ec6-94ab-fa2a91e4fbe2" }, { "id": "add7417f-3e27-4603-b8bd-4cca62e2daf4", "name": "A verification already exists for this registration. Create a new sender registration to request a new code.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"method\": \"SMS\",\n \"originating_sender\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/senders/registrations/:registration_id/verifications", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations", ":registration_id", "verifications" ], "variable": [ { "key": "registration_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-add7417f-3e27-4603-b8bd-4cca62e2daf4" }, { "id": "f6346163-d894-4968-a1a4-c34d0a7751f0", "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: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"method\": \"SMS\",\n \"originating_sender\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/senders/registrations/:registration_id/verifications", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations", ":registration_id", "verifications" ], "variable": [ { "key": "registration_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-f6346163-d894-4968-a1a4-c34d0a7751f0" } ], "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-de1363d6-29d0-4164-976f-69c71a6d9e1a" } ], "id": "ece2b24b-9ef7-40b4-9b47-78abdaecdd13", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-ece2b24b-9ef7-40b4-9b47-78abdaecdd13" } ], "id": "534524a8-fe84-49f1-a7b6-b9984e30a070", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-534524a8-fe84-49f1-a7b6-b9984e30a070" }, { "name": "List sender registrations", "id": "b7dcdeb4-4f24-4f5f-b928-0f97052f72d4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/senders/registrations?page=1&limit=25&child_account_id=&sender=&status=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations" ], "query": [ { "description": "Page number to return (1-based). Default 1.", "key": "page", "value": "1" }, { "description": "Maximum number of results per page. Default 25, maximum 100.", "key": "limit", "value": "25" }, { "description": "Filter registrations by child account ID. Returns only registrations belonging to the specified child account.", "key": "child_account_id", "value": "" }, { "description": "Filter registrations by sender phone number in E.164 format (e.g., 61412312312).", "key": "sender", "value": "" }, { "description": "Filter registrations by status. Accepts one or more comma-separated values. Valid values: PENDING_APPROVAL, VERIFIED, REJECTED, CANCELLED.\n", "key": "status", "value": "" } ] }, "description": "Returns a paginated list of sender registrations for the authenticated account.\n\n - If the account does not use parent/child accounts, the API returns registrations for the authenticated account.\n - If the account is a parent account, the API returns registrations for the parent account and all child accounts.\n" }, "response": [ { "id": "62711cfe-62ad-4613-9585-c1773b9e9691", "name": "Successful response containing a paginated list of sender registrations.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/senders/registrations?page=1&limit=25&child_account_id=&sender=&status=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations" ], "query": [ { "description": "Page number to return (1-based). Default 1.", "key": "page", "value": "1" }, { "description": "Maximum number of results per page. Default 25, maximum 100.", "key": "limit", "value": "25" }, { "description": "Filter registrations by child account ID. Returns only registrations belonging to the specified child account.", "key": "child_account_id", "value": "" }, { "description": "Filter registrations by sender phone number in E.164 format (e.g., 61412312312).", "key": "sender", "value": "" }, { "description": "Filter registrations by status. Accepts one or more comma-separated values. Valid values: PENDING_APPROVAL, VERIFIED, REJECTED, CANCELLED.\n", "key": "status", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"registrations\": [\n {\n \"registration_id\": \"\",\n \"sender\": \"\",\n \"country\": \"\",\n \"type\": \"PERSONAL_MOBILE_NUMBER\",\n \"status\": \"PENDING_APPROVAL\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"child_account_id\": \"\",\n \"details\": {\n \"alphanumeric\": {\n \"registry\": \"ACMA\",\n \"status\": \"PENDING_APPROVAL\",\n \"status_reason\": \"\"\n }\n }\n },\n {\n \"registration_id\": \"\",\n \"sender\": \"\",\n \"country\": \"\",\n \"type\": \"ALPHANUMERIC\",\n \"status\": \"VERIFIED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"child_account_id\": \"\",\n \"details\": {\n \"alphanumeric\": {\n \"registry\": \"ACMA\",\n \"status\": \"SUBMITTED_TO_REGISTRY\",\n \"status_reason\": \"\"\n }\n }\n }\n ]\n },\n \"meta\": {\n \"pagination\": {\n \"type\": \"page\",\n \"page\": \"\",\n \"limit\": \"\",\n \"total_count\": \"\"\n }\n },\n \"request\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-62711cfe-62ad-4613-9585-c1773b9e9691" }, { "id": "627a9b5e-7392-4088-924c-96906cd9e141", "name": "Input Validation Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/senders/registrations?page=1&limit=25&child_account_id=&sender=&status=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations" ], "query": [ { "description": "Page number to return (1-based). Default 1.", "key": "page", "value": "1" }, { "description": "Maximum number of results per page. Default 25, maximum 100.", "key": "limit", "value": "25" }, { "description": "Filter registrations by child account ID. Returns only registrations belonging to the specified child account.", "key": "child_account_id", "value": "" }, { "description": "Filter registrations by sender phone number in E.164 format (e.g., 61412312312).", "key": "sender", "value": "" }, { "description": "Filter registrations by status. Accepts one or more comma-separated values. Valid values: PENDING_APPROVAL, VERIFIED, REJECTED, CANCELLED.\n", "key": "status", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"issues\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-627a9b5e-7392-4088-924c-96906cd9e141" }, { "id": "50912cc5-8c3b-4055-8a7a-d68be65ce6ad", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/senders/registrations?page=1&limit=25&child_account_id=&sender=&status=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations" ], "query": [ { "description": "Page number to return (1-based). Default 1.", "key": "page", "value": "1" }, { "description": "Maximum number of results per page. Default 25, maximum 100.", "key": "limit", "value": "25" }, { "description": "Filter registrations by child account ID. Returns only registrations belonging to the specified child account.", "key": "child_account_id", "value": "" }, { "description": "Filter registrations by sender phone number in E.164 format (e.g., 61412312312).", "key": "sender", "value": "" }, { "description": "Filter registrations by status. Accepts one or more comma-separated values. Valid values: PENDING_APPROVAL, VERIFIED, REJECTED, CANCELLED.\n", "key": "status", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-50912cc5-8c3b-4055-8a7a-d68be65ce6ad" }, { "id": "d5c04e4c-2bf2-4037-bc57-e9bb5fc06ea2", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/senders/registrations?page=1&limit=25&child_account_id=&sender=&status=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations" ], "query": [ { "description": "Page number to return (1-based). Default 1.", "key": "page", "value": "1" }, { "description": "Maximum number of results per page. Default 25, maximum 100.", "key": "limit", "value": "25" }, { "description": "Filter registrations by child account ID. Returns only registrations belonging to the specified child account.", "key": "child_account_id", "value": "" }, { "description": "Filter registrations by sender phone number in E.164 format (e.g., 61412312312).", "key": "sender", "value": "" }, { "description": "Filter registrations by status. Accepts one or more comma-separated values. Valid values: PENDING_APPROVAL, VERIFIED, REJECTED, CANCELLED.\n", "key": "status", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-d5c04e4c-2bf2-4037-bc57-e9bb5fc06ea2" } ], "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-b7dcdeb4-4f24-4f5f-b928-0f97052f72d4" }, { "name": "Create a sender registration", "id": "60af7ec2-b71c-41ff-99cc-114e7f2d4d25", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"sender\": \"\",\n \"country\": \"NC\",\n \"type\": \"PERSONAL_MOBILE_NUMBER\",\n \"child_account_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/senders/registrations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations" ] }, "description": "Creates a sender registration and sets `status` to `PENDING_APPROVAL`.\n\n - If the account does not use parent/child accounts, the API ignores `child_account_id` and registers the sender for the authenticated account.\n - If the account is a parent account and you omit `child_account_id`, the API registers the sender for the parent account.\n - If you provide `child_account_id`, the API registers the sender for that child account.\n - If a registration for the same sender was already created within the last 30 minutes (for the same account or child account), the API returns `429 Too Many Requests`. This prevents abuse of the verification retry limit.\n - Any existing `PENDING_APPROVAL` registration for the same sender (for the same account or child account) is automatically cancelled before the new one is created.\n" }, "response": [ { "id": "38bfd8ac-53ba-4f57-be1e-fb08a6b05875", "name": "Successful response containing the new sender registration details.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"sender\": \"\",\n \"country\": \"NC\",\n \"type\": \"PERSONAL_MOBILE_NUMBER\",\n \"child_account_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/senders/registrations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"registration_id\": \"\",\n \"sender\": \"\",\n \"country\": \"\",\n \"type\": \"PERSONAL_MOBILE_NUMBER\",\n \"status\": \"CANCELLED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"child_account_id\": \"\",\n \"details\": {\n \"alphanumeric\": {\n \"registry\": \"ACMA\",\n \"status\": \"FAILED\",\n \"status_reason\": \"\"\n }\n }\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-38bfd8ac-53ba-4f57-be1e-fb08a6b05875" }, { "id": "6557c291-8767-42ad-99f5-8833d5325eb4", "name": "Input Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"sender\": \"\",\n \"country\": \"NC\",\n \"type\": \"PERSONAL_MOBILE_NUMBER\",\n \"child_account_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/senders/registrations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"issues\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-6557c291-8767-42ad-99f5-8833d5325eb4" }, { "id": "8d0fb817-3911-4a13-be69-7a6665fa700a", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"sender\": \"\",\n \"country\": \"NC\",\n \"type\": \"PERSONAL_MOBILE_NUMBER\",\n \"child_account_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/senders/registrations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-8d0fb817-3911-4a13-be69-7a6665fa700a" }, { "id": "ab0942b8-b1d6-467e-9c6b-d59f71759ea5", "name": "Conflict", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"sender\": \"\",\n \"country\": \"NC\",\n \"type\": \"PERSONAL_MOBILE_NUMBER\",\n \"child_account_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/senders/registrations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-ab0942b8-b1d6-467e-9c6b-d59f71759ea5" }, { "id": "dc406fc1-eb35-464e-a5b6-c3dd0d65ff3b", "name": "Too Many Requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"sender\": \"\",\n \"country\": \"NC\",\n \"type\": \"PERSONAL_MOBILE_NUMBER\",\n \"child_account_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/senders/registrations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-dc406fc1-eb35-464e-a5b6-c3dd0d65ff3b" }, { "id": "344123c0-9f67-4036-8eda-c75cf4e09418", "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: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"sender\": \"\",\n \"country\": \"NC\",\n \"type\": \"PERSONAL_MOBILE_NUMBER\",\n \"child_account_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/senders/registrations", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "registrations" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-344123c0-9f67-4036-8eda-c75cf4e09418" } ], "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-60af7ec2-b71c-41ff-99cc-114e7f2d4d25" } ], "id": "687a7e0b-27a3-4d6c-bd0a-c45483e112fa", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-687a7e0b-27a3-4d6c-bd0a-c45483e112fa" }, { "name": "phone-numbers", "item": [ { "name": "{phone_number}", "item": [ { "name": "Delete a sender by phone number", "id": "b784fac6-0ae3-4bfe-b8b1-d1f12af99e9d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/senders/phone-numbers/:phone_number?child_account_id=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "phone-numbers", ":phone_number" ], "query": [ { "description": "Child account ID to delete the sender from. Ignored for accounts without parent/child accounts. If omitted for a parent account, the API deletes the sender from the parent account.", "key": "child_account_id", "value": "" } ], "variable": [ { "id": "466d8069-d243-4b31-a3e0-8a5256f2474f", "key": "phone_number", "value": "", "description": "(Required) The phone number to delete in E.164 international format, for example 61412312312." } ] }, "description": "Deletes a sender phone number from the account.\n\n - If the account does not use parent/child accounts, the API ignores `child_account_id` and deletes the sender from the authenticated account.\n - If the account is a parent account and you omit `child_account_id`, the API deletes the sender from the parent account.\n - If you provide `child_account_id`, the API deletes the sender from that child account.\n" }, "response": [ { "id": "4d5e2f26-158a-400a-b77f-c295ac330902", "name": "Sender deleted successfully. No content is returned.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/senders/phone-numbers/:phone_number?child_account_id=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "phone-numbers", ":phone_number" ], "query": [ { "description": "Child account ID to delete the sender from. Ignored for accounts without parent/child accounts. If omitted for a parent account, the API deletes the sender from the parent account.", "key": "child_account_id", "value": "" } ], "variable": [ { "key": "phone_number" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-4d5e2f26-158a-400a-b77f-c295ac330902" }, { "id": "5f4d31d9-f381-47d1-b4ee-5b449e84cd84", "name": "Input Validation Error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/senders/phone-numbers/:phone_number?child_account_id=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "phone-numbers", ":phone_number" ], "query": [ { "description": "Child account ID to delete the sender from. Ignored for accounts without parent/child accounts. If omitted for a parent account, the API deletes the sender from the parent account.", "key": "child_account_id", "value": "" } ], "variable": [ { "key": "phone_number" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\",\n \"issues\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-5f4d31d9-f381-47d1-b4ee-5b449e84cd84" }, { "id": "cbfd8888-2e60-4afd-a97b-6b5ef1588509", "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/senders/phone-numbers/:phone_number?child_account_id=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "phone-numbers", ":phone_number" ], "query": [ { "description": "Child account ID to delete the sender from. Ignored for accounts without parent/child accounts. If omitted for a parent account, the API deletes the sender from the parent account.", "key": "child_account_id", "value": "" } ], "variable": [ { "key": "phone_number" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-cbfd8888-2e60-4afd-a97b-6b5ef1588509" }, { "id": "267470d1-f001-4441-b9ec-677e60c50636", "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/senders/phone-numbers/:phone_number?child_account_id=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "phone-numbers", ":phone_number" ], "query": [ { "description": "Child account ID to delete the sender from. Ignored for accounts without parent/child accounts. If omitted for a parent account, the API deletes the sender from the parent account.", "key": "child_account_id", "value": "" } ], "variable": [ { "key": "phone_number" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-267470d1-f001-4441-b9ec-677e60c50636" }, { "id": "f12ce672-a7e2-42a1-bd3f-6ce24f3baf5e", "name": "Internal Server Error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/senders/phone-numbers/:phone_number?child_account_id=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "senders", "phone-numbers", ":phone_number" ], "query": [ { "description": "Child account ID to delete the sender from. Ignored for accounts without parent/child accounts. If omitted for a parent account, the API deletes the sender from the parent account.", "key": "child_account_id", "value": "" } ], "variable": [ { "key": "phone_number" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"status\": \"\"\n },\n \"request\": {},\n \"meta\": {}\n}", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-f12ce672-a7e2-42a1-bd3f-6ce24f3baf5e" } ], "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-b784fac6-0ae3-4bfe-b8b1-d1f12af99e9d" } ], "id": "f5575f21-4e5a-45e7-8603-0c391ac6040c", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-f5575f21-4e5a-45e7-8603-0c391ac6040c" } ], "id": "0d7a7ac2-9f1c-4f4c-8e56-bc93f0eebafb", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-0d7a7ac2-9f1c-4f4c-8e56-bc93f0eebafb" } ], "id": "39b60f4c-6d9a-407b-b169-88109e92031d", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-39b60f4c-6d9a-407b-b169-88109e92031d" } ], "id": "a22d8539-c00e-41a4-b384-def82c45bbd2", "createdAt": "2026-07-28T02:01:23.000Z", "updatedAt": "2026-07-28T02:01:23.000Z", "uid": "35240-a22d8539-c00e-41a4-b384-def82c45bbd2" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.transmitmessage.com" } ] }