{ "item": [ { "id": "a2b38417-dcf2-458b-b536-76eeb53e84c1", "name": "Workflow", "description": { "content": "**Turbocharge Your Messaging with Automated Workflows**\n\nThe Workflow endpoint is your gateway to our most powerful messaging features, allowing you to execute complex, pre-configured strategies with a single API call.\n\n![Workflow](https://www.tnz.co.nz/docs/restapi/assets/images/Workflow[128x75].png)\n\nGo beyond a simple \"send\" command and build sophisticated rules and automations. With Workflows, you can:\n\n* Create Multi-Channel Cascades: Start with an SMS, automatically failover to an Email if there's no reply, then trigger a Text-to-Speech call if the email isn't received.\n* Intelligent Failover: Define fallback channels to ensure your message always gets through, maximising reach and reliability.\n* Trigger Custom Webhooks: Integrate deeper into your own systems by firing off custom actions at any stage of the workflow.\n* No-Code Design: Use the Dashboard to design your Workflow rules using the drag-and-drop builder then trigger them using the API.\n\nIt's a complete communication strategy without the overhead.\n", "type": "text/plain" }, "item": [ { "id": "247709be-4381-4f2c-bbdd-2fc80b586e20", "name": "Send Workflow", "request": { "name": "Send Workflow", "description": { "content": "Send a message using a pre-configured workflow.\n\nUse `WorkflowTemplateID` to specify the Workflow Template to send.\n\nThe `Destinations` parameter specifies the contacts to receive the message. Alternatively, you may use the `Destinations` array for multiple contacts, or use Address Book `ContactID` or `GroupID` values. If you specify a new contact, the API will automatically create an Address Book contact for you.", "type": "text/plain" }, "url": { "path": [ "workflow" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"WorkflowTemplateID\": \"\",\n \"Destinations\": [\n {\n \"ToNumber\": \"\",\n \"EmailAddress\": \"\",\n \"MainPhone\": \"\",\n \"Attention\": \"\",\n \"First Name\": \"\",\n \"Last Name\": \"\",\n \"Company\": \"\",\n \"Custom1\": \"\",\n \"Custom2\": \"\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"ContactID\": \"\",\n \"GroupID\": \"\",\n \"GroupCode\": \"\"\n },\n {\n \"ToNumber\": \"\",\n \"EmailAddress\": \"\",\n \"MainPhone\": \"\",\n \"Attention\": \"\",\n \"First Name\": \"\",\n \"Last Name\": \"\",\n \"Company\": \"\",\n \"Custom1\": \"\",\n \"Custom2\": \"\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"ContactID\": \"\",\n \"GroupID\": \"\",\n \"GroupCode\": \"\"\n }\n ],\n \"Destination\": \"\",\n \"ToNumber\": \"\",\n \"MainPhone\": \"\",\n \"ContactID\": \"\",\n \"GroupID\": \"\",\n \"MessageID\": \"\",\n \"Reference\": \"\",\n \"NotificationType\": \"\",\n \"WebhookCallbackURL\": \"\",\n \"WebhookCallbackFormat\": \"\",\n \"SubAccount\": \"\",\n \"Department\": \"\",\n \"SendTime\": null,\n \"Timezone\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a6fbc00d-13e3-4258-9b6b-b930fcecbce6", "name": "OK [successful submission]", "originalRequest": { "url": { "path": [ "workflow" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkflowTemplateID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\",\n \"ContactID\": \"6000000b-f002-4007-b00a-c00000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7249baa4-4c8b-4ce7-83d1-0766a2223cad", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "workflow" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkflowTemplateID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\",\n \"ContactID\": \"6000000b-f002-4007-b00a-c00000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bddace51-2668-4072-979e-8aacb148249a", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "workflow" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkflowTemplateID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\",\n \"ContactID\": \"6000000b-f002-4007-b00a-c00000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e7759f1-2ff9-4646-a705-f722198d3d35", "name": "Not Found [record not found]", "originalRequest": { "url": { "path": [ "workflow" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkflowTemplateID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\",\n \"ContactID\": \"6000000b-f002-4007-b00a-c00000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"ErrorMessage\": [\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\",\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85be8ed0-7be9-43f9-9c09-f90c1200404e", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "workflow" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkflowTemplateID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\",\n \"ContactID\": \"6000000b-f002-4007-b00a-c00000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9088f04-8d8a-4b57-97f4-0a6e62630ba4", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "workflow" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"WorkflowTemplateID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\",\n \"ContactID\": \"6000000b-f002-4007-b00a-c00000000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "dbf24cdd-63b2-41a9-83dd-306e9fe8d190", "name": "SMS", "description": { "content": "**Two Way SMS API Endpoint**\n\nEngage your audience directly with our SMS API. More than just a one-way notification system; it's a complete two-way messaging solution.\n\nUse the Send SMS endpoint to initiate conversations, from simple alerts to personalised campaigns.\n\n![SMS](https://www.tnz.co.nz/docs/restapi/assets/images/SMS[128x75].png)\n\nYou can then track delivery status in real-time and process inbound replies using either our efficient [Inbound SMS webhook](#tag/sms/webhook/POST/inboundsmswebhook) or the [SMS Details GET endpoint](#tag/sms/GET/sms/{MessageID}).\n\nTo create a truly interactive experience, you can enhance your messages with powerful features:\n\n* URL Shortener: Track link engagement with our built-in URL shortener.\n* File Attachments: Send images, videos and documents by attaching files to your API request and using the `[[File1]]` command.\n* Templates: For sleek integration with the Dashboard, reference a pre-configured Dashboard `TemplateID` and let users self-manage their message templates.\n", "type": "text/plain" }, "item": [ { "id": "8f99adf9-9663-4d20-a4cd-6595ebbb510b", "name": "Send SMS", "request": { "name": "Send SMS", "description": { "content": "Send an SMS message to one or more recipients.\n\nThe `Message` parameter specifies the SMS text. Alternatively, use `TemplateID` to send a pre-configured message template ([Find Your TemplateID](https://www.tnz.co.nz/help/how-to-find-your-templateid)).\n\nThe Message may include [Personalisation](https://www.tnz.co.nz/help/message-personalisation), use links from the [URL Shortener](https://www.tnz.co.nz/help/sms-url-shortener-and-short-links) and free [ReplyLink](https://www.tnz.co.nz/help/sms-reply-link-and-enhanced-sms-replies) pages.\n\nThe `Destination` parameter contains the mobile number to receive your message. Alternatively, you may use the `Destinations` array for multiple contacts, or use Address Book `ContactID` or `GroupID` values.\n", "type": "text/plain" }, "url": { "path": [ "sms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"Message\": \"\",\n \"TemplateID\": \"\",\n \"Destination\": \"\",\n \"ToNumber\": \"\",\n \"Destinations\": [\n {\n \"ToNumber\": \"\",\n \"EmailAddress\": \"\",\n \"MainPhone\": \"\",\n \"Attention\": \"\",\n \"First Name\": \"\",\n \"Last Name\": \"\",\n \"Company\": \"\",\n \"Custom1\": \"\",\n \"Custom2\": \"\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"ContactID\": \"\",\n \"GroupID\": \"\",\n \"GroupCode\": \"\"\n },\n {\n \"ToNumber\": \"\",\n \"EmailAddress\": \"\",\n \"MainPhone\": \"\",\n \"Attention\": \"\",\n \"First Name\": \"\",\n \"Last Name\": \"\",\n \"Company\": \"\",\n \"Custom1\": \"\",\n \"Custom2\": \"\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"ContactID\": \"\",\n \"GroupID\": \"\",\n \"GroupCode\": \"\"\n }\n ],\n \"ContactID\": \"\",\n \"GroupID\": \"\",\n \"MessageID\": \"\",\n \"Reference\": \"\",\n \"NotificationType\": \"\",\n \"WebhookCallbackURL\": \"\",\n \"WebhookCallbackFormat\": \"\",\n \"ReportTo\": \"\",\n \"SendTime\": null,\n \"Timezone\": \"\",\n \"SubAccount\": \"\",\n \"Department\": \"\",\n \"FromNumber\": \"\",\n \"SMSEmailReply\": \"\",\n \"SMSCustomPageID\": \"\",\n \"CharacterConversion\": false,\n \"FallbackMode\": \"None\",\n \"Files\": [\n {\n \"Name\": \"\",\n \"Data\": \"\"\n },\n {\n \"Name\": \"\",\n \"Data\": \"\"\n }\n ],\n \"Mode\": null\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5266b909-ded7-4362-8dac-325fa19162e5", "name": "OK [successful submission]", "originalRequest": { "url": { "path": [ "sms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Message\": \"Hello, this is an SMS notification from Company One Ltd. Reply STOP to OptOut.\",\n \"Destination\": \"021-000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9884e92e-64f7-4f20-a95c-9c111f22980a", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "sms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Message\": \"Hello, this is an SMS notification from Company One Ltd. Reply STOP to OptOut.\",\n \"Destination\": \"021-000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1553acc5-9742-4b06-b047-f5b2e9841fc2", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "sms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Message\": \"Hello, this is an SMS notification from Company One Ltd. Reply STOP to OptOut.\",\n \"Destination\": \"021-000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "498fcc94-3d37-4498-b817-eac3cfff2e82", "name": "Not Found [record not found]", "originalRequest": { "url": { "path": [ "sms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Message\": \"Hello, this is an SMS notification from Company One Ltd. Reply STOP to OptOut.\",\n \"Destination\": \"021-000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"ErrorMessage\": [\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\",\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2c6adca-f461-4591-83c0-897df7b3118d", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "sms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Message\": \"Hello, this is an SMS notification from Company One Ltd. Reply STOP to OptOut.\",\n \"Destination\": \"021-000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48b19c77-a1de-4ab6-98dc-51464d041402", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "sms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Message\": \"Hello, this is an SMS notification from Company One Ltd. Reply STOP to OptOut.\",\n \"Destination\": \"021-000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b2bcce8-25bd-44f2-b961-596d0478a578", "name": "SMS Details", "request": { "name": "SMS Details", "description": { "content": "Poll for details of a sent SMS message.\n\nThe primary object details the message as a whole, while the `Recipients` array contains details of each recipient.\n\nUnder each recipient, an `SMSReplies` array will detail any received replies.\n\n> [!TIP]\n> Timeout your polls after 6 hours with no result.\n\n> [!CAUTION]\n> Limit your polls to 1 per second to avoid rate limits.\n\n> [!note]\n> Consider the [Send Result Webhook](#tag/sms/webhook/POST/resultwebhook) for efficiency.\n", "type": "text/plain" }, "url": { "path": [ "sms", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "40dbd6ee-3126-4144-808f-b8a364e08ef0", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "sms", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobStatus\": \"Pending\",\n \"JobNum\": \"10AB20CE\",\n \"Account\": \"101202\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"Reference\": \"MyTest\",\n \"CreatedTimeLocal\": \"2025-05-29 05:11:03\",\n \"CreatedTimeUTC\": \"2025-05-29 17:11:03\",\n \"CreatedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"DelayedTimeLocal\": \"2025-05-29 05:11:03\",\n \"DelayedTimeUTC\": \"2025-05-29 17:11:03\",\n \"DelayedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"Timezone\": \"New Zealand\",\n \"Count\": 1,\n \"Complete\": 1,\n \"Success\": 1,\n \"Failed\": 0,\n \"Price\": \"labor\",\n \"TotalRecords\": 1,\n \"RecordsPerPage\": 20,\n \"PageCount\": 1,\n \"Page\": 1,\n \"Recipients\": [\n {\n \"Type\": \"SMS\",\n \"DestSeq\": {\n \"value\": \"\"\n },\n \"Destination\": \"+64212223333\",\n \"ContactID\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n },\n \"Result\": \"Delivered\",\n \"MessageText\": \"Hello, we sent you a test message.\",\n \"SentTimeLocal\": {\n \"value\": \"\"\n },\n \"SentTimeUTC\": {\n \"value\": \"\"\n },\n \"SentTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Attention\": {\n \"value\": \"\"\n },\n \"Company\": {\n \"value\": \"\"\n },\n \"Custom1\": {\n \"value\": \"\"\n },\n \"Custom2\": {\n \"value\": \"\"\n },\n \"Custom3\": {\n \"value\": \"\"\n },\n \"Custom4\": {\n \"value\": \"\"\n },\n \"Custom5\": {\n \"value\": \"\"\n },\n \"Custom6\": {\n \"value\": \"\"\n },\n \"Custom7\": {\n \"value\": \"\"\n },\n \"Custom8\": {\n \"value\": \"\"\n },\n \"Custom9\": {\n \"value\": \"\"\n },\n \"RemoteID\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"SMSReplies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"Type\": \"SMS\",\n \"DestSeq\": {\n \"value\": \"\"\n },\n \"Destination\": \"+64212223333\",\n \"ContactID\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n },\n \"Result\": \"Delivered\",\n \"MessageText\": \"Hello, we sent you a test message.\",\n \"SentTimeLocal\": {\n \"value\": \"\"\n },\n \"SentTimeUTC\": {\n \"value\": \"\"\n },\n \"SentTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Attention\": {\n \"value\": \"\"\n },\n \"Company\": {\n \"value\": \"\"\n },\n \"Custom1\": {\n \"value\": \"\"\n },\n \"Custom2\": {\n \"value\": \"\"\n },\n \"Custom3\": {\n \"value\": \"\"\n },\n \"Custom4\": {\n \"value\": \"\"\n },\n \"Custom5\": {\n \"value\": \"\"\n },\n \"Custom6\": {\n \"value\": \"\"\n },\n \"Custom7\": {\n \"value\": \"\"\n },\n \"Custom8\": {\n \"value\": \"\"\n },\n \"Custom9\": {\n \"value\": \"\"\n },\n \"RemoteID\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"SMSReplies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "468c398e-5110-4c23-ae9a-0c1d9d2baf4c", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "sms", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17793d5c-fc43-4af8-8df9-6ac6e2124976", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "sms", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e9c6924-844e-4b4a-b173-379a10032d7c", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "sms", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b747ab55-8aef-4aba-8830-d3b00d9f1a95", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "sms", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "81f502dc-4756-470f-b5f2-763771dfb0c6", "name": "Inbound SMS", "request": { "name": "Inbound SMS", "description": { "content": "Poll for a list of SMS received in a given timeframe.\n\nYou may search based on `timePeriod` (return results from the last _x_ minutes) or by `dateFrom` to `dateTo` (return results within the specified timeframe).\n\nIf a received message can be matched as a reply, the `MessageID` parameter will contain the outbound message's `MessageID`.\n\n> [!CAUTION]\n> Limit your polls to 1 per second to avoid rate limits.\n\n> [!note]\n> Consider the [Inbound SMS Webhook](#tag/sms/webhook/POST/inboundsmswebhook) for efficiency.\n", "type": "text/plain" }, "url": { "path": [ "sms", "received" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "timePeriod", "value": "", "description": "(Required) Return results from the last _x_ minutes (e.g. last 5 minutes)." }, { "disabled": false, "key": "dateFrom", "value": "", "description": "Return results from the specified date in the API User's local time. Maximum 7 days." }, { "disabled": false, "key": "dateTo", "value": "", "description": "Return results to the specified date in the API User's local time. Maximum 7 days." }, { "disabled": false, "key": "recordsPerPage", "value": "", "description": "Number of records to return per page." }, { "disabled": false, "key": "page", "value": "1", "description": "Page number to retrieve." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "86b6bc8e-2091-4160-b92c-bc8157cd3e11", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "sms", "received" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "timePeriod", "value": "10" }, { "key": "dateFrom", "value": "2025-08-01T00:00:00" }, { "key": "dateTo", "value": "2025-08-01T12:00:00" }, { "key": "recordsPerPage", "value": "20" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"TotalRecords\": 1,\n \"RecordsPerPage\": 20,\n \"PageCount\": 1,\n \"Page\": 1,\n \"Messages\": [\n {\n \"ReceivedID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"MessageID\": \"7000000a-f002-4007-b00a-d00000000002\",\n \"JobNum\": \"10AB20CE\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"ReceivedTimeLocal\": \"2025-09-01 14:02:03\",\n \"ReceivedTimeUTC\": \"2025-09-01 02:02:03\",\n \"ReceivedTimeUTC_RFC3339\": \"2025-09-01T02:02:03.000Z\",\n \"From\": \"+6421000001\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"MessageText\": \"This is a received message from a mobile phone.\",\n \"Timezone\": \"New Zealand\",\n \"Version\": \"v3.00\"\n },\n {\n \"ReceivedID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"MessageID\": \"7000000a-f002-4007-b00a-d00000000002\",\n \"JobNum\": \"10AB20CE\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"ReceivedTimeLocal\": \"2025-09-01 14:02:03\",\n \"ReceivedTimeUTC\": \"2025-09-01 02:02:03\",\n \"ReceivedTimeUTC_RFC3339\": \"2025-09-01T02:02:03.000Z\",\n \"From\": \"+6421000001\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"MessageText\": \"This is a received message from a mobile phone.\",\n \"Timezone\": \"New Zealand\",\n \"Version\": \"v3.00\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd62892d-cbac-4cd1-aac9-daa95faad242", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "sms", "received" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "timePeriod", "value": "10" }, { "key": "dateFrom", "value": "2025-08-01T00:00:00" }, { "key": "dateTo", "value": "2025-08-01T12:00:00" }, { "key": "recordsPerPage", "value": "20" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cd49df3-b747-4320-a37d-bd6a0f6accdc", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "sms", "received" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "timePeriod", "value": "10" }, { "key": "dateFrom", "value": "2025-08-01T00:00:00" }, { "key": "dateTo", "value": "2025-08-01T12:00:00" }, { "key": "recordsPerPage", "value": "20" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7917eaec-4dfc-4d5f-86be-9c90763e4be5", "name": "Reschedule", "request": { "name": "Reschedule", "description": { "content": "This endpoint allows you to reschedule a previously delayed message to be sent at a new time.\n", "type": "text/plain" }, "url": { "path": [ "sms", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cd6c86d3-e42d-4a9b-8b39-8f4a679ec392", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "sms", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ActionResult\": \"Success\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobNum\": \"10AB20CE\",\n \"Status\": \"Pending\",\n \"Action\": \"Reschedule\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd7647e9-5d06-4334-a3c8-3fde36fb8556", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "sms", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d43beda0-f309-40eb-bc72-81f6b1db9ab2", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "sms", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c9d4f6d-a332-4f3b-a39e-7316943a6d60", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "sms", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "219e4576-d89c-4780-89d3-93e785db0743", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "sms", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0d24fda-4db0-4909-b39c-467089ee08e2", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "sms", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4fb5fedf-e731-468d-ae71-7a9b6a5cd57b", "name": "Abort", "request": { "name": "Abort", "description": { "content": "This endpoint allows you to abort a previously delayed message.\n", "type": "text/plain" }, "url": { "path": [ "sms", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "72c9dce3-3e71-46a4-a01b-81d91990ffa5", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "sms", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ActionResult\": \"Success\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobNum\": \"10AB20CE\",\n \"Status\": \"Pending\",\n \"Action\": \"Abort\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e4e6134-861d-44c8-a80a-1925e2065256", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "sms", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "450af620-0c11-49a7-b180-0992159a781b", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "sms", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c7c38b2-665b-490b-bf4e-1417434276cf", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "sms", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b8f30a8-2853-4876-a943-8920e459a480", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "sms", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bced2e64-7a23-4120-92df-1e6d622cce36", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "sms", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "489ff10b-2fb0-4039-a272-db9cba6c1e37", "name": "Email", "description": { "content": "Go beyond plain text with our flexible Email API. Send beautifully crafted HTML emails using your own content or pre-configured templates. Or specify a `TemplateID` and let users manage their own HTML designs using the Dashboard's WYSIWYG editor.\n\nTrack link clicks and attach files on the fly.\n\nWhether you're sending invoices, newsletters, or critical alerts, you can monitor delivery status every step of the way.\n\n![Email](https://www.tnz.co.nz/docs/restapi/assets/images/Email[128x75].png)\n", "type": "text/plain" }, "item": [ { "id": "fe2055fc-4af7-4520-9e69-de3be3175e14", "name": "Send Email", "request": { "name": "Send Email", "description": { "content": "Send an Email message to one or more recipients.\n\nThe `Message` parameter specifies the SMS text. Alternatively, use `TemplateID` to send a pre-configured message template ([Find Your TemplateID](https://www.tnz.co.nz/help/how-to-find-your-templateid)).\n\nThe `Destination` parameter contains the email address to receive your message. Alternatively, you may use the `Destinations` array for multiple contacts, or use Address Book `ContactID` or `GroupID` values.\n", "type": "text/plain" }, "url": { "path": [ "email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"MessagePlain\": \"\",\n \"MessageHTML\": \"\",\n \"TemplateID\": \"\",\n \"Destination\": \"\",\n \"EmailAddress\": \"\",\n \"ContactID\": \"\",\n \"GroupID\": \"\",\n \"Destinations\": [\n {\n \"ToNumber\": \"\",\n \"EmailAddress\": \"\",\n \"MainPhone\": \"\",\n \"Attention\": \"\",\n \"First Name\": \"\",\n \"Last Name\": \"\",\n \"Company\": \"\",\n \"Custom1\": \"\",\n \"Custom2\": \"\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"ContactID\": \"\",\n \"GroupID\": \"\",\n \"GroupCode\": \"\"\n },\n {\n \"ToNumber\": \"\",\n \"EmailAddress\": \"\",\n \"MainPhone\": \"\",\n \"Attention\": \"\",\n \"First Name\": \"\",\n \"Last Name\": \"\",\n \"Company\": \"\",\n \"Custom1\": \"\",\n \"Custom2\": \"\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"ContactID\": \"\",\n \"GroupID\": \"\",\n \"GroupCode\": \"\"\n }\n ],\n \"MessageID\": \"\",\n \"Reference\": \"\",\n \"From\": \"\",\n \"FromEmail\": \"\",\n \"CCEmail\": \"\",\n \"BCCEmail\": \"\",\n \"ReplyTo\": \"\",\n \"EmailSubject\": \"\",\n \"NotificationType\": \"\",\n \"WebhookCallbackURL\": \"\",\n \"WebhookCallbackFormat\": \"\",\n \"ReportTo\": \"\",\n \"SendTime\": null,\n \"Timezone\": \"\",\n \"SubAccount\": \"\",\n \"Department\": \"\",\n \"Files\": [\n {\n \"Name\": \"\",\n \"Data\": \"\"\n },\n {\n \"Name\": \"\",\n \"Data\": \"\"\n }\n ],\n \"Mode\": null\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "781871d7-bcf8-42bb-9cef-bfb93a156c0f", "name": "OK [successful submission]", "originalRequest": { "url": { "path": [ "email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessagePlain\": \"Hello, this is an Email notification from Company One Ltd.\",\n \"Destination\": \"john.doe@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f991357-1b86-4937-b5db-8173cf84d109", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessagePlain\": \"Hello, this is an Email notification from Company One Ltd.\",\n \"Destination\": \"john.doe@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68ed7084-3415-4856-be44-18c6876c4658", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessagePlain\": \"Hello, this is an Email notification from Company One Ltd.\",\n \"Destination\": \"john.doe@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a53a0c5f-92f5-4c7e-a313-958e742f21f5", "name": "Not Found [record not found]", "originalRequest": { "url": { "path": [ "email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessagePlain\": \"Hello, this is an Email notification from Company One Ltd.\",\n \"Destination\": \"john.doe@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"ErrorMessage\": [\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\",\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c3dd9e1-a98a-44d1-b5d7-cf6b8a7777bf", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessagePlain\": \"Hello, this is an Email notification from Company One Ltd.\",\n \"Destination\": \"john.doe@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a167e1e5-35bf-4d6d-a0c9-410228295cd1", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessagePlain\": \"Hello, this is an Email notification from Company One Ltd.\",\n \"Destination\": \"john.doe@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "63d30e42-34d7-4f83-b405-1f63d4c6f183", "name": "Email Details", "request": { "name": "Email Details", "description": { "content": "Poll for details of a sent Email message.\n\nThe primary object details the message as a whole, while the `Recipients` array contains details of each recipient.\n\n> [!TIP]\n> Timeout your polls after 6 hours with no result.\n\n> [!CAUTION]\n> Limit your polls to 1 per second to avoid rate limits.\n\n> [!note]\n> Consider the [Send Result Webhook](#tag/email/webhook/POST/resultwebhook) for efficiency.\n", "type": "text/plain" }, "url": { "path": [ "email", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2c597639-d2c1-45a1-845d-2bc5b9e64daf", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "email", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobStatus\": \"Pending\",\n \"JobNum\": \"10AB20CE\",\n \"Account\": \"101202\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"Reference\": \"MyTest\",\n \"CreatedTimeLocal\": \"2025-05-29 05:11:03\",\n \"CreatedTimeUTC\": \"2025-05-29 17:11:03\",\n \"CreatedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"DelayedTimeLocal\": \"2025-05-29 05:11:03\",\n \"DelayedTimeUTC\": \"2025-05-29 17:11:03\",\n \"DelayedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"Timezone\": \"New Zealand\",\n \"Count\": 1,\n \"Complete\": 1,\n \"Success\": 1,\n \"Failed\": 0,\n \"Price\": \"quis\",\n \"TotalRecords\": 1,\n \"RecordsPerPage\": 20,\n \"PageCount\": 1,\n \"Page\": 1,\n \"Recipients\": [\n {\n \"Type\": \"Email\",\n \"DestSeq\": {\n \"value\": \"\"\n },\n \"Destination\": \"john.doe@example.com\",\n \"ContactID\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n },\n \"Result\": \"250 OK\",\n \"SentTimeLocal\": {\n \"value\": \"\"\n },\n \"SentTimeUTC\": {\n \"value\": \"\"\n },\n \"SentTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Attention\": {\n \"value\": \"\"\n },\n \"Company\": {\n \"value\": \"\"\n },\n \"Custom1\": {\n \"value\": \"\"\n },\n \"Custom2\": {\n \"value\": \"\"\n },\n \"Custom3\": {\n \"value\": \"\"\n },\n \"Custom4\": {\n \"value\": \"\"\n },\n \"Custom5\": {\n \"value\": \"\"\n },\n \"Custom6\": {\n \"value\": \"\"\n },\n \"Custom7\": {\n \"value\": \"\"\n },\n \"Custom8\": {\n \"value\": \"\"\n },\n \"Custom9\": {\n \"value\": \"\"\n },\n \"RemoteID\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n }\n },\n {\n \"Type\": \"Email\",\n \"DestSeq\": {\n \"value\": \"\"\n },\n \"Destination\": \"john.doe@example.com\",\n \"ContactID\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n },\n \"Result\": \"250 OK\",\n \"SentTimeLocal\": {\n \"value\": \"\"\n },\n \"SentTimeUTC\": {\n \"value\": \"\"\n },\n \"SentTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Attention\": {\n \"value\": \"\"\n },\n \"Company\": {\n \"value\": \"\"\n },\n \"Custom1\": {\n \"value\": \"\"\n },\n \"Custom2\": {\n \"value\": \"\"\n },\n \"Custom3\": {\n \"value\": \"\"\n },\n \"Custom4\": {\n \"value\": \"\"\n },\n \"Custom5\": {\n \"value\": \"\"\n },\n \"Custom6\": {\n \"value\": \"\"\n },\n \"Custom7\": {\n \"value\": \"\"\n },\n \"Custom8\": {\n \"value\": \"\"\n },\n \"Custom9\": {\n \"value\": \"\"\n },\n \"RemoteID\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0175ad1-1dad-4cd2-a01b-92df1d52c884", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "email", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06eae5c2-e69e-4b4a-9098-f3407aa30c4f", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "email", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1eea214a-25af-4fd9-bb63-54473a6b75ab", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "email", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c5c44c4-3651-4aba-b4e3-1a6c5e656d9d", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "email", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d3dbdd15-8975-4118-a715-4dbac056d095", "name": "Reschedule", "request": { "name": "Reschedule", "description": { "content": "This endpoint allows you to reschedule a previously delayed message to be sent at a new time.\n", "type": "text/plain" }, "url": { "path": [ "email", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9a97d959-0cce-4f10-9886-f1b46fff2010", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "email", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ActionResult\": \"Success\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobNum\": \"10AB20CE\",\n \"Status\": \"Pending\",\n \"Action\": \"Reschedule\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ce40cfc-21a0-49a8-91a3-1872edf79f7f", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "email", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7dd68fa-7342-4ac1-8511-804583abd47e", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "email", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b6669e3-0f3b-4ab6-9f66-dc1a03bbe61b", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "email", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe4d8a3d-3bc0-4203-9b6c-8a3287f31da5", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "email", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfbc265b-7cdc-4d96-94a5-31c987a79b25", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "email", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ace209e3-a041-45fb-a0e2-249fd45e0278", "name": "Abort", "request": { "name": "Abort", "description": { "content": "This endpoint allows you to abort a previously delayed message.\n", "type": "text/plain" }, "url": { "path": [ "email", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f110890d-e1f8-4dc8-a176-75fefc411247", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "email", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ActionResult\": \"Success\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobNum\": \"10AB20CE\",\n \"Status\": \"Pending\",\n \"Action\": \"Abort\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fb8570a-3845-4468-b92e-5150b636b0ce", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "email", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7f17e6a-b65a-41ea-aac6-0e11650b035a", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "email", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa9c77c2-e68a-45cf-96bf-72c1782aef84", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "email", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3842e1f1-4ff0-4745-ba86-b1d0ca6ff795", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "email", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e53991bd-6a41-48f0-ad25-68643768fdb0", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "email", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "de931e52-d003-43c9-aa7b-6d7359eae508", "name": "Resubmit", "request": { "name": "Resubmit", "description": { "content": "This endpoint allows you to retry sending a previously failed message.\n", "type": "text/plain" }, "url": { "path": [ "email", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "df72660b-93a8-463c-874d-aff5df4cecfa", "name": "OK [message found].", "originalRequest": { "url": { "path": [ "email", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ActionResult\": \"Success\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobNum\": \"10AB20CE\",\n \"Status\": \"Pending\",\n \"Action\": \"Resubmit\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6c701b1-6467-4660-b384-8f995309c4af", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "email", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55058e34-0243-4b67-9442-45bc3828e6f2", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "email", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffd98140-ce66-49e8-b6b6-e0419309b6e7", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "email", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e83c1818-b4a8-4807-9e10-a4eb42bc6a61", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "email", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "794d4ba5-d14c-4865-8d12-c3d7cf44841b", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "email", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b22f57bd-df8f-48ad-ac75-44ec79b8581d", "name": "TTS", "description": { "content": "Transform your written text into clear, natural-sounding voice calls with our Text-to-Speech (TTS) API. Ideal for automated alerts, appointment reminders, or customer surveys.\n\nCustomize calls with different voices, SSML command support, and interactive keypad options that can route callers or capture responses.\n\nAnswering machine detection ensures your message is delivered effectively, whether to a person or a voicemail.\n\n![TTS](https://www.tnz.co.nz/docs/restapi/assets/images/TTS[128x75].png)\n", "type": "text/plain" }, "item": [ { "id": "6ca99dd7-a3e8-4b7e-8f6f-1616541c7bfe", "name": "Send TTS", "request": { "name": "Send TTS", "description": { "content": "Send a Voice Call using Text-to-Speech to one or more recipients.\n\nThe `MessageToPeople` parameter specifies the message to send. Alternatively, use `TemplateID` to send a pre-configured message template ([Find Your TemplateID](https://www.tnz.co.nz/help/how-to-find-your-templateid)).\n\nThe `Destination` parameter contains the email address to receive your message. Alternatively, you may use the `Destinations` array for multiple contacts, or use Address Book `ContactID` or `GroupID` values.\n", "type": "text/plain" }, "url": { "path": [ "tts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"MessageToPeople\": \"\",\n \"TemplateID\": \"\",\n \"Destination\": \"\",\n \"ToNumber\": \"\",\n \"Destinations\": [\n {\n \"ToNumber\": \"\",\n \"EmailAddress\": \"\",\n \"MainPhone\": \"\",\n \"Attention\": \"\",\n \"First Name\": \"\",\n \"Last Name\": \"\",\n \"Company\": \"\",\n \"Custom1\": \"\",\n \"Custom2\": \"\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"ContactID\": \"\",\n \"GroupID\": \"\",\n \"GroupCode\": \"\"\n },\n {\n \"ToNumber\": \"\",\n \"EmailAddress\": \"\",\n \"MainPhone\": \"\",\n \"Attention\": \"\",\n \"First Name\": \"\",\n \"Last Name\": \"\",\n \"Company\": \"\",\n \"Custom1\": \"\",\n \"Custom2\": \"\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"ContactID\": \"\",\n \"GroupID\": \"\",\n \"GroupCode\": \"\"\n }\n ],\n \"ContactID\": \"\",\n \"GroupID\": \"\",\n \"MessageID\": \"\",\n \"Reference\": \"\",\n \"NotificationType\": \"\",\n \"WebhookCallbackURL\": \"\",\n \"WebhookCallbackFormat\": \"\",\n \"ReportTo\": \"\",\n \"SendTime\": null,\n \"Timezone\": \"\",\n \"SubAccount\": \"\",\n \"Department\": \"\",\n \"MessageToAnswerPhones\": \"\",\n \"AnswerPhoneMode\": \"NDAS\",\n \"Keypads\": [\n {\n \"Tone\": \"\",\n \"Play\": \"\",\n \"RouteNumber\": \"\",\n \"PlaySection\": \"\"\n },\n {\n \"Tone\": \"\",\n \"Play\": \"\",\n \"RouteNumber\": \"\",\n \"PlaySection\": \"\"\n }\n ],\n \"KeypadOptionRequired\": false,\n \"CallRouteMessageOnWrongKey\": \"\",\n \"CallRouteMessageToPeople\": \"\",\n \"CallRouteMessageToOperators\": \"\",\n \"NumberOfOperators\": 99999,\n \"RetryAttempts\": \"\",\n \"RetryPeriod\": \"\",\n \"CallerID\": \"\",\n \"Voice\": \"Female1\",\n \"Options\": \"\",\n \"Mode\": null\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b50c26a1-5eef-4546-8733-9edbe0d435a6", "name": "OK [successful submission]", "originalRequest": { "url": { "path": [ "tts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageToPeople\": \"Hello, this is an TTS notification from Company One Ltd.\",\n \"Destination\": \"021-000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb12bc5a-b355-4ffb-8dc2-0e5a21eda8d1", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "tts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageToPeople\": \"Hello, this is an TTS notification from Company One Ltd.\",\n \"Destination\": \"021-000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "658c59cc-14e4-4364-ad82-91387e1b51d5", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "tts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageToPeople\": \"Hello, this is an TTS notification from Company One Ltd.\",\n \"Destination\": \"021-000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c797698b-9921-47fe-8e1b-34085d057c36", "name": "Not Found [record not found]", "originalRequest": { "url": { "path": [ "tts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageToPeople\": \"Hello, this is an TTS notification from Company One Ltd.\",\n \"Destination\": \"021-000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"ErrorMessage\": [\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\",\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21d787e4-7f90-495e-a5b2-cc988575b007", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "tts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageToPeople\": \"Hello, this is an TTS notification from Company One Ltd.\",\n \"Destination\": \"021-000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4960208c-f8e2-47ff-85e8-f997d616f94a", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "tts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageToPeople\": \"Hello, this is an TTS notification from Company One Ltd.\",\n \"Destination\": \"021-000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "85fd146f-dca5-41ce-8318-c684f91d48eb", "name": "TTS Details", "request": { "name": "TTS Details", "description": { "content": "Poll for details of a sent TTS message.\n\nThe primary object details the message as a whole, while the `Recipients` array contains details of each recipient.\n\n> [!TIP]\n> Timeout your polls after 6 hours with no result.\n\n> [!CAUTION]\n> Limit your polls to 1 per second to avoid rate limits.\n\n> [!note]\n> Consider the [Send Result Webhook](#tag/tts/webhook/POST/resultwebhook) for efficiency.\n", "type": "text/plain" }, "url": { "path": [ "tts", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d4200ae0-56be-4add-8310-45d1171ed5f1", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "tts", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobStatus\": \"Pending\",\n \"JobNum\": \"10AB20CE\",\n \"Account\": \"101202\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"Reference\": \"MyTest\",\n \"CreatedTimeLocal\": \"2025-05-29 05:11:03\",\n \"CreatedTimeUTC\": \"2025-05-29 17:11:03\",\n \"CreatedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"DelayedTimeLocal\": \"2025-05-29 05:11:03\",\n \"DelayedTimeUTC\": \"2025-05-29 17:11:03\",\n \"DelayedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"Timezone\": \"New Zealand\",\n \"Count\": 1,\n \"Complete\": 1,\n \"Success\": 1,\n \"Failed\": 0,\n \"Price\": \"pariatur\",\n \"TotalRecords\": 1,\n \"RecordsPerPage\": 20,\n \"PageCount\": 1,\n \"Page\": 1,\n \"Recipients\": [\n {\n \"Type\": \"Voice\",\n \"DestSeq\": {\n \"value\": \"\"\n },\n \"Destination\": \"+6495006000\",\n \"ContactID\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n },\n \"Result\": \"SentOK\",\n \"SentTimeLocal\": {\n \"value\": \"\"\n },\n \"SentTimeUTC\": {\n \"value\": \"\"\n },\n \"SentTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Attention\": {\n \"value\": \"\"\n },\n \"Company\": {\n \"value\": \"\"\n },\n \"Custom1\": {\n \"value\": \"\"\n },\n \"Custom2\": {\n \"value\": \"\"\n },\n \"Custom3\": {\n \"value\": \"\"\n },\n \"Custom4\": {\n \"value\": \"\"\n },\n \"Custom5\": {\n \"value\": \"\"\n },\n \"Custom6\": {\n \"value\": \"\"\n },\n \"Custom7\": {\n \"value\": \"\"\n },\n \"Custom8\": {\n \"value\": \"\"\n },\n \"Custom9\": {\n \"value\": \"\"\n },\n \"RemoteID\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n }\n },\n {\n \"Type\": \"Voice\",\n \"DestSeq\": {\n \"value\": \"\"\n },\n \"Destination\": \"+6495006000\",\n \"ContactID\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n },\n \"Result\": \"SentOK\",\n \"SentTimeLocal\": {\n \"value\": \"\"\n },\n \"SentTimeUTC\": {\n \"value\": \"\"\n },\n \"SentTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Attention\": {\n \"value\": \"\"\n },\n \"Company\": {\n \"value\": \"\"\n },\n \"Custom1\": {\n \"value\": \"\"\n },\n \"Custom2\": {\n \"value\": \"\"\n },\n \"Custom3\": {\n \"value\": \"\"\n },\n \"Custom4\": {\n \"value\": \"\"\n },\n \"Custom5\": {\n \"value\": \"\"\n },\n \"Custom6\": {\n \"value\": \"\"\n },\n \"Custom7\": {\n \"value\": \"\"\n },\n \"Custom8\": {\n \"value\": \"\"\n },\n \"Custom9\": {\n \"value\": \"\"\n },\n \"RemoteID\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b796707-37b0-4f7f-a944-81dff868476a", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "tts", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f52b5a8c-7a79-4abb-8e23-1016b0372da1", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "tts", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a98e387b-b75f-49f9-97f8-648e90ebd8b4", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "tts", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8a86d0d-66a8-4fa8-b180-6b5dfbece3fb", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "tts", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b975a882-8993-4dd3-9a30-33e4b351f9ec", "name": "Reschedule", "request": { "name": "Reschedule", "description": { "content": "This endpoint allows you to reschedule a previously delayed message to be sent at a new time.\n", "type": "text/plain" }, "url": { "path": [ "tts", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ea987175-c87f-4fec-97cb-fcf09ed8d0b5", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "tts", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ActionResult\": \"Success\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobNum\": \"10AB20CE\",\n \"Status\": \"Pending\",\n \"Action\": \"Reschedule\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47d303b3-3364-43dc-946d-1bc5faadeb67", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "tts", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9992016-4b14-403c-9f29-64006c0a0c84", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "tts", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a834cb2c-f02c-4cb0-b5f6-682931f0a7b5", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "tts", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d60e96d3-1104-49c2-9d44-debefafe76a6", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "tts", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9514509-b745-4ce4-a10a-76d87fa61e42", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "tts", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e158f14-fe9d-4d45-839a-9b852ade87e3", "name": "Abort", "request": { "name": "Abort", "description": { "content": "This endpoint allows you to abort a previously delayed message.\n", "type": "text/plain" }, "url": { "path": [ "tts", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1c1edd2c-80b8-43a1-9e30-4519a6023004", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "tts", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ActionResult\": \"Success\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobNum\": \"10AB20CE\",\n \"Status\": \"Pending\",\n \"Action\": \"Abort\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d480e73-99ff-4882-86a6-588471b8c76e", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "tts", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4aa654d7-ad5a-41f5-b09b-1b5d6ce53954", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "tts", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b496ae5-2f12-4278-b967-a627c050c7e0", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "tts", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "399b2ab3-42a3-4e17-8287-58baa7aacf94", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "tts", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "266fdbae-3c5a-4939-93fd-116b3500263b", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "tts", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f7c232db-79cc-44b2-8df6-becc536d3d33", "name": "Resubmit", "request": { "name": "Resubmit", "description": { "content": "This endpoint allows you to retry sending a previously failed message.\n", "type": "text/plain" }, "url": { "path": [ "tts", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2808cf7c-c05e-400e-a78a-6471aa8884a5", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "tts", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ActionResult\": \"Success\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobNum\": \"10AB20CE\",\n \"Status\": \"Pending\",\n \"Action\": \"Resubmit\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d34b529-ad4b-4bf4-8242-fa272c8a087b", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "tts", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04ae5e20-1c2a-4f84-ab40-f686fb1cd26b", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "tts", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "449c0071-1181-49c4-8134-cc61477882be", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "tts", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4973a20-fcb3-4937-9dec-c1d88490a009", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "tts", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4063f648-f954-49e6-addf-d4cec63c5c4f", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "tts", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5101c9c8-c1c3-4d47-a7c8-ee4e27d369f5", "name": "Number Of Operators", "request": { "name": "Number Of Operators", "description": { "content": "This endpoint allows you to adjust the `NumberOfOperators` configured for a pending message.\n", "type": "text/plain" }, "url": { "path": [ "tts", ":MessageID", "pacing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"NumberOfOperators\": 99999\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e85ffb4f-8b37-464d-83bc-a90f895268b7", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "tts", ":MessageID", "pacing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"NumberOfOperators\": 5\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ActionResult\": \"Success\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobNum\": \"10AB20CE\",\n \"Status\": \"Pending\",\n \"Action\": \"Pacing\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fdcdee2-d93f-4dd9-ba38-4f8e45463590", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "tts", ":MessageID", "pacing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"NumberOfOperators\": 5\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da495d32-c4d4-4b41-91b8-1bdf12e31914", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "tts", ":MessageID", "pacing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"NumberOfOperators\": 5\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a4172e2-14e8-464a-969b-dff9fc5e021f", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "tts", ":MessageID", "pacing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"NumberOfOperators\": 5\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d43211c-f0ff-44d6-b97a-0132d43fbaee", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "tts", ":MessageID", "pacing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"NumberOfOperators\": 5\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56ebde3e-7670-44cb-a38b-0f065ba5824e", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "tts", ":MessageID", "pacing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"NumberOfOperators\": 5\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "e8fde1fe-0e04-42ad-ae80-f9aa9eac97fa", "name": "Voice", "description": { "content": "Deliver impactful messages by sending pre-recorded audio files as voice calls. Perfect for alerts where a human voice adds a personal touch or when conveying complex information.\n\nThis endpoint allows you to manage calls to individuals or large groups, with powerful features like retry attempts for failed calls, answering machine detection, and interactive keypad responses.\n\n![Voice](https://www.tnz.co.nz/docs/restapi/assets/images/Voice[128x75].png)\n", "type": "text/plain" }, "item": [ { "id": "0faf7a08-ca9e-4e8c-a3e6-360d6975df45", "name": "Send Voice", "request": { "name": "Send Voice", "description": { "content": "Send a Voice Call using Text-to-Speech to one or more recipients.\n\nThe `MessageToPeople` parameter specifies the message to send. Alternatively, use `TemplateID` to send a pre-configured message template ([Find Your TemplateID](https://www.tnz.co.nz/help/how-to-find-your-templateid)).\n\nThe `Destination` parameter contains the email address to receive your message. Alternatively, you may use the `Destinations` array for multiple contacts, or use Address Book `ContactID` or `GroupID` values.\n", "type": "text/plain" }, "url": { "path": [ "voice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"MessageToPeople\": \"\",\n \"TemplateID\": \"\",\n \"Destination\": \"\",\n \"ToNumber\": \"\",\n \"Destinations\": [\n {\n \"ToNumber\": \"\",\n \"EmailAddress\": \"\",\n \"MainPhone\": \"\",\n \"Attention\": \"\",\n \"First Name\": \"\",\n \"Last Name\": \"\",\n \"Company\": \"\",\n \"Custom1\": \"\",\n \"Custom2\": \"\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"ContactID\": \"\",\n \"GroupID\": \"\",\n \"GroupCode\": \"\"\n },\n {\n \"ToNumber\": \"\",\n \"EmailAddress\": \"\",\n \"MainPhone\": \"\",\n \"Attention\": \"\",\n \"First Name\": \"\",\n \"Last Name\": \"\",\n \"Company\": \"\",\n \"Custom1\": \"\",\n \"Custom2\": \"\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"ContactID\": \"\",\n \"GroupID\": \"\",\n \"GroupCode\": \"\"\n }\n ],\n \"ContactID\": \"\",\n \"GroupID\": \"\",\n \"MessageID\": \"\",\n \"Reference\": \"\",\n \"NotificationType\": \"\",\n \"WebhookCallbackURL\": \"\",\n \"WebhookCallbackFormat\": \"\",\n \"ReportTo\": \"\",\n \"SendTime\": null,\n \"Timezone\": \"\",\n \"SubAccount\": \"\",\n \"Department\": \"\",\n \"MessageToAnswerPhones\": \"\",\n \"AnswerPhoneMode\": \"NDAS\",\n \"Keypads\": [\n {\n \"Tone\": \"\",\n \"Play\": \"\",\n \"RouteNumber\": \"\",\n \"PlaySection\": \"\"\n },\n {\n \"Tone\": \"\",\n \"Play\": \"\",\n \"RouteNumber\": \"\",\n \"PlaySection\": \"\"\n }\n ],\n \"KeypadOptionRequired\": false,\n \"CallRouteMessageOnWrongKey\": \"\",\n \"CallRouteMessageToPeople\": \"\",\n \"CallRouteMessageToOperators\": \"\",\n \"NumberOfOperators\": 99999,\n \"RetryAttempts\": \"\",\n \"RetryPeriod\": \"\",\n \"CallerID\": \"\",\n \"Options\": \"\",\n \"Mode\": null\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0d5debcd-06cc-4c92-8942-c2a820bc7c06", "name": "OK [successful submission]", "originalRequest": { "url": { "path": [ "voice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageToPeople\": \"[Base64 encoded data]\",\n \"Destination\": \"021-000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec402658-1c44-476f-b179-e95b78a12e6f", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "voice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageToPeople\": \"[Base64 encoded data]\",\n \"Destination\": \"021-000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3757ed7b-b481-438c-bbad-55103bc19de7", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "voice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageToPeople\": \"[Base64 encoded data]\",\n \"Destination\": \"021-000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57ff2f0b-72d2-4db0-8452-cf49853d8b43", "name": "Not Found [record not found]", "originalRequest": { "url": { "path": [ "voice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageToPeople\": \"[Base64 encoded data]\",\n \"Destination\": \"021-000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"ErrorMessage\": [\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\",\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "077e3a77-211f-4612-9a82-db998f45904e", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "voice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageToPeople\": \"[Base64 encoded data]\",\n \"Destination\": \"021-000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8ba10df-48c1-40f0-987d-708514717f44", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "voice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MessageToPeople\": \"[Base64 encoded data]\",\n \"Destination\": \"021-000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f5518b73-6c91-4633-a7a8-7af003b97196", "name": "Voice Details", "request": { "name": "Voice Details", "description": { "content": "Poll for details of a sent Voice message.\n\nThe primary object details the message as a whole, while the `Recipients` array contains details of each recipient.\n\n> [!TIP]\n> Timeout your polls after 6 hours with no result.\n\n> [!CAUTION]\n> Limit your polls to 1 per second to avoid rate limits.\n\n> [!note]\n> Consider the [Send Result Webhook](#tag/voice/webhook/POST/resultwebhook) for efficiency.\n", "type": "text/plain" }, "url": { "path": [ "voice", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e9968157-e050-4e8c-9cae-dedefffcc7bd", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "voice", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobStatus\": \"Pending\",\n \"JobNum\": \"10AB20CE\",\n \"Account\": \"101202\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"Reference\": \"MyTest\",\n \"CreatedTimeLocal\": \"2025-05-29 05:11:03\",\n \"CreatedTimeUTC\": \"2025-05-29 17:11:03\",\n \"CreatedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"DelayedTimeLocal\": \"2025-05-29 05:11:03\",\n \"DelayedTimeUTC\": \"2025-05-29 17:11:03\",\n \"DelayedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"Timezone\": \"New Zealand\",\n \"Count\": 1,\n \"Complete\": 1,\n \"Success\": 1,\n \"Failed\": 0,\n \"Price\": \"pariatur\",\n \"TotalRecords\": 1,\n \"RecordsPerPage\": 20,\n \"PageCount\": 1,\n \"Page\": 1,\n \"Recipients\": [\n {\n \"Type\": \"Voice\",\n \"DestSeq\": {\n \"value\": \"\"\n },\n \"Destination\": \"+6495006000\",\n \"ContactID\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n },\n \"Result\": \"SentOK\",\n \"SentTimeLocal\": {\n \"value\": \"\"\n },\n \"SentTimeUTC\": {\n \"value\": \"\"\n },\n \"SentTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Attention\": {\n \"value\": \"\"\n },\n \"Company\": {\n \"value\": \"\"\n },\n \"Custom1\": {\n \"value\": \"\"\n },\n \"Custom2\": {\n \"value\": \"\"\n },\n \"Custom3\": {\n \"value\": \"\"\n },\n \"Custom4\": {\n \"value\": \"\"\n },\n \"Custom5\": {\n \"value\": \"\"\n },\n \"Custom6\": {\n \"value\": \"\"\n },\n \"Custom7\": {\n \"value\": \"\"\n },\n \"Custom8\": {\n \"value\": \"\"\n },\n \"Custom9\": {\n \"value\": \"\"\n },\n \"RemoteID\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n }\n },\n {\n \"Type\": \"Voice\",\n \"DestSeq\": {\n \"value\": \"\"\n },\n \"Destination\": \"+6495006000\",\n \"ContactID\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n },\n \"Result\": \"SentOK\",\n \"SentTimeLocal\": {\n \"value\": \"\"\n },\n \"SentTimeUTC\": {\n \"value\": \"\"\n },\n \"SentTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Attention\": {\n \"value\": \"\"\n },\n \"Company\": {\n \"value\": \"\"\n },\n \"Custom1\": {\n \"value\": \"\"\n },\n \"Custom2\": {\n \"value\": \"\"\n },\n \"Custom3\": {\n \"value\": \"\"\n },\n \"Custom4\": {\n \"value\": \"\"\n },\n \"Custom5\": {\n \"value\": \"\"\n },\n \"Custom6\": {\n \"value\": \"\"\n },\n \"Custom7\": {\n \"value\": \"\"\n },\n \"Custom8\": {\n \"value\": \"\"\n },\n \"Custom9\": {\n \"value\": \"\"\n },\n \"RemoteID\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d19abd03-d689-41a9-b309-a3423a7c3333", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "voice", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40f173f8-7e6b-4f46-b207-d64b4eef5a81", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "voice", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb413953-20a0-49d6-961b-13c50eef3253", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "voice", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbeb9f1f-015f-4012-b3b6-e315b2627f0f", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "voice", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0ed1c504-ecbf-430a-8b19-d576d0756e0a", "name": "Reschedule", "request": { "name": "Reschedule", "description": { "content": "This endpoint allows you to reschedule a previously delayed message to be sent at a new time.\n", "type": "text/plain" }, "url": { "path": [ "voice", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5e846f85-c567-4b3a-b778-332dfe71e516", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "voice", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ActionResult\": \"Success\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobNum\": \"10AB20CE\",\n \"Status\": \"Pending\",\n \"Action\": \"Reschedule\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e385621-5371-42da-90ee-bebfacd26752", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "voice", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ef820f7-0b3e-4bd3-a3e1-157f5f7381e4", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "voice", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1559a6c3-993b-4779-b857-d047ee5cb987", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "voice", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "deeff0e8-730d-4fe1-ac2e-3fe85e695fbf", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "voice", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3fd2b57-be3d-4892-b6a7-0f57e89714e4", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "voice", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3e1130a3-34fd-4888-9ee2-3a054332dbce", "name": "Abort", "request": { "name": "Abort", "description": { "content": "This endpoint allows you to abort a previously delayed message.\n", "type": "text/plain" }, "url": { "path": [ "voice", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d2deae0b-e683-4e04-988c-e8e6e795d07f", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "voice", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ActionResult\": \"Success\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobNum\": \"10AB20CE\",\n \"Status\": \"Pending\",\n \"Action\": \"Abort\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c70b4283-8009-4607-af9f-66815a5f2e35", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "voice", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39abcdf1-364f-4a93-82a9-910dca843c4a", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "voice", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f930bed2-d56b-4958-9049-4df0b645db58", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "voice", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb677e60-d185-4759-abf3-579022e593e4", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "voice", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "720672ba-ba5d-48c1-bd3a-f8fabb4dc480", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "voice", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d6887c13-fc84-4f42-8ca4-7be2f18deac5", "name": "Resubmit", "request": { "name": "Resubmit", "description": { "content": "This endpoint allows you to retry sending a previously failed message.\n", "type": "text/plain" }, "url": { "path": [ "voice", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0475dfdf-4ab0-4263-9cae-9bc682fdfc15", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "voice", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ActionResult\": \"Success\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobNum\": \"10AB20CE\",\n \"Status\": \"Pending\",\n \"Action\": \"Resubmit\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a1bfc54-cd5d-45e9-a264-68e90bc5d4cb", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "voice", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c32370a-43fd-4eb5-b14a-6245992332bd", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "voice", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9229d1d6-5704-4bf1-a71c-b73a9d5affad", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "voice", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "259464a7-61ce-4161-a565-60ece79a8f58", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "voice", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4931b796-09ec-4fce-99fc-687b6be17336", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "voice", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "602023b9-356b-497c-84a7-7e838df59637", "name": "Number Of Operators", "request": { "name": "Number Of Operators", "description": { "content": "This endpoint allows you to adjust the `NumberOfOperators` configured for a pending message.\n", "type": "text/plain" }, "url": { "path": [ "voice", ":MessageID", "pacing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"NumberOfOperators\": 99999\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8548f361-c0a7-464e-b481-347a451504fc", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "voice", ":MessageID", "pacing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"NumberOfOperators\": 5\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ActionResult\": \"Success\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobNum\": \"10AB20CE\",\n \"Status\": \"Pending\",\n \"Action\": \"Pacing\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c288ec4-938d-4867-a949-aa4fe0872c98", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "voice", ":MessageID", "pacing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"NumberOfOperators\": 5\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f355f97-36f9-427f-8522-ebf2c3b4d7db", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "voice", ":MessageID", "pacing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"NumberOfOperators\": 5\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd788830-ef11-4c9c-a518-9f7a67ac51cc", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "voice", ":MessageID", "pacing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"NumberOfOperators\": 5\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25bbd402-4919-498c-8aea-45090d9d6d39", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "voice", ":MessageID", "pacing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"NumberOfOperators\": 5\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82027ebb-2cff-4e82-9adf-7eb4d826d948", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "voice", ":MessageID", "pacing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"NumberOfOperators\": 5\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "3c9cb90f-9f10-4513-8bf4-0068860cc2d4", "name": "Fax", "description": { "content": "Bridge the gap between digital and traditional documentation with our reliable Fax API. Send documents directly from your application to any fax machine worldwide without needing any physical hardware.\n\nYou can track the delivery status of each fax and receive detailed reports, ensuring your important documents arrive successfully.\n\n![Fax](https://www.tnz.co.nz/docs/restapi/assets/images/Fax[128x75].png)\n", "type": "text/plain" }, "item": [ { "id": "949331f4-3e1b-41dc-9cd3-9ed6288513b4", "name": "Send Fax", "request": { "name": "Send Fax", "description": { "content": "Send a Fax to one or more recipients.\n\nThe `MessageToPeople` parameter specifies the message to send. Alternatively, use `TemplateID` to send a pre-configured message template ([Find Your TemplateID](https://www.tnz.co.nz/help/how-to-find-your-templateid)).\n\nThe `Destination` parameter contains the email address to receive your message. Alternatively, you may use the `Destinations` array for multiple contacts, or use Address Book `ContactID` or `GroupID` values.\n", "type": "text/plain" }, "url": { "path": [ "fax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"Files\": [\n {\n \"Name\": \"\",\n \"Data\": \"\"\n },\n {\n \"Name\": \"\",\n \"Data\": \"\"\n }\n ],\n \"TemplateID\": \"\",\n \"Destination\": \"\",\n \"ToNumber\": \"\",\n \"Destinations\": [\n {\n \"ToNumber\": \"\",\n \"EmailAddress\": \"\",\n \"MainPhone\": \"\",\n \"Attention\": \"\",\n \"First Name\": \"\",\n \"Last Name\": \"\",\n \"Company\": \"\",\n \"Custom1\": \"\",\n \"Custom2\": \"\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"ContactID\": \"\",\n \"GroupID\": \"\",\n \"GroupCode\": \"\"\n },\n {\n \"ToNumber\": \"\",\n \"EmailAddress\": \"\",\n \"MainPhone\": \"\",\n \"Attention\": \"\",\n \"First Name\": \"\",\n \"Last Name\": \"\",\n \"Company\": \"\",\n \"Custom1\": \"\",\n \"Custom2\": \"\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"ContactID\": \"\",\n \"GroupID\": \"\",\n \"GroupCode\": \"\"\n }\n ],\n \"ContactID\": \"\",\n \"GroupID\": \"\",\n \"MessageID\": \"\",\n \"Reference\": \"\",\n \"NotificationType\": \"\",\n \"WebhookCallbackURL\": \"\",\n \"WebhookCallbackFormat\": \"\",\n \"ReportTo\": \"\",\n \"SendTime\": null,\n \"Timezone\": \"\",\n \"SubAccount\": \"\",\n \"Department\": \"\",\n \"CSID\": \"\",\n \"Resolution\": \"Low\",\n \"WatermarkFolder\": \"\",\n \"WatermarkFirstPage\": \"\",\n \"WatermarkAllPages\": \"\",\n \"RetryAttempts\": \"\",\n \"RetryPeriod\": \"\",\n \"Mode\": null\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c65d8a7e-2516-43c6-9342-1b888c90ea8a", "name": "OK [successful submission]", "originalRequest": { "url": { "path": [ "fax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Files\": [\n {\n \"Name\": \"My Example.pdf\",\n \"Data\": \"[base-64 data - see the field description for sample data]\"\n }\n ],\n \"Destination\": \"09 500 6000\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2ecbfe2-15a1-4dbc-92db-6fee571df2e5", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "fax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Files\": [\n {\n \"Name\": \"My Example.pdf\",\n \"Data\": \"[base-64 data - see the field description for sample data]\"\n }\n ],\n \"Destination\": \"09 500 6000\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa1dfc51-a464-4e12-a203-9cdf4e5de678", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "fax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Files\": [\n {\n \"Name\": \"My Example.pdf\",\n \"Data\": \"[base-64 data - see the field description for sample data]\"\n }\n ],\n \"Destination\": \"09 500 6000\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55c2225a-cd99-4fc1-96de-cb55edeb7bf3", "name": "Not Found [record not found]", "originalRequest": { "url": { "path": [ "fax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Files\": [\n {\n \"Name\": \"My Example.pdf\",\n \"Data\": \"[base-64 data - see the field description for sample data]\"\n }\n ],\n \"Destination\": \"09 500 6000\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"ErrorMessage\": [\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\",\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4405911-05db-466a-bef6-b03ee92eea97", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "fax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Files\": [\n {\n \"Name\": \"My Example.pdf\",\n \"Data\": \"[base-64 data - see the field description for sample data]\"\n }\n ],\n \"Destination\": \"09 500 6000\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40957a32-48a2-4cd0-9cdd-85215bbcba16", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "fax" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Files\": [\n {\n \"Name\": \"My Example.pdf\",\n \"Data\": \"[base-64 data - see the field description for sample data]\"\n }\n ],\n \"Destination\": \"09 500 6000\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5aa9fcbd-eb39-46b1-a536-1fa3421a60c9", "name": "Fax Details", "request": { "name": "Fax Details", "description": { "content": "Poll for details of a sent Fax message.\n\nThe primary object details the message as a whole, while the `Recipients` array contains details of each recipient.\n\n> [!TIP]\n> Timeout your polls after 6 hours with no result.\n\n> [!CAUTION]\n> Limit your polls to 1 per second to avoid rate limits.\n\n> [!note]\n> Consider the [Send Result Webhook](#tag/fax/webhook/POST/resultwebhook) for efficiency.\n", "type": "text/plain" }, "url": { "path": [ "fax", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "225090a8-86b7-4efa-84a2-1120da9e67a1", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "fax", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobStatus\": \"Pending\",\n \"JobNum\": \"10AB20CE\",\n \"Account\": \"101202\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"Reference\": \"MyTest\",\n \"CreatedTimeLocal\": \"2025-05-29 05:11:03\",\n \"CreatedTimeUTC\": \"2025-05-29 17:11:03\",\n \"CreatedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"DelayedTimeLocal\": \"2025-05-29 05:11:03\",\n \"DelayedTimeUTC\": \"2025-05-29 17:11:03\",\n \"DelayedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"Timezone\": \"New Zealand\",\n \"Count\": 1,\n \"Complete\": 1,\n \"Success\": 1,\n \"Failed\": 0,\n \"Price\": \"eiusmo\",\n \"TotalRecords\": 1,\n \"RecordsPerPage\": 20,\n \"PageCount\": 1,\n \"Page\": 1,\n \"Recipients\": [\n {\n \"Type\": \"Fax\",\n \"DestSeq\": {\n \"value\": \"\"\n },\n \"Destination\": \"+6495006000\",\n \"ContactID\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n },\n \"Result\": \"Sent OK\",\n \"SentTimeLocal\": {\n \"value\": \"\"\n },\n \"SentTimeUTC\": {\n \"value\": \"\"\n },\n \"SentTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Attention\": {\n \"value\": \"\"\n },\n \"Company\": {\n \"value\": \"\"\n },\n \"Custom1\": {\n \"value\": \"\"\n },\n \"Custom2\": {\n \"value\": \"\"\n },\n \"Custom3\": {\n \"value\": \"\"\n },\n \"Custom4\": {\n \"value\": \"\"\n },\n \"Custom5\": {\n \"value\": \"\"\n },\n \"Custom6\": {\n \"value\": \"\"\n },\n \"Custom7\": {\n \"value\": \"\"\n },\n \"Custom8\": {\n \"value\": \"\"\n },\n \"Custom9\": {\n \"value\": \"\"\n },\n \"RemoteID\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n }\n },\n {\n \"Type\": \"Fax\",\n \"DestSeq\": {\n \"value\": \"\"\n },\n \"Destination\": \"+6495006000\",\n \"ContactID\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n },\n \"Result\": \"Sent OK\",\n \"SentTimeLocal\": {\n \"value\": \"\"\n },\n \"SentTimeUTC\": {\n \"value\": \"\"\n },\n \"SentTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Attention\": {\n \"value\": \"\"\n },\n \"Company\": {\n \"value\": \"\"\n },\n \"Custom1\": {\n \"value\": \"\"\n },\n \"Custom2\": {\n \"value\": \"\"\n },\n \"Custom3\": {\n \"value\": \"\"\n },\n \"Custom4\": {\n \"value\": \"\"\n },\n \"Custom5\": {\n \"value\": \"\"\n },\n \"Custom6\": {\n \"value\": \"\"\n },\n \"Custom7\": {\n \"value\": \"\"\n },\n \"Custom8\": {\n \"value\": \"\"\n },\n \"Custom9\": {\n \"value\": \"\"\n },\n \"RemoteID\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4e06765-08ee-4273-9c98-a88730ef2fc0", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "fax", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1762095b-7760-4af5-adfe-fd1c2ac6817b", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "fax", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61777e50-bbc7-4b99-ad19-ad836791e428", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "fax", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56178571-a688-4bfb-8313-1b66cbb4ea71", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "fax", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e352591a-b085-4e6b-90e9-983a24de596d", "name": "Reschedule", "request": { "name": "Reschedule", "description": { "content": "This endpoint allows you to reschedule a previously delayed message to be sent at a new time.\n", "type": "text/plain" }, "url": { "path": [ "fax", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "91c9249c-252f-4f5a-8456-fee411575bfd", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "fax", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ActionResult\": \"Success\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobNum\": \"10AB20CE\",\n \"Status\": \"Pending\",\n \"Action\": \"Reschedule\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3ad1d7d-2fa4-4c44-9140-bb70e490824c", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "fax", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8617ea48-de36-45fa-b537-8eda4e14a378", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "fax", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a1bd6b6-9ba2-493f-8317-4805e917ad6b", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "fax", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4ead630-5054-403c-8d9d-4f80b0367191", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "fax", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94ae54b5-2979-4468-a47e-dd8778dddb5b", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "fax", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bd9d961f-8948-4018-96b0-6376ddc490b8", "name": "Abort", "request": { "name": "Abort", "description": { "content": "This endpoint allows you to abort a previously delayed message.\n", "type": "text/plain" }, "url": { "path": [ "fax", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1c60bc94-95ef-4732-a7c2-39bcae14f003", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "fax", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ActionResult\": \"Success\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobNum\": \"10AB20CE\",\n \"Status\": \"Pending\",\n \"Action\": \"Abort\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c75e0c5f-66cc-4bac-ad0c-e85d93ba4851", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "fax", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc759e96-26bd-4428-b7ef-7b8211470b4f", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "fax", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4eac90f-5b50-4b9e-88f8-3581eabde216", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "fax", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d45be9e-aaf3-4dba-b6a5-a41450209b3c", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "fax", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bf774a8-a64b-4ee4-8c68-4a04b303def1", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "fax", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a31c9919-f1d0-4415-bf48-1399660dbf39", "name": "Resubmit", "request": { "name": "Resubmit", "description": { "content": "This endpoint allows you to retry sending a previously failed message.\n", "type": "text/plain" }, "url": { "path": [ "fax", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "dba8f0ae-1bc3-4274-a1bb-3f416f864452", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "fax", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ActionResult\": \"Success\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobNum\": \"10AB20CE\",\n \"Status\": \"Pending\",\n \"Action\": \"Resubmit\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64dcd25e-6060-45a6-b3ea-ea22f5974fce", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "fax", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a0650dc-2035-4777-9ad8-e8baa0ac2c8c", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "fax", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77ff632e-f2dc-4419-81d8-37862f458d2d", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "fax", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce22f985-5c69-47fe-9f07-f2939c3f6d3a", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "fax", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54ad3b81-192f-41d2-ad24-973c0dcb1a1e", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "fax", ":MessageID", "resubmit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c21fca95-ea42-47a2-997a-a237fcf83302", "name": "WhatsApp", "description": { "content": "Leverage the power of WhatsApp and send messages to WhatsApp users worldwide.\n\nOur WhatsApp API allows you to send text, files, templates and receive responses on the world's most popular messaging platform.\n\n![WhatsApp](https://www.tnz.co.nz/docs/restapi/assets/images/WhatsApp[128x75].png)\n", "type": "text/plain" }, "item": [ { "id": "092c43b9-90ef-47fb-ae46-d67b414ce558", "name": "Send WhatsApp Message", "request": { "name": "Send WhatsApp Message", "description": { "content": "Send a WhatsApp message to one or more recipients.\n\nWhatsApp requires the use of a template to initiate contact with users. If the user responds within 24 hours, you may send freeform messages until the 24-hour window closes.\n\nEach API request must include a `TemplateID` and `Message`. The API will dynamically handle the message selection.\n", "type": "text/plain" }, "url": { "path": [ "whatsapp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"TemplateID\": \"\",\n \"Message\": \"\",\n \"FromNumber\": \"\",\n \"FallbackMode\": \"None\",\n \"Files\": [\n {\n \"Name\": \"\",\n \"Data\": \"\"\n },\n {\n \"Name\": \"\",\n \"Data\": \"\"\n }\n ],\n \"Destination\": \"\",\n \"ToNumber\": \"\",\n \"Destinations\": [\n {\n \"ToNumber\": \"\",\n \"EmailAddress\": \"\",\n \"MainPhone\": \"\",\n \"Attention\": \"\",\n \"First Name\": \"\",\n \"Last Name\": \"\",\n \"Company\": \"\",\n \"Custom1\": \"\",\n \"Custom2\": \"\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"ContactID\": \"\",\n \"GroupID\": \"\",\n \"GroupCode\": \"\"\n },\n {\n \"ToNumber\": \"\",\n \"EmailAddress\": \"\",\n \"MainPhone\": \"\",\n \"Attention\": \"\",\n \"First Name\": \"\",\n \"Last Name\": \"\",\n \"Company\": \"\",\n \"Custom1\": \"\",\n \"Custom2\": \"\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"ContactID\": \"\",\n \"GroupID\": \"\",\n \"GroupCode\": \"\"\n }\n ],\n \"ContactID\": \"\",\n \"GroupID\": \"\",\n \"MessageID\": \"\",\n \"Reference\": \"\",\n \"NotificationType\": \"\",\n \"WebhookCallbackURL\": \"\",\n \"WebhookCallbackFormat\": \"\",\n \"SendTime\": null,\n \"Timezone\": \"\",\n \"SubAccount\": \"\",\n \"Department\": \"\",\n \"Mode\": null\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f0fa9aed-a1e7-47f8-9920-c2c2dbf4bca1", "name": "OK [successful submission]", "originalRequest": { "url": { "path": [ "whatsapp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"TemplateID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"Message\": \"Hello [[Custom1]], this is a notification from [[Custom2]]. Your [[Custom3]] plan is due for renewal on [[Custom4]]. Reply STOP to OptOut.\",\n \"FallbackMode\": \"SMS\",\n \"FromNumber\": \"+6495006000\",\n \"Destinations\": [\n {\n \"ToNumber\": \"+6421000001\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Company\": \"Company One Ltd.\",\n \"Custom1\": \"John\",\n \"Custom2\": \"Company One Ltd\",\n \"Custom3\": \"Premium\",\n \"Custom4\": \"2026-12-31\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09204b10-f7fc-4549-a55d-2b39da87e74f", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "whatsapp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"TemplateID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"Message\": \"Hello [[Custom1]], this is a notification from [[Custom2]]. Your [[Custom3]] plan is due for renewal on [[Custom4]]. Reply STOP to OptOut.\",\n \"FallbackMode\": \"SMS\",\n \"FromNumber\": \"+6495006000\",\n \"Destinations\": [\n {\n \"ToNumber\": \"+6421000001\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Company\": \"Company One Ltd.\",\n \"Custom1\": \"John\",\n \"Custom2\": \"Company One Ltd\",\n \"Custom3\": \"Premium\",\n \"Custom4\": \"2026-12-31\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b16a57f6-cd29-43d8-80f6-348d2024cd26", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "whatsapp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"TemplateID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"Message\": \"Hello [[Custom1]], this is a notification from [[Custom2]]. Your [[Custom3]] plan is due for renewal on [[Custom4]]. Reply STOP to OptOut.\",\n \"FallbackMode\": \"SMS\",\n \"FromNumber\": \"+6495006000\",\n \"Destinations\": [\n {\n \"ToNumber\": \"+6421000001\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Company\": \"Company One Ltd.\",\n \"Custom1\": \"John\",\n \"Custom2\": \"Company One Ltd\",\n \"Custom3\": \"Premium\",\n \"Custom4\": \"2026-12-31\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e8220ee-dc21-4011-a2f3-e7b08bafe706", "name": "Not Found [record not found]", "originalRequest": { "url": { "path": [ "whatsapp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"TemplateID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"Message\": \"Hello [[Custom1]], this is a notification from [[Custom2]]. Your [[Custom3]] plan is due for renewal on [[Custom4]]. Reply STOP to OptOut.\",\n \"FallbackMode\": \"SMS\",\n \"FromNumber\": \"+6495006000\",\n \"Destinations\": [\n {\n \"ToNumber\": \"+6421000001\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Company\": \"Company One Ltd.\",\n \"Custom1\": \"John\",\n \"Custom2\": \"Company One Ltd\",\n \"Custom3\": \"Premium\",\n \"Custom4\": \"2026-12-31\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"ErrorMessage\": [\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\",\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b3f4f94-791e-4626-8dd6-f546ca678108", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "whatsapp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"TemplateID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"Message\": \"Hello [[Custom1]], this is a notification from [[Custom2]]. Your [[Custom3]] plan is due for renewal on [[Custom4]]. Reply STOP to OptOut.\",\n \"FallbackMode\": \"SMS\",\n \"FromNumber\": \"+6495006000\",\n \"Destinations\": [\n {\n \"ToNumber\": \"+6421000001\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Company\": \"Company One Ltd.\",\n \"Custom1\": \"John\",\n \"Custom2\": \"Company One Ltd\",\n \"Custom3\": \"Premium\",\n \"Custom4\": \"2026-12-31\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfe32df1-03e6-4dcc-9ff1-78c7a2b310e5", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "whatsapp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"TemplateID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"Message\": \"Hello [[Custom1]], this is a notification from [[Custom2]]. Your [[Custom3]] plan is due for renewal on [[Custom4]]. Reply STOP to OptOut.\",\n \"FallbackMode\": \"SMS\",\n \"FromNumber\": \"+6495006000\",\n \"Destinations\": [\n {\n \"ToNumber\": \"+6421000001\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Company\": \"Company One Ltd.\",\n \"Custom1\": \"John\",\n \"Custom2\": \"Company One Ltd\",\n \"Custom3\": \"Premium\",\n \"Custom4\": \"2026-12-31\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "926c66f4-f85e-4b04-8fd7-579c5f5c63d2", "name": "WhatsApp Details", "request": { "name": "WhatsApp Details", "description": { "content": "Poll for details of a sent WhatsApp message.\n\nThe primary object details the message as a whole, while the `Recipients` array contains details of each recipient.\n\nUnder each recipient, an `SMSReplies` array will detail any received replies.\n\n> [!TIP]\n> Timeout your polls after 6 hours with no result.\n\n> [!CAUTION]\n> Limit your polls to 1 per second to avoid rate limits.\n\n> [!note]\n> Consider the [Send Result Webhook](#tag/sms/webhook/POST/resultwebhook) for efficiency.\n", "type": "text/plain" }, "url": { "path": [ "whatsapp", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ad7f1060-558b-4bdd-9463-7892c4c3643c", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "whatsapp", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobStatus\": \"Pending\",\n \"JobNum\": \"10AB20CE\",\n \"Account\": \"101202\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"Reference\": \"MyTest\",\n \"CreatedTimeLocal\": \"2025-05-29 05:11:03\",\n \"CreatedTimeUTC\": \"2025-05-29 17:11:03\",\n \"CreatedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"DelayedTimeLocal\": \"2025-05-29 05:11:03\",\n \"DelayedTimeUTC\": \"2025-05-29 17:11:03\",\n \"DelayedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"Timezone\": \"New Zealand\",\n \"Count\": 1,\n \"Complete\": 1,\n \"Success\": 1,\n \"Failed\": 0,\n \"Price\": \"m\",\n \"TotalRecords\": 1,\n \"RecordsPerPage\": 20,\n \"PageCount\": 1,\n \"Page\": 1,\n \"Recipients\": [\n {\n \"Type\": \"WhatsApp\",\n \"DestSeq\": {\n \"value\": \"\"\n },\n \"Destination\": \"+64212223333\",\n \"ContactID\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n },\n \"Result\": \"Delivered\",\n \"SentTimeLocal\": {\n \"value\": \"\"\n },\n \"SentTimeUTC\": {\n \"value\": \"\"\n },\n \"SentTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Attention\": {\n \"value\": \"\"\n },\n \"Company\": {\n \"value\": \"\"\n },\n \"Custom1\": {\n \"value\": \"\"\n },\n \"Custom2\": {\n \"value\": \"\"\n },\n \"Custom3\": {\n \"value\": \"\"\n },\n \"Custom4\": {\n \"value\": \"\"\n },\n \"Custom5\": {\n \"value\": \"\"\n },\n \"Custom6\": {\n \"value\": \"\"\n },\n \"Custom7\": {\n \"value\": \"\"\n },\n \"Custom8\": {\n \"value\": \"\"\n },\n \"Custom9\": {\n \"value\": \"\"\n },\n \"RemoteID\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"SMSReplies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"Type\": \"WhatsApp\",\n \"DestSeq\": {\n \"value\": \"\"\n },\n \"Destination\": \"+64212223333\",\n \"ContactID\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n },\n \"Result\": \"Delivered\",\n \"SentTimeLocal\": {\n \"value\": \"\"\n },\n \"SentTimeUTC\": {\n \"value\": \"\"\n },\n \"SentTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Attention\": {\n \"value\": \"\"\n },\n \"Company\": {\n \"value\": \"\"\n },\n \"Custom1\": {\n \"value\": \"\"\n },\n \"Custom2\": {\n \"value\": \"\"\n },\n \"Custom3\": {\n \"value\": \"\"\n },\n \"Custom4\": {\n \"value\": \"\"\n },\n \"Custom5\": {\n \"value\": \"\"\n },\n \"Custom6\": {\n \"value\": \"\"\n },\n \"Custom7\": {\n \"value\": \"\"\n },\n \"Custom8\": {\n \"value\": \"\"\n },\n \"Custom9\": {\n \"value\": \"\"\n },\n \"RemoteID\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"SMSReplies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ee57dad-13b0-4974-b046-cfeb241cb8ad", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "whatsapp", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81fbb256-ccbc-4237-8799-42542bce0e33", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "whatsapp", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb934393-2369-47da-9c5c-52bc648573ca", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "whatsapp", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e290aac3-5077-460d-82e4-3c49e85550a0", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "whatsapp", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "569d62b7-8fde-4313-80b9-f336746a548b", "name": "Inbound Messages", "request": { "name": "Inbound Messages", "description": { "content": "Poll for a list of text messages received in a given timeframe. This endpoint applies to SMS, WhatsApp and RCS messages.\n\nYou may search based on `timePeriod` (return results from the last _x_ minutes) or by `dateFrom` to `dateTo` (return results within the specified timeframe).\n\nIf a received message can be matched as a reply, the `MessageID` parameter will contain the outbound message's `MessageID`.\n\n> [!CAUTION]\n> Limit your polls to 1 per second to avoid rate limits.\n\n> [!note]\n> Consider the [Inbound SMS Webhook](#tag/sms/webhook/POST/inboundsmswebhook) for efficiency.\n", "type": "text/plain" }, "url": { "path": [ "whatsapp", "received" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "timePeriod", "value": "", "description": "(Required) Return results from the last _x_ minutes (e.g. last 5 minutes)." }, { "disabled": false, "key": "dateFrom", "value": "", "description": "Return results from the specified date in the API User's local time. Maximum 7 days." }, { "disabled": false, "key": "dateTo", "value": "", "description": "Return results to the specified date in the API User's local time. Maximum 7 days." }, { "disabled": false, "key": "recordsPerPage", "value": "", "description": "Number of records to return per page." }, { "disabled": false, "key": "page", "value": "1", "description": "Page number to retrieve." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a75cba13-3503-4107-832c-19cc06fc4bd0", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "whatsapp", "received" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "timePeriod", "value": "10" }, { "key": "dateFrom", "value": "2025-08-01T00:00:00" }, { "key": "dateTo", "value": "2025-08-01T12:00:00" }, { "key": "recordsPerPage", "value": "20" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"TotalRecords\": 1,\n \"RecordsPerPage\": 20,\n \"PageCount\": 1,\n \"Page\": 1,\n \"Messages\": [\n {\n \"ReceivedID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"MessageID\": \"7000000a-f002-4007-b00a-d00000000002\",\n \"JobNum\": \"10AB20CE\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"ReceivedTimeLocal\": \"2025-09-01 14:02:03\",\n \"ReceivedTimeUTC\": \"2025-09-01 02:02:03\",\n \"ReceivedTimeUTC_RFC3339\": \"2025-09-01T02:02:03.000Z\",\n \"From\": \"+6421000001\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"MessageText\": \"This is a received message from a mobile phone.\",\n \"Timezone\": \"New Zealand\",\n \"Version\": \"v3.00\"\n },\n {\n \"ReceivedID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"MessageID\": \"7000000a-f002-4007-b00a-d00000000002\",\n \"JobNum\": \"10AB20CE\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"ReceivedTimeLocal\": \"2025-09-01 14:02:03\",\n \"ReceivedTimeUTC\": \"2025-09-01 02:02:03\",\n \"ReceivedTimeUTC_RFC3339\": \"2025-09-01T02:02:03.000Z\",\n \"From\": \"+6421000001\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"MessageText\": \"This is a received message from a mobile phone.\",\n \"Timezone\": \"New Zealand\",\n \"Version\": \"v3.00\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ad1f903-8af7-43d3-baaa-e33bfb56fdc1", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "whatsapp", "received" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "timePeriod", "value": "10" }, { "key": "dateFrom", "value": "2025-08-01T00:00:00" }, { "key": "dateTo", "value": "2025-08-01T12:00:00" }, { "key": "recordsPerPage", "value": "20" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c79caab-634a-422f-bc3f-9b4eb1e6612f", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "whatsapp", "received" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "timePeriod", "value": "10" }, { "key": "dateFrom", "value": "2025-08-01T00:00:00" }, { "key": "dateTo", "value": "2025-08-01T12:00:00" }, { "key": "recordsPerPage", "value": "20" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "297d701e-87de-4022-869e-4c7707c59874", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "whatsapp", "received" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "timePeriod", "value": "10" }, { "key": "dateFrom", "value": "2025-08-01T00:00:00" }, { "key": "dateTo", "value": "2025-08-01T12:00:00" }, { "key": "recordsPerPage", "value": "20" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2df9c36f-34c7-41e6-a801-bd3477b2d1fc", "name": "Reschedule", "request": { "name": "Reschedule", "description": { "content": "This endpoint allows you to reschedule a previously delayed message to be sent at a new time.\n", "type": "text/plain" }, "url": { "path": [ "whatsapp", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e8a3f422-1682-414c-88d7-88e30254fa7a", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "whatsapp", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ActionResult\": \"Success\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobNum\": \"10AB20CE\",\n \"Status\": \"Pending\",\n \"Action\": \"Reschedule\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69a527b8-126a-4f5d-81f5-32076d596a19", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "whatsapp", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a1b6941-181b-4b78-bf56-c1d81e945c8d", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "whatsapp", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d1153ed-1acb-4b24-ac37-b790f1d0a625", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "whatsapp", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25492824-a5c8-40f1-bc09-5241d9889de9", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "whatsapp", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "001680fd-7522-434f-b2f2-aa8882d9b38e", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "whatsapp", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "03bcc986-9987-491b-9736-291b7a9a7513", "name": "Abort", "request": { "name": "Abort", "description": { "content": "This endpoint allows you to abort a previously delayed message.\n", "type": "text/plain" }, "url": { "path": [ "whatsapp", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c6b12fcb-9f72-4217-8fb7-2ff87d8e206b", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "whatsapp", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ActionResult\": \"Success\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobNum\": \"10AB20CE\",\n \"Status\": \"Pending\",\n \"Action\": \"Abort\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a967958-9cac-4138-a26b-feaf43629aa4", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "whatsapp", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e597798a-e884-4a9d-810c-968800af0d66", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "whatsapp", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e2dd3c2-cf9a-4700-a28b-e4c1d0238f49", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "whatsapp", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "419fe1b0-3792-4083-a4af-19712a585aac", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "whatsapp", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59f8d7dc-478e-4e8d-9062-b743f2a1a07a", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "whatsapp", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "1f13fb61-0a7f-4f48-b9b9-a55dfcab5bd5", "name": "RCS", "description": { "content": "Boost your text messages using Rich Communication Services (RCS).\n\nOur RCS API enables you to send media-rich messages that go beyond traditional SMS, providing a more engaging experience for your audience. RCS is unsupported in New Zealand and Australia.\n\n![RCS](https://www.tnz.co.nz/docs/restapi/assets/images/RCS[128x75].png)\n", "type": "text/plain" }, "item": [ { "id": "705b8839-6c6a-4b4c-bc6b-4bc3c21d000f", "name": "Send RCS Message", "request": { "name": "Send RCS Message", "description": { "content": "Send an RCS message to one or more recipients.\n", "type": "text/plain" }, "url": { "path": [ "rcs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"Message\": \"\",\n \"TemplateID\": \"\",\n \"Destination\": \"\",\n \"ToNumber\": \"\",\n \"Destinations\": [\n {\n \"ToNumber\": \"\",\n \"EmailAddress\": \"\",\n \"MainPhone\": \"\",\n \"Attention\": \"\",\n \"First Name\": \"\",\n \"Last Name\": \"\",\n \"Company\": \"\",\n \"Custom1\": \"\",\n \"Custom2\": \"\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"ContactID\": \"\",\n \"GroupID\": \"\",\n \"GroupCode\": \"\"\n },\n {\n \"ToNumber\": \"\",\n \"EmailAddress\": \"\",\n \"MainPhone\": \"\",\n \"Attention\": \"\",\n \"First Name\": \"\",\n \"Last Name\": \"\",\n \"Company\": \"\",\n \"Custom1\": \"\",\n \"Custom2\": \"\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"ContactID\": \"\",\n \"GroupID\": \"\",\n \"GroupCode\": \"\"\n }\n ],\n \"ContactID\": \"\",\n \"GroupID\": \"\",\n \"MessageID\": \"\",\n \"Reference\": \"\",\n \"NotificationType\": \"\",\n \"WebhookCallbackURL\": \"\",\n \"WebhookCallbackFormat\": \"\",\n \"SendTime\": null,\n \"Timezone\": \"\",\n \"SubAccount\": \"\",\n \"Department\": \"\",\n \"FromNumber\": \"\",\n \"SMSEmailReply\": \"\",\n \"Files\": [\n {\n \"Name\": \"\",\n \"Data\": \"\"\n },\n {\n \"Name\": \"\",\n \"Data\": \"\"\n }\n ],\n \"FallbackMode\": \"None\",\n \"Mode\": null\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6abafa0b-9ee0-49d8-860a-baf0628df148", "name": "OK [successful submission]", "originalRequest": { "url": { "path": [ "rcs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Message\": \"Hello, this is an RCS notification from Company One Ltd. Reply STOP to OptOut.\",\n \"Destination\": \"021-000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68034837-a4ac-4349-843c-fb5bac80e4f5", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "rcs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Message\": \"Hello, this is an RCS notification from Company One Ltd. Reply STOP to OptOut.\",\n \"Destination\": \"021-000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1961527e-08c8-4403-a883-f85150c33ad1", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "rcs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Message\": \"Hello, this is an RCS notification from Company One Ltd. Reply STOP to OptOut.\",\n \"Destination\": \"021-000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7228182a-e97f-413b-90c6-32e0ea348ab3", "name": "Not Found [record not found]", "originalRequest": { "url": { "path": [ "rcs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Message\": \"Hello, this is an RCS notification from Company One Ltd. Reply STOP to OptOut.\",\n \"Destination\": \"021-000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"ErrorMessage\": [\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\",\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "582e3ca4-f84d-4317-ba33-37a4b8456de9", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "rcs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Message\": \"Hello, this is an RCS notification from Company One Ltd. Reply STOP to OptOut.\",\n \"Destination\": \"021-000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96896da4-0100-42be-8a72-eb1ce0a72643", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "rcs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Message\": \"Hello, this is an RCS notification from Company One Ltd. Reply STOP to OptOut.\",\n \"Destination\": \"021-000001\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4ece9b0a-568a-490d-9330-540f63fe28b9", "name": "RCS Details", "request": { "name": "RCS Details", "description": { "content": "Poll for details of a sent RCS message.\n\nThe primary object details the message as a whole, while the `Recipients` array contains details of each recipient.\n\nUnder each recipient, an `SMSReplies` array will detail any received replies.\n\n> [!TIP]\n> Timeout your polls after 6 hours with no result.\n\n> [!CAUTION]\n> Limit your polls to 1 per second to avoid rate limits.\n\n> [!note]\n> Consider the [Send Result Webhook](#tag/sms/webhook/POST/resultwebhook) for efficiency.\n", "type": "text/plain" }, "url": { "path": [ "rcs", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d9e9d1dd-e4e4-4858-986a-90c9bd97f68e", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "rcs", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobStatus\": \"Pending\",\n \"JobNum\": \"10AB20CE\",\n \"Account\": \"101202\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"Reference\": \"MyTest\",\n \"CreatedTimeLocal\": \"2025-05-29 05:11:03\",\n \"CreatedTimeUTC\": \"2025-05-29 17:11:03\",\n \"CreatedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"DelayedTimeLocal\": \"2025-05-29 05:11:03\",\n \"DelayedTimeUTC\": \"2025-05-29 17:11:03\",\n \"DelayedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"Timezone\": \"New Zealand\",\n \"Count\": 1,\n \"Complete\": 1,\n \"Success\": 1,\n \"Failed\": 0,\n \"Price\": \"amet et\",\n \"TotalRecords\": 1,\n \"RecordsPerPage\": 20,\n \"PageCount\": 1,\n \"Page\": 1,\n \"Recipients\": [\n {\n \"Type\": \"RCS\",\n \"DestSeq\": {\n \"value\": \"\"\n },\n \"Destination\": \"+64212223333\",\n \"ContactID\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n },\n \"Result\": \"Delivered\",\n \"SentTimeLocal\": {\n \"value\": \"\"\n },\n \"SentTimeUTC\": {\n \"value\": \"\"\n },\n \"SentTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Attention\": {\n \"value\": \"\"\n },\n \"Company\": {\n \"value\": \"\"\n },\n \"Custom1\": {\n \"value\": \"\"\n },\n \"Custom2\": {\n \"value\": \"\"\n },\n \"Custom3\": {\n \"value\": \"\"\n },\n \"Custom4\": {\n \"value\": \"\"\n },\n \"Custom5\": {\n \"value\": \"\"\n },\n \"Custom6\": {\n \"value\": \"\"\n },\n \"Custom7\": {\n \"value\": \"\"\n },\n \"Custom8\": {\n \"value\": \"\"\n },\n \"Custom9\": {\n \"value\": \"\"\n },\n \"RemoteID\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"SMSReplies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"Type\": \"RCS\",\n \"DestSeq\": {\n \"value\": \"\"\n },\n \"Destination\": \"+64212223333\",\n \"ContactID\": {\n \"value\": \"\"\n },\n \"Status\": {\n \"value\": \"\"\n },\n \"Result\": \"Delivered\",\n \"SentTimeLocal\": {\n \"value\": \"\"\n },\n \"SentTimeUTC\": {\n \"value\": \"\"\n },\n \"SentTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Attention\": {\n \"value\": \"\"\n },\n \"Company\": {\n \"value\": \"\"\n },\n \"Custom1\": {\n \"value\": \"\"\n },\n \"Custom2\": {\n \"value\": \"\"\n },\n \"Custom3\": {\n \"value\": \"\"\n },\n \"Custom4\": {\n \"value\": \"\"\n },\n \"Custom5\": {\n \"value\": \"\"\n },\n \"Custom6\": {\n \"value\": \"\"\n },\n \"Custom7\": {\n \"value\": \"\"\n },\n \"Custom8\": {\n \"value\": \"\"\n },\n \"Custom9\": {\n \"value\": \"\"\n },\n \"RemoteID\": {\n \"value\": \"\"\n },\n \"Price\": {\n \"value\": \"\"\n },\n \"SMSReplies\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e49026df-46a6-4caf-8796-f34c35321c96", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "rcs", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14857228-ac39-4c68-bf17-ef8ddc47bce8", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "rcs", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2796ac8a-3a30-4aff-a13b-60582e12dc01", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "rcs", ":MessageID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f6b68ffc-88b0-4304-9fc4-d0646d4d1af5", "name": "Inbound Messages", "request": { "name": "Inbound Messages", "description": { "content": "Poll for a list of text messages received in a given timeframe. This endpoint applies to SMS, WhatsApp and RCS messages.\n\nYou may search based on `timePeriod` (return results from the last _x_ minutes) or by `dateFrom` to `dateTo` (return results within the specified timeframe).\n\nIf a received message can be matched as a reply, the `MessageID` parameter will contain the outbound message's `MessageID`.\n\n> [!CAUTION]\n> Limit your polls to 1 per second to avoid rate limits.\n\n> [!note]\n> Consider the [Inbound SMS Webhook](#tag/sms/webhook/POST/inboundsmswebhook) for efficiency.\n", "type": "text/plain" }, "url": { "path": [ "rcs", "received" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "timePeriod", "value": "", "description": "(Required) Return results from the last _x_ minutes (e.g. last 5 minutes)." }, { "disabled": false, "key": "dateFrom", "value": "", "description": "Return results from the specified date in the API User's local time. Maximum 7 days." }, { "disabled": false, "key": "dateTo", "value": "", "description": "Return results to the specified date in the API User's local time. Maximum 7 days." }, { "disabled": false, "key": "recordsPerPage", "value": "", "description": "Number of records to return per page." }, { "disabled": false, "key": "page", "value": "1", "description": "Page number to retrieve." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "aff482cf-bb08-413a-bf97-bced5c522360", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "rcs", "received" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "timePeriod", "value": "10" }, { "key": "dateFrom", "value": "2025-08-01T00:00:00" }, { "key": "dateTo", "value": "2025-08-01T12:00:00" }, { "key": "recordsPerPage", "value": "20" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"TotalRecords\": 1,\n \"RecordsPerPage\": 20,\n \"PageCount\": 1,\n \"Page\": 1,\n \"Messages\": [\n {\n \"ReceivedID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"MessageID\": \"7000000a-f002-4007-b00a-d00000000002\",\n \"JobNum\": \"10AB20CE\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"ReceivedTimeLocal\": \"2025-09-01 14:02:03\",\n \"ReceivedTimeUTC\": \"2025-09-01 02:02:03\",\n \"ReceivedTimeUTC_RFC3339\": \"2025-09-01T02:02:03.000Z\",\n \"From\": \"+6421000001\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"MessageText\": \"This is a received message from a mobile phone.\",\n \"Timezone\": \"New Zealand\",\n \"Version\": \"v3.00\"\n },\n {\n \"ReceivedID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"MessageID\": \"7000000a-f002-4007-b00a-d00000000002\",\n \"JobNum\": \"10AB20CE\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"ReceivedTimeLocal\": \"2025-09-01 14:02:03\",\n \"ReceivedTimeUTC\": \"2025-09-01 02:02:03\",\n \"ReceivedTimeUTC_RFC3339\": \"2025-09-01T02:02:03.000Z\",\n \"From\": \"+6421000001\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"MessageText\": \"This is a received message from a mobile phone.\",\n \"Timezone\": \"New Zealand\",\n \"Version\": \"v3.00\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc5f5cf3-a0f8-4ec5-be49-70274a6344b3", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "rcs", "received" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "timePeriod", "value": "10" }, { "key": "dateFrom", "value": "2025-08-01T00:00:00" }, { "key": "dateTo", "value": "2025-08-01T12:00:00" }, { "key": "recordsPerPage", "value": "20" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "527eb9f7-9265-4145-8a67-334ce49e1fb7", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "rcs", "received" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "timePeriod", "value": "10" }, { "key": "dateFrom", "value": "2025-08-01T00:00:00" }, { "key": "dateTo", "value": "2025-08-01T12:00:00" }, { "key": "recordsPerPage", "value": "20" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3c2beadb-69eb-44e1-98bb-c4b4a382f6c7", "name": "Reschedule", "request": { "name": "Reschedule", "description": { "content": "This endpoint allows you to reschedule a previously delayed message to be sent at a new time.\n", "type": "text/plain" }, "url": { "path": [ "rcs", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ce95411c-fd16-4738-b7f9-0af591b62e07", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "rcs", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ActionResult\": \"Success\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobNum\": \"10AB20CE\",\n \"Status\": \"Pending\",\n \"Action\": \"Reschedule\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89777246-f428-45d9-8047-4b7813c5237a", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "rcs", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74d4606e-c82e-4ac1-9f96-bc81adfdeb3c", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "rcs", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "222950b6-87ec-4c14-b30e-99459b0c49e9", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "rcs", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "984ccc40-c704-4b9c-b558-bbac7eceabae", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "rcs", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9fceb43-4301-4180-8aac-4b5e5e5c0640", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "rcs", ":MessageID", "reschedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"SendTime\": \"2025-08-12T12:00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "44ad38a3-c8ea-4f8e-87a3-3a1fc28bdc73", "name": "Abort", "request": { "name": "Abort", "description": { "content": "This endpoint allows you to abort a previously delayed message.\n", "type": "text/plain" }, "url": { "path": [ "rcs", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ed70c423-ea94-446d-9dc2-7d557e0fdd94", "name": "OK [message found]", "originalRequest": { "url": { "path": [ "rcs", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ActionResult\": \"Success\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"JobNum\": \"10AB20CE\",\n \"Status\": \"Pending\",\n \"Action\": \"Abort\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea6543ed-7bbe-4473-8a89-dcaac94f58a6", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "rcs", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1de9d97-6781-44f0-91f5-af5dc7726c33", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "rcs", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19e1554c-0706-46a2-ac46-610875ff70b3", "name": "Not Found [id is incorrect or still processing]", "originalRequest": { "url": { "path": [ "rcs", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"MessageID\": \"1000000a-f002-4007-b00a-d00000000002\",\n \"ErrorMessage\": [\n \"Unable to find entry.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bb221e0-5b2f-40a6-b1fe-8681245fa3dd", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "rcs", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "236597dc-d70a-4d25-8c8b-db8716607cc0", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "rcs", ":MessageID", "abort" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "MessageID", "description": "(Required) The MessageID the API call is targeting. If you use common MessageID values across multiple calls, it will apply to the most recent message submitted." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "dd6612d3-140a-4401-8ff5-32d65733c1b5", "name": "Webhooks", "description": { "content": "Get real-time updates without the need for constant polling. Our webhooks can notify your application instantly when a message completes sending or when you receive an inbound SMS. This efficient, event-driven approach ensures your system stays up-to-date with delivery receipts and customer replies, saving you resources and providing faster insights.\n\n![Webhooks](https://www.tnz.co.nz/docs/restapi/assets/images/Developers[128x75].png)\n", "type": "text/plain" }, "item": [], "event": [] }, { "id": "f97fdb07-adef-4c5c-b6d2-13b96618b71c", "name": "Address Book", "description": { "content": "Centralise your Contacts using the Address Book API, your single source of truth.\n\nThis simplifies your integration and unlocks powerful, data-rich personalisation across all messaging channels.\n\n> [!CAUTION]\n> To use this function, your API user must have the Address Book API enabled:\n> `Dashboard` > `Users` > `API User` > `API` > `Address Book API Access`\n\nWith this set of endpoints, you can:\n\n* Programmatically create, retrieve, update, and delete contacts. Keep your data synchronised across systems without manual effort (CRMs, HR systems, Spreadsheets and more).\n* Organise contacts into groups. Send a message to thousands with a single API call by referencing a `GroupID`.\n* Store custom fields for each contact (e.g., `FirstName`, `Company`, `Custom1`) and use them as merge tags like `[[FirstName]]` to personalise messages across any channel.\n* Drastically reduce your payload size. Instead of sending a full array of recipient details every time, simply reference the unique `ContactID` or `GroupID`.\n* Use your contacts and groups with the TNZ Dashboard.\n\n![Address Book](https://www.tnz.co.nz/docs/restapi/assets/images/AddressBook[128x75].png)\n", "type": "text/plain" }, "item": [ { "id": "cf1232ed-20de-4c6e-a153-13fe7df76e42", "name": "Contact: Create", "request": { "name": "Contact: Create", "description": { "content": "Create a new contact in the address book.", "type": "text/plain" }, "url": { "path": [ "addressbook", "contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"ExType\": \"\",\n \"ExID\": \"\",\n \"ViewBy\": \"\",\n \"EditBy\": \"\",\n \"AccessControl\": \"\",\n \"Attention\": \"\",\n \"Title\": \"\",\n \"Company\": \"\",\n \"RecipDepartment\": \"\",\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"Position\": \"\",\n \"StreetAddress\": \"\",\n \"Suburb\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Country\": \"\",\n \"Postcode\": \"\",\n \"MainPhone\": \"\",\n \"AltPhone1\": \"\",\n \"AltPhone2\": \"\",\n \"AltPhone3\": \"\",\n \"AltPhone4\": \"\",\n \"AltPhone5\": \"\",\n \"AltPhone6\": \"\",\n \"AltPhone7\": \"\",\n \"AltPhone8\": \"\",\n \"MobilePhone\": \"\",\n \"FaxNumber\": \"\",\n \"EmailAddress\": \"\",\n \"WebAddress\": \"\",\n \"Custom1\": \"\",\n \"Custom2\": \"\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"Notes\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b0a14dd7-4e5e-4c55-8cb1-cb8e6e25cfd5", "name": "OK [contact created]", "originalRequest": { "url": { "path": [ "addressbook", "contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ExType\": \"\",\n \"ExID\": \"\",\n \"ViewBy\": \"Account\",\n \"EditBy\": \"Account\",\n \"AccessControl\": \"Limited\",\n \"Attention\": \"John Doe\",\n \"Title\": \"Mr\",\n \"Company\": \"Example Company\",\n \"RecipDepartment\": \"Accounting\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Position\": \"Accountant\",\n \"StreetAddress\": \"123 Queen Street\",\n \"Suburb\": \"Auckland City\",\n \"City\": \"Auckland\",\n \"State\": \"\",\n \"Country\": \"New Zealand\",\n \"Postcode\": \"1010\",\n \"MainPhone\": \"+6421002003\",\n \"AltPhone1\": \"+6495006001\",\n \"AltPhone2\": \"+6495006002\",\n \"AltPhone3\": \"+6495006003\",\n \"AltPhone4\": \"+6495006004\",\n \"AltPhone5\": \"\",\n \"AltPhone6\": \"\",\n \"AltPhone7\": \"\",\n \"AltPhone8\": \"\",\n \"MobilePhone\": \"+6421002003\",\n \"FaxNumber\": \"+64 9 500-5000\",\n \"EmailAddress\": \"john.doe@example.com\",\n \"WebAddress\": \"https://www.example.com\",\n \"Custom1\": \"Custom Value 1\",\n \"Custom2\": \"Custom Value 2\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"Notes\": \"This contact was created using the Address Book API.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"Owner\": \"COM\\\\DOMAIN\\\\APPLICATION\",\n \"CreatedTimeLocal\": \"2025-05-29 05:11:03\",\n \"CreatedTimeUTC\": \"2025-05-29 17:11:03\",\n \"CreatedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"UpdatedTimeLocal\": \"0001-01-01 12:00:00\",\n \"UpdatedTimeUTC\": \"0001-01-01 00:00:00\",\n \"UpdatedTimeUTC_RFC3339\": \"0001-01-01T00:00:00.000Z\",\n \"Timezone\": \"New Zealand\",\n \"ExType\": \"\",\n \"ExID\": \"\",\n \"ViewBy\": \"Account\",\n \"EditBy\": \"Account\",\n \"AccessControl\": \"Limited\",\n \"Attention\": \"John Doe\",\n \"Title\": \"Mr\",\n \"Company\": \"Example Company\",\n \"RecipDepartment\": \"Accounting\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Position\": \"Accountant\",\n \"StreetAddress\": \"123 Queen Street\",\n \"Suburb\": \"Auckland City\",\n \"City\": \"Auckland\",\n \"State\": \"\",\n \"Country\": \"New Zealand\",\n \"Postcode\": \"1010\",\n \"MainPhone\": \"+6421002003\",\n \"AltPhone1\": \"+6495006001\",\n \"AltPhone2\": \"+6495006002\",\n \"AltPhone3\": \"+6495006003\",\n \"AltPhone4\": \"+6495006004\",\n \"AltPhone5\": \"\",\n \"AltPhone6\": \"\",\n \"AltPhone7\": \"\",\n \"AltPhone8\": \"\",\n \"MobilePhone\": \"+6421002003\",\n \"FaxNumber\": \"+64 9 500-5000\",\n \"EmailAddress\": \"john.doe@example.com\",\n \"WebAddress\": \"https://www.example.com\",\n \"Custom1\": \"Custom Value 1\",\n \"Custom2\": \"Custom Value 2\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"Notes\": \"This contact was created using the Address Book API.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c566a85-c5c7-48e3-9e3e-00d15f6d10de", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "addressbook", "contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ExType\": \"\",\n \"ExID\": \"\",\n \"ViewBy\": \"Account\",\n \"EditBy\": \"Account\",\n \"AccessControl\": \"Limited\",\n \"Attention\": \"John Doe\",\n \"Title\": \"Mr\",\n \"Company\": \"Example Company\",\n \"RecipDepartment\": \"Accounting\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Position\": \"Accountant\",\n \"StreetAddress\": \"123 Queen Street\",\n \"Suburb\": \"Auckland City\",\n \"City\": \"Auckland\",\n \"State\": \"\",\n \"Country\": \"New Zealand\",\n \"Postcode\": \"1010\",\n \"MainPhone\": \"+6421002003\",\n \"AltPhone1\": \"+6495006001\",\n \"AltPhone2\": \"+6495006002\",\n \"AltPhone3\": \"+6495006003\",\n \"AltPhone4\": \"+6495006004\",\n \"AltPhone5\": \"\",\n \"AltPhone6\": \"\",\n \"AltPhone7\": \"\",\n \"AltPhone8\": \"\",\n \"MobilePhone\": \"+6421002003\",\n \"FaxNumber\": \"+64 9 500-5000\",\n \"EmailAddress\": \"john.doe@example.com\",\n \"WebAddress\": \"https://www.example.com\",\n \"Custom1\": \"Custom Value 1\",\n \"Custom2\": \"Custom Value 2\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"Notes\": \"This contact was created using the Address Book API.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acf4132d-973d-4643-ad36-50eecdcf1eee", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "addressbook", "contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ExType\": \"\",\n \"ExID\": \"\",\n \"ViewBy\": \"Account\",\n \"EditBy\": \"Account\",\n \"AccessControl\": \"Limited\",\n \"Attention\": \"John Doe\",\n \"Title\": \"Mr\",\n \"Company\": \"Example Company\",\n \"RecipDepartment\": \"Accounting\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Position\": \"Accountant\",\n \"StreetAddress\": \"123 Queen Street\",\n \"Suburb\": \"Auckland City\",\n \"City\": \"Auckland\",\n \"State\": \"\",\n \"Country\": \"New Zealand\",\n \"Postcode\": \"1010\",\n \"MainPhone\": \"+6421002003\",\n \"AltPhone1\": \"+6495006001\",\n \"AltPhone2\": \"+6495006002\",\n \"AltPhone3\": \"+6495006003\",\n \"AltPhone4\": \"+6495006004\",\n \"AltPhone5\": \"\",\n \"AltPhone6\": \"\",\n \"AltPhone7\": \"\",\n \"AltPhone8\": \"\",\n \"MobilePhone\": \"+6421002003\",\n \"FaxNumber\": \"+64 9 500-5000\",\n \"EmailAddress\": \"john.doe@example.com\",\n \"WebAddress\": \"https://www.example.com\",\n \"Custom1\": \"Custom Value 1\",\n \"Custom2\": \"Custom Value 2\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"Notes\": \"This contact was created using the Address Book API.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a783ffbe-e3c3-4afe-9eb7-5056972bdfdc", "name": "Forbidden [access to this endpoint is disabled]", "originalRequest": { "url": { "path": [ "addressbook", "contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ExType\": \"\",\n \"ExID\": \"\",\n \"ViewBy\": \"Account\",\n \"EditBy\": \"Account\",\n \"AccessControl\": \"Limited\",\n \"Attention\": \"John Doe\",\n \"Title\": \"Mr\",\n \"Company\": \"Example Company\",\n \"RecipDepartment\": \"Accounting\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Position\": \"Accountant\",\n \"StreetAddress\": \"123 Queen Street\",\n \"Suburb\": \"Auckland City\",\n \"City\": \"Auckland\",\n \"State\": \"\",\n \"Country\": \"New Zealand\",\n \"Postcode\": \"1010\",\n \"MainPhone\": \"+6421002003\",\n \"AltPhone1\": \"+6495006001\",\n \"AltPhone2\": \"+6495006002\",\n \"AltPhone3\": \"+6495006003\",\n \"AltPhone4\": \"+6495006004\",\n \"AltPhone5\": \"\",\n \"AltPhone6\": \"\",\n \"AltPhone7\": \"\",\n \"AltPhone8\": \"\",\n \"MobilePhone\": \"+6421002003\",\n \"FaxNumber\": \"+64 9 500-5000\",\n \"EmailAddress\": \"john.doe@example.com\",\n \"WebAddress\": \"https://www.example.com\",\n \"Custom1\": \"Custom Value 1\",\n \"Custom2\": \"Custom Value 2\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"Notes\": \"This contact was created using the Address Book API.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"Unauthorized access to Addressbook API!\",\n \"Unauthorized access to Addressbook API!\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66d3c374-a1ba-4490-a462-2474a300d828", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "addressbook", "contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ExType\": \"\",\n \"ExID\": \"\",\n \"ViewBy\": \"Account\",\n \"EditBy\": \"Account\",\n \"AccessControl\": \"Limited\",\n \"Attention\": \"John Doe\",\n \"Title\": \"Mr\",\n \"Company\": \"Example Company\",\n \"RecipDepartment\": \"Accounting\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Position\": \"Accountant\",\n \"StreetAddress\": \"123 Queen Street\",\n \"Suburb\": \"Auckland City\",\n \"City\": \"Auckland\",\n \"State\": \"\",\n \"Country\": \"New Zealand\",\n \"Postcode\": \"1010\",\n \"MainPhone\": \"+6421002003\",\n \"AltPhone1\": \"+6495006001\",\n \"AltPhone2\": \"+6495006002\",\n \"AltPhone3\": \"+6495006003\",\n \"AltPhone4\": \"+6495006004\",\n \"AltPhone5\": \"\",\n \"AltPhone6\": \"\",\n \"AltPhone7\": \"\",\n \"AltPhone8\": \"\",\n \"MobilePhone\": \"+6421002003\",\n \"FaxNumber\": \"+64 9 500-5000\",\n \"EmailAddress\": \"john.doe@example.com\",\n \"WebAddress\": \"https://www.example.com\",\n \"Custom1\": \"Custom Value 1\",\n \"Custom2\": \"Custom Value 2\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"Notes\": \"This contact was created using the Address Book API.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3b6e13b-c031-405a-a7b0-a0d4f2bc5669", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "addressbook", "contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ExType\": \"\",\n \"ExID\": \"\",\n \"ViewBy\": \"Account\",\n \"EditBy\": \"Account\",\n \"AccessControl\": \"Limited\",\n \"Attention\": \"John Doe\",\n \"Title\": \"Mr\",\n \"Company\": \"Example Company\",\n \"RecipDepartment\": \"Accounting\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Position\": \"Accountant\",\n \"StreetAddress\": \"123 Queen Street\",\n \"Suburb\": \"Auckland City\",\n \"City\": \"Auckland\",\n \"State\": \"\",\n \"Country\": \"New Zealand\",\n \"Postcode\": \"1010\",\n \"MainPhone\": \"+6421002003\",\n \"AltPhone1\": \"+6495006001\",\n \"AltPhone2\": \"+6495006002\",\n \"AltPhone3\": \"+6495006003\",\n \"AltPhone4\": \"+6495006004\",\n \"AltPhone5\": \"\",\n \"AltPhone6\": \"\",\n \"AltPhone7\": \"\",\n \"AltPhone8\": \"\",\n \"MobilePhone\": \"+6421002003\",\n \"FaxNumber\": \"+64 9 500-5000\",\n \"EmailAddress\": \"john.doe@example.com\",\n \"WebAddress\": \"https://www.example.com\",\n \"Custom1\": \"Custom Value 1\",\n \"Custom2\": \"Custom Value 2\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"Notes\": \"This contact was created using the Address Book API.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0f4bf27f-fdfd-4a3b-830d-b521c26f3203", "name": "Contact: Search", "request": { "name": "Contact: Search", "description": { "content": "Search for contacts using various criteria. Partial matches are supported for most text fields.", "type": "text/plain" }, "url": { "path": [ "addressbook", "contact", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1", "description": "Page number to retrieve." }, { "disabled": false, "key": "recordsPerPage", "value": "", "description": "Number of records to return per page." }, { "disabled": false, "key": "EmailAddress", "value": "", "description": "Full match search by email address." }, { "disabled": false, "key": "MobilePhone", "value": "", "description": "Partial match search by mobile phone number." }, { "disabled": false, "key": "MainPhone", "value": "", "description": "Partial match search by main phone number." }, { "disabled": false, "key": "Attention", "value": "", "description": "Partial match search by attention field." }, { "disabled": false, "key": "FirstName", "value": "", "description": "Partial match search by first name." }, { "disabled": false, "key": "LastName", "value": "", "description": "Partial match search by last name." }, { "disabled": false, "key": "Company", "value": "", "description": "Partial match search by company name." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b9cfd7bb-3419-431d-8346-8367339710da", "name": "OK", "originalRequest": { "url": { "path": [ "addressbook", "contact", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "recordsPerPage", "value": "20" }, { "key": "EmailAddress", "value": "" }, { "key": "MobilePhone", "value": "" }, { "key": "MainPhone", "value": "" }, { "key": "Attention", "value": "" }, { "key": "FirstName", "value": "" }, { "key": "LastName", "value": "" }, { "key": "Company", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"TotalRecords\": 1,\n \"RecordsPerPage\": 20,\n \"PageCount\": 1,\n \"Page\": 1,\n \"Contacts\": [\n {\n \"ContactID\": {\n \"value\": \"\"\n },\n \"Owner\": {\n \"value\": \"\"\n },\n \"CreatedTimeLocal\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"UpdatedTimeLocal\": {\n \"value\": \"\"\n },\n \"UpdatedTimeUTC\": {\n \"value\": \"\"\n },\n \"UpdatedTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Timezone\": {\n \"value\": \"\"\n }\n },\n {\n \"ContactID\": {\n \"value\": \"\"\n },\n \"Owner\": {\n \"value\": \"\"\n },\n \"CreatedTimeLocal\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"UpdatedTimeLocal\": {\n \"value\": \"\"\n },\n \"UpdatedTimeUTC\": {\n \"value\": \"\"\n },\n \"UpdatedTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Timezone\": {\n \"value\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "704298e1-c407-4d8b-b7fb-575bf15c4625", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "addressbook", "contact", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "recordsPerPage", "value": "20" }, { "key": "EmailAddress", "value": "" }, { "key": "MobilePhone", "value": "" }, { "key": "MainPhone", "value": "" }, { "key": "Attention", "value": "" }, { "key": "FirstName", "value": "" }, { "key": "LastName", "value": "" }, { "key": "Company", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2edcf70-9b52-4c07-9db7-989ad379aa09", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "addressbook", "contact", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "recordsPerPage", "value": "20" }, { "key": "EmailAddress", "value": "" }, { "key": "MobilePhone", "value": "" }, { "key": "MainPhone", "value": "" }, { "key": "Attention", "value": "" }, { "key": "FirstName", "value": "" }, { "key": "LastName", "value": "" }, { "key": "Company", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ebffcc9-a7da-479e-9503-18bd08eb9b6d", "name": "Forbidden [access to this endpoint is disabled]", "originalRequest": { "url": { "path": [ "addressbook", "contact", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "recordsPerPage", "value": "20" }, { "key": "EmailAddress", "value": "" }, { "key": "MobilePhone", "value": "" }, { "key": "MainPhone", "value": "" }, { "key": "Attention", "value": "" }, { "key": "FirstName", "value": "" }, { "key": "LastName", "value": "" }, { "key": "Company", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"Unauthorized access to Addressbook API!\",\n \"Unauthorized access to Addressbook API!\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65b4d9ea-97ba-4a38-afdf-02912870371e", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "addressbook", "contact", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "recordsPerPage", "value": "20" }, { "key": "EmailAddress", "value": "" }, { "key": "MobilePhone", "value": "" }, { "key": "MainPhone", "value": "" }, { "key": "Attention", "value": "" }, { "key": "FirstName", "value": "" }, { "key": "LastName", "value": "" }, { "key": "Company", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c39f192a-f629-467d-bcdb-5428652a7fd2", "name": "Contact: List", "request": { "name": "Contact: List", "description": { "content": "Retrieve a list of all contacts in the address book.", "type": "text/plain" }, "url": { "path": [ "addressbook", "contact", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1", "description": "Page number to retrieve." }, { "disabled": false, "key": "recordsPerPage", "value": "", "description": "Number of records to return per page." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e8a914b8-8d4d-49b4-a2f8-973149d5a4c9", "name": "OK", "originalRequest": { "url": { "path": [ "addressbook", "contact", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "recordsPerPage", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"TotalRecords\": 1,\n \"RecordsPerPage\": 20,\n \"PageCount\": 1,\n \"Page\": 1,\n \"Contacts\": [\n {\n \"ContactID\": {\n \"value\": \"\"\n },\n \"Owner\": {\n \"value\": \"\"\n },\n \"CreatedTimeLocal\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"UpdatedTimeLocal\": {\n \"value\": \"\"\n },\n \"UpdatedTimeUTC\": {\n \"value\": \"\"\n },\n \"UpdatedTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Timezone\": {\n \"value\": \"\"\n }\n },\n {\n \"ContactID\": {\n \"value\": \"\"\n },\n \"Owner\": {\n \"value\": \"\"\n },\n \"CreatedTimeLocal\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"UpdatedTimeLocal\": {\n \"value\": \"\"\n },\n \"UpdatedTimeUTC\": {\n \"value\": \"\"\n },\n \"UpdatedTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Timezone\": {\n \"value\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "023ce0e9-3c83-4f00-8c50-73545ed99a80", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "addressbook", "contact", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "recordsPerPage", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e194582f-edeb-4b14-8549-e09e6041227e", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "addressbook", "contact", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "recordsPerPage", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da0b9dbb-c160-4d91-b384-c354909e6ee0", "name": "Forbidden [access to this endpoint is disabled]", "originalRequest": { "url": { "path": [ "addressbook", "contact", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "recordsPerPage", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"Unauthorized access to Addressbook API!\",\n \"Unauthorized access to Addressbook API!\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6022b5b-902f-44e7-b7b6-ab7ebd7d4185", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "addressbook", "contact", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "recordsPerPage", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6ccc6b15-9d5e-4ab0-bfd4-51c7d765d20b", "name": "Contact: List Groups", "request": { "name": "Contact: List Groups", "description": { "content": "Retrieve a list of groups that a specific contact belongs to.", "type": "text/plain" }, "url": { "path": [ "addressbook", "contact", ":ContactID", "group", "list" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7e96c624-08c8-4bbd-ba51-eb3b23957333", "name": "OK", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID", "group", "list" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"TotalRecords\": 1,\n \"RecordsPerPage\": 20,\n \"PageCount\": 1,\n \"Page\": 1,\n \"Contact\": {\n \"ContactID\": {\n \"value\": \"\"\n },\n \"Owner\": {\n \"value\": \"\"\n },\n \"CreatedTimeLocal\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"UpdatedTimeLocal\": {\n \"value\": \"\"\n },\n \"UpdatedTimeUTC\": {\n \"value\": \"\"\n },\n \"UpdatedTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Timezone\": {\n \"value\": \"\"\n },\n \"ExType\": {\n \"value\": \"\"\n },\n \"ExID\": {\n \"value\": \"\"\n },\n \"ViewBy\": {\n \"value\": \"\"\n },\n \"EditBy\": {\n \"value\": \"\"\n },\n \"AccessControl\": {\n \"value\": \"\"\n },\n \"Attention\": {\n \"value\": \"\"\n },\n \"Title\": {\n \"value\": \"\"\n },\n \"Company\": {\n \"value\": \"\"\n },\n \"RecipDepartment\": {\n \"value\": \"\"\n },\n \"FirstName\": {\n \"value\": \"\"\n },\n \"LastName\": {\n \"value\": \"\"\n },\n \"Position\": {\n \"value\": \"\"\n },\n \"StreetAddress\": {\n \"value\": \"\"\n },\n \"Suburb\": {\n \"value\": \"\"\n },\n \"City\": {\n \"value\": \"\"\n },\n \"State\": {\n \"value\": \"\"\n },\n \"Country\": {\n \"value\": \"\"\n },\n \"Postcode\": {\n \"value\": \"\"\n },\n \"MainPhone\": {\n \"value\": \"\"\n },\n \"AltPhone1\": {\n \"value\": \"\"\n },\n \"AltPhone2\": {\n \"value\": \"\"\n },\n \"AltPhone3\": {\n \"value\": \"\"\n },\n \"AltPhone4\": {\n \"value\": \"\"\n },\n \"AltPhone5\": {\n \"value\": \"\"\n },\n \"AltPhone6\": {\n \"value\": \"\"\n },\n \"AltPhone7\": {\n \"value\": \"\"\n },\n \"AltPhone8\": {\n \"value\": \"\"\n },\n \"MobilePhone\": {\n \"value\": \"\"\n },\n \"FaxNumber\": {\n \"value\": \"\"\n },\n \"EmailAddress\": {\n \"value\": \"\"\n },\n \"WebAddress\": {\n \"value\": \"\"\n },\n \"Custom1\": {\n \"value\": \"\"\n },\n \"Custom2\": {\n \"value\": \"\"\n },\n \"Custom3\": {\n \"value\": \"\"\n },\n \"Custom4\": {\n \"value\": \"\"\n },\n \"Notes\": {\n \"value\": \"\"\n }\n },\n \"Groups\": [\n {\n \"GroupID\": {\n \"value\": \"\"\n },\n \"GroupCode\": {\n \"value\": \"\"\n },\n \"Owner\": {\n \"value\": \"\"\n },\n \"CreatedTimeLocal\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Timezone\": {\n \"value\": \"\"\n }\n },\n {\n \"GroupID\": {\n \"value\": \"\"\n },\n \"GroupCode\": {\n \"value\": \"\"\n },\n \"Owner\": {\n \"value\": \"\"\n },\n \"CreatedTimeLocal\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Timezone\": {\n \"value\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6862aa61-a9cf-475f-897e-e0545b863e62", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID", "group", "list" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a0fbb79-aafb-438d-885a-388de87206d6", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID", "group", "list" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b45bffe1-6cbb-4ecf-8631-5cd97fefc06b", "name": "Forbidden [access to this endpoint is disabled]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID", "group", "list" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"Unauthorized access to Addressbook API!\",\n \"Unauthorized access to Addressbook API!\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7120735e-fa00-48cb-bf12-63ce2a18f03f", "name": "Not Found [record not found]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID", "group", "list" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"ErrorMessage\": [\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\",\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0acaf78-ed1d-4147-8517-92c879cf2f61", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID", "group", "list" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e21736a8-9341-4883-b26b-4a2efa706fd5", "name": "Contact: Details", "request": { "name": "Contact: Details", "description": { "content": "Retrieve the details of a specific contact by their ContactID.", "type": "text/plain" }, "url": { "path": [ "addressbook", "contact", ":ContactID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "73e51b58-f93f-4d6e-9a80-7dba1eb579aa", "name": "OK", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"Owner\": \"COM\\\\DOMAIN\\\\APPLICATION\",\n \"CreatedTimeLocal\": \"2025-05-29 05:11:03\",\n \"CreatedTimeUTC\": \"2025-05-29 17:11:03\",\n \"CreatedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"UpdatedTimeLocal\": \"0001-01-01 12:00:00\",\n \"UpdatedTimeUTC\": \"0001-01-01 00:00:00\",\n \"UpdatedTimeUTC_RFC3339\": \"0001-01-01T00:00:00.000Z\",\n \"Timezone\": \"New Zealand\",\n \"ExType\": \"\",\n \"ExID\": \"\",\n \"ViewBy\": {\n \"value\": \"\"\n },\n \"EditBy\": {\n \"value\": \"\"\n },\n \"AccessControl\": {\n \"value\": \"\"\n },\n \"Attention\": {\n \"value\": \"\"\n },\n \"Title\": \"Mr\",\n \"Company\": \"Example Company\",\n \"RecipDepartment\": \"Accounting\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Position\": \"Accountant\",\n \"StreetAddress\": \"123 Queen Street\",\n \"Suburb\": \"Auckland City\",\n \"City\": \"Auckland\",\n \"State\": \"\",\n \"Country\": \"New Zealand\",\n \"Postcode\": \"1010\",\n \"MainPhone\": \"+6421002003\",\n \"AltPhone1\": \"+6495006001\",\n \"AltPhone2\": \"+6495006002\",\n \"AltPhone3\": \"+6495006003\",\n \"AltPhone4\": \"+6495006004\",\n \"AltPhone5\": \"\",\n \"AltPhone6\": \"\",\n \"AltPhone7\": \"\",\n \"AltPhone8\": \"\",\n \"MobilePhone\": \"+6421002003\",\n \"FaxNumber\": \"+64 9 500-5000\",\n \"EmailAddress\": \"john.doe@example.com\",\n \"WebAddress\": \"https://www.example.com\",\n \"Custom1\": \"Custom Value 1\",\n \"Custom2\": \"Custom Value 2\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"Notes\": \"This contact was created using the Address Book API.\",\n \"Groups\": [\n \"223e4567-e89b-12d3-a456-426614175000\",\n \"223e4567-e89b-12d3-a456-426614175000\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb7c1ff3-be59-460c-974c-56d3c15f1419", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4c37600-0a4b-42d3-870b-06b45a473cc3", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79e5b0f1-4477-4ede-98b7-ec1aab85547f", "name": "Forbidden [access to this endpoint is disabled]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"Unauthorized access to Addressbook API!\",\n \"Unauthorized access to Addressbook API!\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea6eda2e-fec8-402c-8956-fa766f89c044", "name": "Not Found [record not found]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"ErrorMessage\": [\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\",\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dec0b04-0ac7-4949-9896-0f6ae95fb6c1", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "742e3db6-c815-44b5-9a4c-5c05394c9f9f", "name": "Contact: Update", "request": { "name": "Contact: Update", "description": { "content": "Update the details of an existing contact.", "type": "text/plain" }, "url": { "path": [ "addressbook", "contact", ":ContactID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"ExType\": \"\",\n \"ExID\": \"\",\n \"ViewBy\": \"\",\n \"EditBy\": \"\",\n \"AccessControl\": \"\",\n \"Attention\": \"\",\n \"Title\": \"\",\n \"Company\": \"\",\n \"RecipDepartment\": \"\",\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"Position\": \"\",\n \"StreetAddress\": \"\",\n \"Suburb\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"Country\": \"\",\n \"Postcode\": \"\",\n \"MainPhone\": \"\",\n \"AltPhone1\": \"\",\n \"AltPhone2\": \"\",\n \"AltPhone3\": \"\",\n \"AltPhone4\": \"\",\n \"AltPhone5\": \"\",\n \"AltPhone6\": \"\",\n \"AltPhone7\": \"\",\n \"AltPhone8\": \"\",\n \"MobilePhone\": \"\",\n \"FaxNumber\": \"\",\n \"EmailAddress\": \"\",\n \"WebAddress\": \"\",\n \"Custom1\": \"\",\n \"Custom2\": \"\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"Notes\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9436bf5f-d15d-4e35-93cf-8a03506dbbeb", "name": "OK [contact updated]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ExType\": \"\",\n \"ExID\": \"\",\n \"ViewBy\": \"Account\",\n \"EditBy\": \"Account\",\n \"AccessControl\": \"Limited\",\n \"Attention\": \"John Doe\",\n \"Title\": \"Mr\",\n \"Company\": \"Example Company\",\n \"RecipDepartment\": \"Accounting\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Position\": \"Accountant\",\n \"StreetAddress\": \"123 Queen Street\",\n \"Suburb\": \"Auckland City\",\n \"City\": \"Auckland\",\n \"State\": \"\",\n \"Country\": \"New Zealand\",\n \"Postcode\": \"1010\",\n \"MainPhone\": \"+6421002003\",\n \"AltPhone1\": \"+6495006001\",\n \"AltPhone2\": \"+6495006002\",\n \"AltPhone3\": \"+6495006003\",\n \"AltPhone4\": \"+6495006004\",\n \"AltPhone5\": \"\",\n \"AltPhone6\": \"\",\n \"AltPhone7\": \"\",\n \"AltPhone8\": \"\",\n \"MobilePhone\": \"+6421002003\",\n \"FaxNumber\": \"+64 9 500-5000\",\n \"EmailAddress\": \"john.doe@example.com\",\n \"WebAddress\": \"https://www.example.com\",\n \"Custom1\": \"Custom Value 1\",\n \"Custom2\": \"Custom Value 2\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"Notes\": \"This contact was created using the Address Book API.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"Owner\": \"COM\\\\DOMAIN\\\\APPLICATION\",\n \"CreatedTimeLocal\": \"2025-05-29 05:11:03\",\n \"CreatedTimeUTC\": \"2025-05-29 17:11:03\",\n \"CreatedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"UpdatedTimeLocal\": \"0001-01-01 12:00:00\",\n \"UpdatedTimeUTC\": \"0001-01-01 00:00:00\",\n \"UpdatedTimeUTC_RFC3339\": \"0001-01-01T00:00:00.000Z\",\n \"Timezone\": \"New Zealand\",\n \"ExType\": \"\",\n \"ExID\": \"\",\n \"ViewBy\": \"Account\",\n \"EditBy\": \"Account\",\n \"AccessControl\": \"Limited\",\n \"Attention\": \"John Doe\",\n \"Title\": \"Mr\",\n \"Company\": \"Example Company\",\n \"RecipDepartment\": \"Accounting\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Position\": \"Accountant\",\n \"StreetAddress\": \"123 Queen Street\",\n \"Suburb\": \"Auckland City\",\n \"City\": \"Auckland\",\n \"State\": \"\",\n \"Country\": \"New Zealand\",\n \"Postcode\": \"1010\",\n \"MainPhone\": \"+6421002003\",\n \"AltPhone1\": \"+6495006001\",\n \"AltPhone2\": \"+6495006002\",\n \"AltPhone3\": \"+6495006003\",\n \"AltPhone4\": \"+6495006004\",\n \"AltPhone5\": \"\",\n \"AltPhone6\": \"\",\n \"AltPhone7\": \"\",\n \"AltPhone8\": \"\",\n \"MobilePhone\": \"+6421002003\",\n \"FaxNumber\": \"+64 9 500-5000\",\n \"EmailAddress\": \"john.doe@example.com\",\n \"WebAddress\": \"https://www.example.com\",\n \"Custom1\": \"Custom Value 1\",\n \"Custom2\": \"Custom Value 2\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"Notes\": \"This contact was created using the Address Book API.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd8e6505-2b77-4c92-946e-00ecb52887a0", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ExType\": \"\",\n \"ExID\": \"\",\n \"ViewBy\": \"Account\",\n \"EditBy\": \"Account\",\n \"AccessControl\": \"Limited\",\n \"Attention\": \"John Doe\",\n \"Title\": \"Mr\",\n \"Company\": \"Example Company\",\n \"RecipDepartment\": \"Accounting\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Position\": \"Accountant\",\n \"StreetAddress\": \"123 Queen Street\",\n \"Suburb\": \"Auckland City\",\n \"City\": \"Auckland\",\n \"State\": \"\",\n \"Country\": \"New Zealand\",\n \"Postcode\": \"1010\",\n \"MainPhone\": \"+6421002003\",\n \"AltPhone1\": \"+6495006001\",\n \"AltPhone2\": \"+6495006002\",\n \"AltPhone3\": \"+6495006003\",\n \"AltPhone4\": \"+6495006004\",\n \"AltPhone5\": \"\",\n \"AltPhone6\": \"\",\n \"AltPhone7\": \"\",\n \"AltPhone8\": \"\",\n \"MobilePhone\": \"+6421002003\",\n \"FaxNumber\": \"+64 9 500-5000\",\n \"EmailAddress\": \"john.doe@example.com\",\n \"WebAddress\": \"https://www.example.com\",\n \"Custom1\": \"Custom Value 1\",\n \"Custom2\": \"Custom Value 2\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"Notes\": \"This contact was created using the Address Book API.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0d8c83c-e493-46e0-91de-c2a06488ddda", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ExType\": \"\",\n \"ExID\": \"\",\n \"ViewBy\": \"Account\",\n \"EditBy\": \"Account\",\n \"AccessControl\": \"Limited\",\n \"Attention\": \"John Doe\",\n \"Title\": \"Mr\",\n \"Company\": \"Example Company\",\n \"RecipDepartment\": \"Accounting\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Position\": \"Accountant\",\n \"StreetAddress\": \"123 Queen Street\",\n \"Suburb\": \"Auckland City\",\n \"City\": \"Auckland\",\n \"State\": \"\",\n \"Country\": \"New Zealand\",\n \"Postcode\": \"1010\",\n \"MainPhone\": \"+6421002003\",\n \"AltPhone1\": \"+6495006001\",\n \"AltPhone2\": \"+6495006002\",\n \"AltPhone3\": \"+6495006003\",\n \"AltPhone4\": \"+6495006004\",\n \"AltPhone5\": \"\",\n \"AltPhone6\": \"\",\n \"AltPhone7\": \"\",\n \"AltPhone8\": \"\",\n \"MobilePhone\": \"+6421002003\",\n \"FaxNumber\": \"+64 9 500-5000\",\n \"EmailAddress\": \"john.doe@example.com\",\n \"WebAddress\": \"https://www.example.com\",\n \"Custom1\": \"Custom Value 1\",\n \"Custom2\": \"Custom Value 2\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"Notes\": \"This contact was created using the Address Book API.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6e77a69-cf72-49e3-9752-db884f68f27d", "name": "Forbidden [access to this endpoint is disabled]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ExType\": \"\",\n \"ExID\": \"\",\n \"ViewBy\": \"Account\",\n \"EditBy\": \"Account\",\n \"AccessControl\": \"Limited\",\n \"Attention\": \"John Doe\",\n \"Title\": \"Mr\",\n \"Company\": \"Example Company\",\n \"RecipDepartment\": \"Accounting\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Position\": \"Accountant\",\n \"StreetAddress\": \"123 Queen Street\",\n \"Suburb\": \"Auckland City\",\n \"City\": \"Auckland\",\n \"State\": \"\",\n \"Country\": \"New Zealand\",\n \"Postcode\": \"1010\",\n \"MainPhone\": \"+6421002003\",\n \"AltPhone1\": \"+6495006001\",\n \"AltPhone2\": \"+6495006002\",\n \"AltPhone3\": \"+6495006003\",\n \"AltPhone4\": \"+6495006004\",\n \"AltPhone5\": \"\",\n \"AltPhone6\": \"\",\n \"AltPhone7\": \"\",\n \"AltPhone8\": \"\",\n \"MobilePhone\": \"+6421002003\",\n \"FaxNumber\": \"+64 9 500-5000\",\n \"EmailAddress\": \"john.doe@example.com\",\n \"WebAddress\": \"https://www.example.com\",\n \"Custom1\": \"Custom Value 1\",\n \"Custom2\": \"Custom Value 2\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"Notes\": \"This contact was created using the Address Book API.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"Unauthorized access to Addressbook API!\",\n \"Unauthorized access to Addressbook API!\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c67e637-aa8e-448d-b58a-295ca91b000b", "name": "Not Found [record not found]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ExType\": \"\",\n \"ExID\": \"\",\n \"ViewBy\": \"Account\",\n \"EditBy\": \"Account\",\n \"AccessControl\": \"Limited\",\n \"Attention\": \"John Doe\",\n \"Title\": \"Mr\",\n \"Company\": \"Example Company\",\n \"RecipDepartment\": \"Accounting\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Position\": \"Accountant\",\n \"StreetAddress\": \"123 Queen Street\",\n \"Suburb\": \"Auckland City\",\n \"City\": \"Auckland\",\n \"State\": \"\",\n \"Country\": \"New Zealand\",\n \"Postcode\": \"1010\",\n \"MainPhone\": \"+6421002003\",\n \"AltPhone1\": \"+6495006001\",\n \"AltPhone2\": \"+6495006002\",\n \"AltPhone3\": \"+6495006003\",\n \"AltPhone4\": \"+6495006004\",\n \"AltPhone5\": \"\",\n \"AltPhone6\": \"\",\n \"AltPhone7\": \"\",\n \"AltPhone8\": \"\",\n \"MobilePhone\": \"+6421002003\",\n \"FaxNumber\": \"+64 9 500-5000\",\n \"EmailAddress\": \"john.doe@example.com\",\n \"WebAddress\": \"https://www.example.com\",\n \"Custom1\": \"Custom Value 1\",\n \"Custom2\": \"Custom Value 2\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"Notes\": \"This contact was created using the Address Book API.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"ErrorMessage\": [\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\",\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec139ea6-63a3-420e-acb3-aab4799c1b15", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ExType\": \"\",\n \"ExID\": \"\",\n \"ViewBy\": \"Account\",\n \"EditBy\": \"Account\",\n \"AccessControl\": \"Limited\",\n \"Attention\": \"John Doe\",\n \"Title\": \"Mr\",\n \"Company\": \"Example Company\",\n \"RecipDepartment\": \"Accounting\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Position\": \"Accountant\",\n \"StreetAddress\": \"123 Queen Street\",\n \"Suburb\": \"Auckland City\",\n \"City\": \"Auckland\",\n \"State\": \"\",\n \"Country\": \"New Zealand\",\n \"Postcode\": \"1010\",\n \"MainPhone\": \"+6421002003\",\n \"AltPhone1\": \"+6495006001\",\n \"AltPhone2\": \"+6495006002\",\n \"AltPhone3\": \"+6495006003\",\n \"AltPhone4\": \"+6495006004\",\n \"AltPhone5\": \"\",\n \"AltPhone6\": \"\",\n \"AltPhone7\": \"\",\n \"AltPhone8\": \"\",\n \"MobilePhone\": \"+6421002003\",\n \"FaxNumber\": \"+64 9 500-5000\",\n \"EmailAddress\": \"john.doe@example.com\",\n \"WebAddress\": \"https://www.example.com\",\n \"Custom1\": \"Custom Value 1\",\n \"Custom2\": \"Custom Value 2\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"Notes\": \"This contact was created using the Address Book API.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bed69ddd-66c0-4be1-b5e7-485a5118b958", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ExType\": \"\",\n \"ExID\": \"\",\n \"ViewBy\": \"Account\",\n \"EditBy\": \"Account\",\n \"AccessControl\": \"Limited\",\n \"Attention\": \"John Doe\",\n \"Title\": \"Mr\",\n \"Company\": \"Example Company\",\n \"RecipDepartment\": \"Accounting\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Position\": \"Accountant\",\n \"StreetAddress\": \"123 Queen Street\",\n \"Suburb\": \"Auckland City\",\n \"City\": \"Auckland\",\n \"State\": \"\",\n \"Country\": \"New Zealand\",\n \"Postcode\": \"1010\",\n \"MainPhone\": \"+6421002003\",\n \"AltPhone1\": \"+6495006001\",\n \"AltPhone2\": \"+6495006002\",\n \"AltPhone3\": \"+6495006003\",\n \"AltPhone4\": \"+6495006004\",\n \"AltPhone5\": \"\",\n \"AltPhone6\": \"\",\n \"AltPhone7\": \"\",\n \"AltPhone8\": \"\",\n \"MobilePhone\": \"+6421002003\",\n \"FaxNumber\": \"+64 9 500-5000\",\n \"EmailAddress\": \"john.doe@example.com\",\n \"WebAddress\": \"https://www.example.com\",\n \"Custom1\": \"Custom Value 1\",\n \"Custom2\": \"Custom Value 2\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"Notes\": \"This contact was created using the Address Book API.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1523832b-e966-4a56-8691-75c1725850fd", "name": "Contact: Delete", "request": { "name": "Contact: Delete", "description": { "content": "Delete a contact from the address book.", "type": "text/plain" }, "url": { "path": [ "addressbook", "contact", ":ContactID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a1be5001-c1fd-4d67-93f5-7fcb6de1ede2", "name": "OK [contact deleted]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"Owner\": \"COM\\\\DOMAIN\\\\APPLICATION\",\n \"CreatedTimeLocal\": \"2025-05-29 05:11:03\",\n \"CreatedTimeUTC\": \"2025-05-29 17:11:03\",\n \"CreatedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"UpdatedTimeLocal\": \"0001-01-01 12:00:00\",\n \"UpdatedTimeUTC\": \"0001-01-01 00:00:00\",\n \"UpdatedTimeUTC_RFC3339\": \"0001-01-01T00:00:00.000Z\",\n \"Timezone\": \"New Zealand\",\n \"ExType\": \"\",\n \"ExID\": \"\",\n \"ViewBy\": \"Account\",\n \"EditBy\": \"Account\",\n \"AccessControl\": \"Limited\",\n \"Attention\": \"John Doe\",\n \"Title\": \"Mr\",\n \"Company\": \"Example Company\",\n \"RecipDepartment\": \"Accounting\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Position\": \"Accountant\",\n \"StreetAddress\": \"123 Queen Street\",\n \"Suburb\": \"Auckland City\",\n \"City\": \"Auckland\",\n \"State\": \"\",\n \"Country\": \"New Zealand\",\n \"Postcode\": \"1010\",\n \"MainPhone\": \"+6421002003\",\n \"AltPhone1\": \"+6495006001\",\n \"AltPhone2\": \"+6495006002\",\n \"AltPhone3\": \"+6495006003\",\n \"AltPhone4\": \"+6495006004\",\n \"AltPhone5\": \"\",\n \"AltPhone6\": \"\",\n \"AltPhone7\": \"\",\n \"AltPhone8\": \"\",\n \"MobilePhone\": \"+6421002003\",\n \"FaxNumber\": \"+64 9 500-5000\",\n \"EmailAddress\": \"john.doe@example.com\",\n \"WebAddress\": \"https://www.example.com\",\n \"Custom1\": \"Custom Value 1\",\n \"Custom2\": \"Custom Value 2\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"Notes\": \"This contact was created using the Address Book API.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4885c46-7068-483c-a6f3-2e42d142946d", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf34555e-5cec-4fce-84eb-254da65a88b2", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84d91fd0-5f37-4bdd-803b-e42f772e424a", "name": "Forbidden [access to this endpoint is disabled]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"Unauthorized access to Addressbook API!\",\n \"Unauthorized access to Addressbook API!\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44110a6f-316b-4a41-b294-bf91c0c7a8e4", "name": "Not Found [record not found]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"ErrorMessage\": [\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\",\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f03a600-15bb-4648-baaa-263b0f239e9d", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "000276f0-0afc-4a41-b684-cb1d57bf567b", "name": "Group: Create", "request": { "name": "Group: Create", "description": { "content": "Create a new group in the address book.", "type": "text/plain" }, "url": { "path": [ "addressbook", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"GroupName\": \"\",\n \"SubAccount\": \"\",\n \"Department\": \"\",\n \"ViewEditBy\": \"\",\n \"AccessControl\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "32a3e16b-e47b-4501-86a1-6b201203099e", "name": "OK [group created]", "originalRequest": { "url": { "path": [ "addressbook", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"GroupName\": \"My Test Group\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"ViewEditBy\": \"id commodo\",\n \"AccessControl\": \"Limited\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"GroupID\": \"223e4567-e89b-12d3-a456-426614175000\",\n \"GroupCode\": \"My_Test_Group\",\n \"GroupName\": \"My Test Group\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"ViewEditBy\": \"ad laboris\",\n \"AccessControl\": \"Limited\",\n \"Owner\": \"COM\\\\DOMAIN\\\\APPLICATION\",\n \"CreatedTimeLocal\": \"2025-05-29 05:11:03\",\n \"CreatedTimeUTC\": \"2025-05-29 17:11:03\",\n \"CreatedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"Timezone\": \"New Zealand\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d1d902f-da92-48fd-9294-15d7ffb2c42c", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "addressbook", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"GroupName\": \"My Test Group\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"ViewEditBy\": \"id commodo\",\n \"AccessControl\": \"Limited\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36ce4833-2df3-4390-833b-436dff9c2562", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "addressbook", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"GroupName\": \"My Test Group\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"ViewEditBy\": \"id commodo\",\n \"AccessControl\": \"Limited\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "357b0311-4e4d-4149-9b19-ead81a5d9f57", "name": "Forbidden [access to this endpoint is disabled]", "originalRequest": { "url": { "path": [ "addressbook", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"GroupName\": \"My Test Group\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"ViewEditBy\": \"id commodo\",\n \"AccessControl\": \"Limited\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"Unauthorized access to Addressbook API!\",\n \"Unauthorized access to Addressbook API!\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66e743d4-0b0d-44dc-92d2-ce0dcb0c8daf", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "addressbook", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"GroupName\": \"My Test Group\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"ViewEditBy\": \"id commodo\",\n \"AccessControl\": \"Limited\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a427d099-09b8-4030-b882-394801f04f31", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "addressbook", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"GroupName\": \"My Test Group\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"ViewEditBy\": \"id commodo\",\n \"AccessControl\": \"Limited\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d38660c7-fbe7-4fe5-b641-fc951fdb65be", "name": "Group: List", "request": { "name": "Group: List", "description": { "content": "Retrieve a list of all groups in the address book.", "type": "text/plain" }, "url": { "path": [ "addressbook", "group", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1", "description": "Page number to retrieve." }, { "disabled": false, "key": "recordsPerPage", "value": "", "description": "Number of records to return per page." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a6b91820-6603-43df-b799-d4ec19294b4c", "name": "OK", "originalRequest": { "url": { "path": [ "addressbook", "group", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "recordsPerPage", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"TotalRecords\": 1,\n \"RecordsPerPage\": 20,\n \"PageCount\": 1,\n \"Page\": 1,\n \"Groups\": [\n {\n \"GroupID\": {\n \"value\": \"\"\n },\n \"GroupCode\": {\n \"value\": \"\"\n },\n \"Owner\": {\n \"value\": \"\"\n },\n \"CreatedTimeLocal\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Timezone\": {\n \"value\": \"\"\n }\n },\n {\n \"GroupID\": {\n \"value\": \"\"\n },\n \"GroupCode\": {\n \"value\": \"\"\n },\n \"Owner\": {\n \"value\": \"\"\n },\n \"CreatedTimeLocal\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Timezone\": {\n \"value\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58d15c24-873e-4295-9f8e-c51d0cc2d0ac", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "addressbook", "group", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "recordsPerPage", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "743b2cd1-7ae6-49df-be85-c730ba0bbea8", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "addressbook", "group", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "recordsPerPage", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97d61a2c-b823-4b69-99f5-768f5681d608", "name": "Forbidden [access to this endpoint is disabled]", "originalRequest": { "url": { "path": [ "addressbook", "group", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "recordsPerPage", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"Unauthorized access to Addressbook API!\",\n \"Unauthorized access to Addressbook API!\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcbbda49-0e9d-49b7-a7aa-0a5d3bd82d44", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "addressbook", "group", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "recordsPerPage", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "55bc5b06-ff3b-4311-8c50-209cede80611", "name": "Group: List Contacts", "request": { "name": "Group: List Contacts", "description": { "content": "Retrieve a list of contacts that belong to a specific group.", "type": "text/plain" }, "url": { "path": [ "addressbook", "group", ":GroupID", "contact", "list" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7c63ab3a-a2f6-4fb0-9d22-067a7cb53d37", "name": "OK", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID", "contact", "list" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"TotalRecords\": 1,\n \"RecordsPerPage\": 20,\n \"PageCount\": 1,\n \"Page\": 1,\n \"Group\": {\n \"GroupID\": {\n \"value\": \"\"\n },\n \"GroupCode\": {\n \"value\": \"\"\n },\n \"GroupName\": {\n \"value\": \"\"\n },\n \"SubAccount\": {\n \"value\": \"\"\n },\n \"Department\": {\n \"value\": \"\"\n },\n \"ViewEditBy\": {\n \"value\": \"\"\n },\n \"AccessControl\": {\n \"value\": \"\"\n },\n \"Owner\": {\n \"value\": \"\"\n },\n \"CreatedTimeLocal\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Timezone\": {\n \"value\": \"\"\n }\n },\n \"Contacts\": [\n {\n \"ContactID\": {\n \"value\": \"\"\n },\n \"Owner\": {\n \"value\": \"\"\n },\n \"CreatedTimeLocal\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"UpdatedTimeLocal\": {\n \"value\": \"\"\n },\n \"UpdatedTimeUTC\": {\n \"value\": \"\"\n },\n \"UpdatedTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Timezone\": {\n \"value\": \"\"\n }\n },\n {\n \"ContactID\": {\n \"value\": \"\"\n },\n \"Owner\": {\n \"value\": \"\"\n },\n \"CreatedTimeLocal\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"UpdatedTimeLocal\": {\n \"value\": \"\"\n },\n \"UpdatedTimeUTC\": {\n \"value\": \"\"\n },\n \"UpdatedTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Timezone\": {\n \"value\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c6c962c-90ec-4863-9b09-7cfd86be7526", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID", "contact", "list" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca60dde6-857f-472a-8024-4deea3f69bf6", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID", "contact", "list" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec3b778f-88bf-4019-af8a-33d16145136d", "name": "Forbidden [access to this endpoint is disabled]", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID", "contact", "list" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"Unauthorized access to Addressbook API!\",\n \"Unauthorized access to Addressbook API!\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff76bc31-a1b9-45a0-b6a0-632465541e7f", "name": "Not Found [record not found]", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID", "contact", "list" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"ErrorMessage\": [\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\",\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8162021f-4d0e-451a-9279-aec89863f856", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID", "contact", "list" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a66a2049-3267-48f8-84a2-d18b0ecd73f0", "name": "Group: Details", "request": { "name": "Group: Details", "description": { "content": "Retrieve the details of a specific group by its GroupID.", "type": "text/plain" }, "url": { "path": [ "addressbook", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "521c1235-e91d-47c9-a0ad-22dfab5240fe", "name": "OK", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"GroupID\": \"223e4567-e89b-12d3-a456-426614175000\",\n \"GroupCode\": \"My_Test_Group\",\n \"GroupName\": \"My Test Group\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"ViewEditBy\": \"ad laboris\",\n \"AccessControl\": \"Limited\",\n \"Owner\": \"COM\\\\DOMAIN\\\\APPLICATION\",\n \"CreatedTimeLocal\": \"2025-05-29 05:11:03\",\n \"CreatedTimeUTC\": \"2025-05-29 17:11:03\",\n \"CreatedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"Timezone\": \"New Zealand\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a001fdce-e5c3-47d6-a1a4-3e87df594074", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3b2d57c-073c-47b0-9bca-fde3dfde1e63", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "180e7d0e-2bfb-4e6d-b502-3d21cafdac74", "name": "Forbidden [access to this endpoint is disabled]", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"Unauthorized access to Addressbook API!\",\n \"Unauthorized access to Addressbook API!\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31537da1-f614-4795-b25f-affab40d0f09", "name": "Not Found [record not found]", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"ErrorMessage\": [\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\",\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f475497-21a4-4a57-ab4c-c34d2e39905f", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c48094bb-d2bf-4404-a210-ca4fa57b8417", "name": "Group: Update", "request": { "name": "Group: Update", "description": { "content": "Update the details of an existing group.", "type": "text/plain" }, "url": { "path": [ "addressbook", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"GroupName\": \"\",\n \"SubAccount\": \"\",\n \"Department\": \"\",\n \"ViewEditBy\": \"\",\n \"AccessControl\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "286fbb8c-d06b-4a85-b5ad-abd523f90a34", "name": "OK [group updated]", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"GroupName\": \"My Test Group\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"ViewEditBy\": \"id commodo\",\n \"AccessControl\": \"Limited\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"GroupID\": \"223e4567-e89b-12d3-a456-426614175000\",\n \"GroupCode\": \"My_Test_Group\",\n \"GroupName\": \"My Test Group\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"ViewEditBy\": \"ad laboris\",\n \"AccessControl\": \"Limited\",\n \"Owner\": \"COM\\\\DOMAIN\\\\APPLICATION\",\n \"CreatedTimeLocal\": \"2025-05-29 05:11:03\",\n \"CreatedTimeUTC\": \"2025-05-29 17:11:03\",\n \"CreatedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"Timezone\": \"New Zealand\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "415d18a4-21aa-4db4-a014-672d8bac4693", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"GroupName\": \"My Test Group\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"ViewEditBy\": \"id commodo\",\n \"AccessControl\": \"Limited\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d1d6933-e7a6-49ac-914b-bce7f4bdaf56", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"GroupName\": \"My Test Group\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"ViewEditBy\": \"id commodo\",\n \"AccessControl\": \"Limited\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50c3de84-78a1-4b26-8af6-e7cf97a6f47c", "name": "Forbidden [access to this endpoint is disabled]", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"GroupName\": \"My Test Group\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"ViewEditBy\": \"id commodo\",\n \"AccessControl\": \"Limited\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"Unauthorized access to Addressbook API!\",\n \"Unauthorized access to Addressbook API!\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07ef6069-8bbc-4920-8122-9eb5d3262739", "name": "Not Found [record not found]", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"GroupName\": \"My Test Group\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"ViewEditBy\": \"id commodo\",\n \"AccessControl\": \"Limited\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"ErrorMessage\": [\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\",\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a825a3cf-7840-49bd-a974-3d07f4963075", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"GroupName\": \"My Test Group\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"ViewEditBy\": \"id commodo\",\n \"AccessControl\": \"Limited\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cf0b96d-3bc5-4f2a-9299-a4e2a1893ee8", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"GroupName\": \"My Test Group\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"ViewEditBy\": \"id commodo\",\n \"AccessControl\": \"Limited\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cec105f8-2719-46b6-a5fd-03bc92299201", "name": "Group: Delete", "request": { "name": "Group: Delete", "description": { "content": "Delete a group from the address book.", "type": "text/plain" }, "url": { "path": [ "addressbook", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "dbc3f6ea-a1ff-4e09-b4df-383bffba3925", "name": "OK [group deleted]", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"GroupID\": \"223e4567-e89b-12d3-a456-426614175000\",\n \"GroupCode\": \"My_Test_Group\",\n \"GroupName\": \"My Test Group\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"ViewEditBy\": \"ad laboris\",\n \"AccessControl\": \"Limited\",\n \"Owner\": \"COM\\\\DOMAIN\\\\APPLICATION\",\n \"CreatedTimeLocal\": \"2025-05-29 05:11:03\",\n \"CreatedTimeUTC\": \"2025-05-29 17:11:03\",\n \"CreatedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"Timezone\": \"New Zealand\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc575ea7-02e8-4790-b750-5fcdec9ed9b0", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be632970-76c6-439d-bb5e-09af02fd14a4", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19354755-8555-4132-a58d-f3541a4f95ad", "name": "Forbidden [access to this endpoint is disabled]", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"Unauthorized access to Addressbook API!\",\n \"Unauthorized access to Addressbook API!\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a16fb25-65fd-4dee-af34-3c9982d00caa", "name": "Not Found [record not found]", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"ErrorMessage\": [\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\",\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "516f5fd3-c789-4342-a68d-bcf53a41b3e9", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "addressbook", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1593bd4d-7ca2-4c0b-afea-790c55d098e6", "name": "Contact: Add to Group", "request": { "name": "Contact: Add to Group", "description": { "content": "Add an existing contact to an existing group (add an association).", "type": "text/plain" }, "url": { "path": [ "addressbook", "contact", ":ContactID", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"GroupID\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cb5db2f7-e8a1-4ccd-b422-36e6484e7259", "name": "OK [contact added to group]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"GroupID\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Group\": {\n \"GroupID\": \"223e4567-e89b-12d3-a456-426614175000\",\n \"GroupCode\": \"My_Test_Group\",\n \"GroupName\": {\n \"value\": \"\"\n },\n \"SubAccount\": {\n \"value\": \"\"\n },\n \"Department\": {\n \"value\": \"\"\n },\n \"ViewEditBy\": {\n \"value\": \"\"\n },\n \"AccessControl\": {\n \"value\": \"\"\n },\n \"Owner\": \"COM\\\\DOMAIN\\\\APPLICATION\",\n \"CreatedTimeLocal\": \"2025-05-29 05:11:03\",\n \"CreatedTimeUTC\": \"2025-05-29 17:11:03\",\n \"CreatedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"Timezone\": \"New Zealand\"\n },\n \"Contact\": {\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"Owner\": \"COM\\\\DOMAIN\\\\APPLICATION\",\n \"CreatedTimeLocal\": \"2025-05-29 05:11:03\",\n \"CreatedTimeUTC\": \"2025-05-29 17:11:03\",\n \"CreatedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"UpdatedTimeLocal\": \"0001-01-01 12:00:00\",\n \"UpdatedTimeUTC\": \"0001-01-01 00:00:00\",\n \"UpdatedTimeUTC_RFC3339\": \"0001-01-01T00:00:00.000Z\",\n \"Timezone\": \"New Zealand\",\n \"ExType\": \"\",\n \"ExID\": \"\",\n \"ViewBy\": {\n \"value\": \"\"\n },\n \"EditBy\": {\n \"value\": \"\"\n },\n \"AccessControl\": {\n \"value\": \"\"\n },\n \"Attention\": {\n \"value\": \"\"\n },\n \"Title\": \"Mr\",\n \"Company\": \"Example Company\",\n \"RecipDepartment\": \"Accounting\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Position\": \"Accountant\",\n \"StreetAddress\": \"123 Queen Street\",\n \"Suburb\": \"Auckland City\",\n \"City\": \"Auckland\",\n \"State\": \"\",\n \"Country\": \"New Zealand\",\n \"Postcode\": \"1010\",\n \"MainPhone\": \"+6421002003\",\n \"AltPhone1\": \"+6495006001\",\n \"AltPhone2\": \"+6495006002\",\n \"AltPhone3\": \"+6495006003\",\n \"AltPhone4\": \"+6495006004\",\n \"AltPhone5\": \"\",\n \"AltPhone6\": \"\",\n \"AltPhone7\": \"\",\n \"AltPhone8\": \"\",\n \"MobilePhone\": \"+6421002003\",\n \"FaxNumber\": \"+64 9 500-5000\",\n \"EmailAddress\": \"john.doe@example.com\",\n \"WebAddress\": \"https://www.example.com\",\n \"Custom1\": \"Custom Value 1\",\n \"Custom2\": \"Custom Value 2\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"Notes\": \"This contact was created using the Address Book API.\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed8896f9-612b-4f68-a9ca-858bbfa34abb", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"GroupID\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4e7e4bd-fe9b-4e8c-af4e-d2facccbb964", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"GroupID\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ce2815f-e50c-4ac3-8b65-47902085eef0", "name": "Forbidden [access to this endpoint is disabled]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"GroupID\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"Unauthorized access to Addressbook API!\",\n \"Unauthorized access to Addressbook API!\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60de24df-6851-4de2-9c9f-f30b8cb814b6", "name": "Not Found [record not found]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"GroupID\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"ErrorMessage\": [\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\",\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "412f3a7f-217a-4a0b-a376-a67a299fe614", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"GroupID\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8531719-17da-4920-a5af-f7bbde40cfe6", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID", "group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"GroupID\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b8ecf288-5dbc-4a11-9f60-ab012ef6249b", "name": "Contact: Remove from Group", "request": { "name": "Contact: Remove from Group", "description": { "content": "Remove an existing contact from an existing group (remove/delete an association).", "type": "text/plain" }, "url": { "path": [ "addressbook", "contact", ":ContactID", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." }, { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ac780f13-4575-4795-8681-c50365547f4b", "name": "OK [contact removed from group]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." }, { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Group\": {\n \"GroupID\": \"223e4567-e89b-12d3-a456-426614175000\",\n \"GroupCode\": \"My_Test_Group\",\n \"GroupName\": {\n \"value\": \"\"\n },\n \"SubAccount\": {\n \"value\": \"\"\n },\n \"Department\": {\n \"value\": \"\"\n },\n \"ViewEditBy\": {\n \"value\": \"\"\n },\n \"AccessControl\": {\n \"value\": \"\"\n },\n \"Owner\": \"COM\\\\DOMAIN\\\\APPLICATION\",\n \"CreatedTimeLocal\": \"2025-05-29 05:11:03\",\n \"CreatedTimeUTC\": \"2025-05-29 17:11:03\",\n \"CreatedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"Timezone\": \"New Zealand\"\n },\n \"Contact\": {\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"Owner\": \"COM\\\\DOMAIN\\\\APPLICATION\",\n \"CreatedTimeLocal\": \"2025-05-29 05:11:03\",\n \"CreatedTimeUTC\": \"2025-05-29 17:11:03\",\n \"CreatedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"UpdatedTimeLocal\": \"0001-01-01 12:00:00\",\n \"UpdatedTimeUTC\": \"0001-01-01 00:00:00\",\n \"UpdatedTimeUTC_RFC3339\": \"0001-01-01T00:00:00.000Z\",\n \"Timezone\": \"New Zealand\",\n \"ExType\": \"\",\n \"ExID\": \"\",\n \"ViewBy\": {\n \"value\": \"\"\n },\n \"EditBy\": {\n \"value\": \"\"\n },\n \"AccessControl\": {\n \"value\": \"\"\n },\n \"Attention\": {\n \"value\": \"\"\n },\n \"Title\": \"Mr\",\n \"Company\": \"Example Company\",\n \"RecipDepartment\": \"Accounting\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Position\": \"Accountant\",\n \"StreetAddress\": \"123 Queen Street\",\n \"Suburb\": \"Auckland City\",\n \"City\": \"Auckland\",\n \"State\": \"\",\n \"Country\": \"New Zealand\",\n \"Postcode\": \"1010\",\n \"MainPhone\": \"+6421002003\",\n \"AltPhone1\": \"+6495006001\",\n \"AltPhone2\": \"+6495006002\",\n \"AltPhone3\": \"+6495006003\",\n \"AltPhone4\": \"+6495006004\",\n \"AltPhone5\": \"\",\n \"AltPhone6\": \"\",\n \"AltPhone7\": \"\",\n \"AltPhone8\": \"\",\n \"MobilePhone\": \"+6421002003\",\n \"FaxNumber\": \"+64 9 500-5000\",\n \"EmailAddress\": \"john.doe@example.com\",\n \"WebAddress\": \"https://www.example.com\",\n \"Custom1\": \"Custom Value 1\",\n \"Custom2\": \"Custom Value 2\",\n \"Custom3\": \"\",\n \"Custom4\": \"\",\n \"Notes\": \"This contact was created using the Address Book API.\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48d7627d-9306-4d71-bccc-12c3310d9864", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." }, { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48cf46f3-2cee-4533-81c0-b552d79794cc", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." }, { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "848678b2-830d-4733-87bf-3b5c904c5250", "name": "Forbidden [access to this endpoint is disabled]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." }, { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"Unauthorized access to Addressbook API!\",\n \"Unauthorized access to Addressbook API!\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6728ddcc-6769-4f17-a5a4-ff6b53584e6a", "name": "Not Found [record not found]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." }, { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"RecordNotFound\",\n \"ErrorMessage\": [\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\",\n \"Unable to find or access record with id '0eee9801-098e-fc70-86b3-ae5a4s550992d'.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2c96010-9623-4550-82f7-91af7ffd0b07", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "addressbook", "contact", ":ContactID", "group", ":GroupID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ContactID", "description": "(Required) Unique identifier for the Address Book Contact." }, { "disabled": false, "type": "any", "value": "", "key": "GroupID", "description": "(Required) Unique identifier for the Address Book Group." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "12024fc9-e4d3-4b02-9579-67c5358a5611", "name": "OptOut", "description": { "content": "The Opt-Out API allows you to programmatically manage contacts who have unsubscribed.\n\nOpt-Out API gives you the flexibility to manage unsubscribes on a SubAccount, Department and Message Type basis. This means a user can opt out of SMS marketing while still receiving important Email alerts.\n\n![Opt-Outs](https://www.tnz.co.nz/docs/restapi/assets/images/Mobile1[128x75].png)\n\nWhen you attempt to send a message, the API will accept the request, but if the recipient is on the opt-out list for that channel, the delivery will be blocked and return a \"Destination is blacklisted\" result. This provides a clear audit trail and protects your brand from sending unwanted communications.\n\nKey features of this endpoint set include:\n\n* Add or remove individual contacts from your opt-out list in real-time.\n* Once added, a contact is automatically suppressed for the applicable message type.\n* Each message type is managed independently, giving you full control.\n* Retrieve a complete list of all opted-out contacts for auditing, reporting, or synchronizing with your own CRM.\n* Effortlessly manage unsubscribes to help meet your obligations under anti-spam regulations.\n", "type": "text/plain" }, "item": [ { "id": "0cf27f0b-a2ff-4bf8-9cb4-0c8c42c14744", "name": "List OptOuts", "request": { "name": "List OptOuts", "description": { "content": "List all opt-out entries.\n\n> [!CAUTION]\n> Limit your polls to 1 per second to avoid rate limits.", "type": "text/plain" }, "url": { "path": [ "optout", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "timePeriod", "value": "", "description": "Return results that were Created in the past _x_ days." }, { "disabled": false, "key": "destType", "value": "", "description": "Return results matching the DestType. You may specify just one DestType." }, { "disabled": false, "key": "contactID", "value": "", "description": "Return results matching the given ContactID." }, { "disabled": false, "key": "recordsPerPage", "value": "", "description": "Number of records to return per page (default is 100, maximum is 1000)." }, { "disabled": false, "key": "page", "value": "1", "description": "Page number to retrieve." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "95234605-e748-4a41-8c75-ecd6019b33ba", "name": "OK", "originalRequest": { "url": { "path": [ "optout", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "timePeriod", "value": "5" }, { "key": "destType", "value": "SMS" }, { "key": "contactID", "value": "" }, { "key": "recordsPerPage", "value": "100" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"TotalRecords\": 1,\n \"RecordsPerPage\": 20,\n \"PageCount\": 1,\n \"Page\": 1,\n \"OptOuts\": [\n {\n \"ID\": {\n \"value\": \"\"\n },\n \"OriginalMessage\": {\n \"value\": \"\"\n },\n \"CreatedTimeLocal\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"UpdatedTimeLocal\": {\n \"value\": \"\"\n },\n \"UpdatedTimeUTC\": {\n \"value\": \"\"\n },\n \"UpdatedTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Timezone\": {\n \"value\": \"\"\n }\n },\n {\n \"ID\": {\n \"value\": \"\"\n },\n \"OriginalMessage\": {\n \"value\": \"\"\n },\n \"CreatedTimeLocal\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC\": {\n \"value\": \"\"\n },\n \"CreatedTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"UpdatedTimeLocal\": {\n \"value\": \"\"\n },\n \"UpdatedTimeUTC\": {\n \"value\": \"\"\n },\n \"UpdatedTimeUTC_RFC3339\": {\n \"value\": \"\"\n },\n \"Timezone\": {\n \"value\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78f0f9cf-1f35-413c-8157-6a1f647fd237", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "optout", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "timePeriod", "value": "5" }, { "key": "destType", "value": "SMS" }, { "key": "contactID", "value": "" }, { "key": "recordsPerPage", "value": "100" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e388903-a975-475f-9a17-93e3346c69a5", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "optout", "list" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "timePeriod", "value": "5" }, { "key": "destType", "value": "SMS" }, { "key": "contactID", "value": "" }, { "key": "recordsPerPage", "value": "100" }, { "key": "page", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "da1d9211-6bc0-4b3a-9885-f87c2ac9cdc2", "name": "OptOut: Create", "request": { "name": "OptOut: Create", "description": { "content": "Create a new entry in the OptOut List.", "type": "text/plain" }, "url": { "path": [ "optout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"DestType\": \"\",\n \"Destination\": \"\",\n \"ContactID\": \"\",\n \"SubAccount\": \"\",\n \"Department\": \"\",\n \"StopMessage\": \"\",\n \"Notes\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1d5c6c72-9c00-4510-b219-9351308d49db", "name": "OK [entry created]", "originalRequest": { "url": { "path": [ "optout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DestType\": \"SMS\",\n \"Destination\": \"+6421003004\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Team Alpha\",\n \"StopMessage\": \"Stop sending me these messages\",\n \"Notes\": \"Entry edited using the API.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"DestType\": \"SMS\",\n \"ID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"Destination\": \"+6421003004\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Team Alpha\",\n \"StopMessage\": \"Stop sending me these messages\",\n \"Notes\": \"Entry edited using the API.\",\n \"OriginalMessage\": \"Hello John, thanks for being a valued customer. Here's a free discount code for your next purchase - 10OFF. From My Company Ltd. Reply STOP to OptOut.\",\n \"CreatedTimeLocal\": \"2025-05-29 05:11:03\",\n \"CreatedTimeUTC\": \"2025-05-29 17:11:03\",\n \"CreatedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"UpdatedTimeLocal\": \"0001-01-01 12:00:00\",\n \"UpdatedTimeUTC\": \"0001-01-01 00:00:00\",\n \"UpdatedTimeUTC_RFC3339\": \"0001-01-01T00:00:00.000Z\",\n \"Timezone\": \"New Zealand\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e84e81dd-ecb5-436f-b541-fe540774fc07", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "optout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DestType\": \"SMS\",\n \"Destination\": \"+6421003004\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Team Alpha\",\n \"StopMessage\": \"Stop sending me these messages\",\n \"Notes\": \"Entry edited using the API.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76e1e704-a315-4b46-ab60-5fe78f587fae", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "optout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DestType\": \"SMS\",\n \"Destination\": \"+6421003004\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Team Alpha\",\n \"StopMessage\": \"Stop sending me these messages\",\n \"Notes\": \"Entry edited using the API.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a7b77e9-0137-4288-9c91-5a518dc09e54", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "optout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DestType\": \"SMS\",\n \"Destination\": \"+6421003004\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Team Alpha\",\n \"StopMessage\": \"Stop sending me these messages\",\n \"Notes\": \"Entry edited using the API.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc7f9a6d-02c7-462f-aa6d-df257260a2c2", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "optout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DestType\": \"SMS\",\n \"Destination\": \"+6421003004\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Team Alpha\",\n \"StopMessage\": \"Stop sending me these messages\",\n \"Notes\": \"Entry edited using the API.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0ae9e699-68da-4100-9c5d-4e5823bb96d6", "name": "Create OptOuts (Batch)", "request": { "name": "Create OptOuts (Batch)", "description": { "content": "Create multiple entries in the OptOut List.\n\nYou may list multiple `DestType` values, for example: \"SMS, Email\"\n\nYou may list `Destination`, `Destinations`, `ContactID` and `ContactIDs` in a single request.", "type": "text/plain" }, "url": { "path": [ "optout", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"DestType\": \"\",\n \"Destination\": \"\",\n \"Destinations\": [\n \"\",\n \"\"\n ],\n \"ContactID\": \"\",\n \"ContactIDs\": [\n \"\",\n \"\"\n ],\n \"SubAccount\": \"\",\n \"Department\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8349c1cb-daae-4ad7-9801-7967262718cf", "name": "OK [entry created]", "originalRequest": { "url": { "path": [ "optout", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DestType\": \"SMS\",\n \"Destination\": \"+6421003004\",\n \"Destinations\": [\n \"+6421003004\",\n \"+6421003004\"\n ],\n \"ContactID\": \"6000000b-f002-4007-b00a-c00000000001\",\n \"ContactIDs\": [\n \"6000000b-f002-4007-b00a-c00000000001\",\n \"6000000b-f002-4007-b00a-c00000000001\"\n ],\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Team Alpha\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"DestType\": \"SMS\",\n \"ID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"Destination\": \"+6421003004\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Team Alpha\",\n \"StopMessage\": \"Stop sending me these messages\",\n \"Notes\": \"Entry edited using the API.\",\n \"OriginalMessage\": \"Hello John, thanks for being a valued customer. Here's a free discount code for your next purchase - 10OFF. From My Company Ltd. Reply STOP to OptOut.\",\n \"CreatedTimeLocal\": \"2025-05-29 05:11:03\",\n \"CreatedTimeUTC\": \"2025-05-29 17:11:03\",\n \"CreatedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"UpdatedTimeLocal\": \"0001-01-01 12:00:00\",\n \"UpdatedTimeUTC\": \"0001-01-01 00:00:00\",\n \"UpdatedTimeUTC_RFC3339\": \"0001-01-01T00:00:00.000Z\",\n \"Timezone\": \"New Zealand\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b65cb239-7433-45f3-b463-b29fa6de1577", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "optout", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DestType\": \"SMS\",\n \"Destination\": \"+6421003004\",\n \"Destinations\": [\n \"+6421003004\",\n \"+6421003004\"\n ],\n \"ContactID\": \"6000000b-f002-4007-b00a-c00000000001\",\n \"ContactIDs\": [\n \"6000000b-f002-4007-b00a-c00000000001\",\n \"6000000b-f002-4007-b00a-c00000000001\"\n ],\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Team Alpha\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d94c0a3-eb24-4332-a29b-58f85a7f72c4", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "optout", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DestType\": \"SMS\",\n \"Destination\": \"+6421003004\",\n \"Destinations\": [\n \"+6421003004\",\n \"+6421003004\"\n ],\n \"ContactID\": \"6000000b-f002-4007-b00a-c00000000001\",\n \"ContactIDs\": [\n \"6000000b-f002-4007-b00a-c00000000001\",\n \"6000000b-f002-4007-b00a-c00000000001\"\n ],\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Team Alpha\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6e4915c-fb0d-4211-80b1-6235c06a3f93", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "optout", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DestType\": \"SMS\",\n \"Destination\": \"+6421003004\",\n \"Destinations\": [\n \"+6421003004\",\n \"+6421003004\"\n ],\n \"ContactID\": \"6000000b-f002-4007-b00a-c00000000001\",\n \"ContactIDs\": [\n \"6000000b-f002-4007-b00a-c00000000001\",\n \"6000000b-f002-4007-b00a-c00000000001\"\n ],\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Team Alpha\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95d71cdd-6756-4cdb-860f-2129ad52cb0d", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "optout", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DestType\": \"SMS\",\n \"Destination\": \"+6421003004\",\n \"Destinations\": [\n \"+6421003004\",\n \"+6421003004\"\n ],\n \"ContactID\": \"6000000b-f002-4007-b00a-c00000000001\",\n \"ContactIDs\": [\n \"6000000b-f002-4007-b00a-c00000000001\",\n \"6000000b-f002-4007-b00a-c00000000001\"\n ],\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Team Alpha\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "746db66b-8f89-4563-bb9c-4f3211acbd09", "name": "OptOut: Details", "request": { "name": "OptOut: Details", "description": { "content": "Retrieve the details of a specific opt-out entry by its ID.", "type": "text/plain" }, "url": { "path": [ "optout", ":OptOutID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "OptOutID", "description": "(Required) Unique identifier for the Opt Out entry." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bdab3795-fd18-4b69-a3ce-32c1f8e7006c", "name": "OK", "originalRequest": { "url": { "path": [ "optout", ":OptOutID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "OptOutID", "description": "(Required) Unique identifier for the Opt Out entry." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"DestType\": \"SMS\",\n \"ID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"Destination\": \"+6421003004\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Team Alpha\",\n \"StopMessage\": \"Stop sending me these messages\",\n \"Notes\": \"Entry edited using the API.\",\n \"OriginalMessage\": \"Hello John, thanks for being a valued customer. Here's a free discount code for your next purchase - 10OFF. From My Company Ltd. Reply STOP to OptOut.\",\n \"CreatedTimeLocal\": \"2025-05-29 05:11:03\",\n \"CreatedTimeUTC\": \"2025-05-29 17:11:03\",\n \"CreatedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"UpdatedTimeLocal\": \"0001-01-01 12:00:00\",\n \"UpdatedTimeUTC\": \"0001-01-01 00:00:00\",\n \"UpdatedTimeUTC_RFC3339\": \"0001-01-01T00:00:00.000Z\",\n \"Timezone\": \"New Zealand\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8ed1646-9798-489f-88c2-f5da9b1fa050", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "optout", ":OptOutID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "OptOutID", "description": "(Required) Unique identifier for the Opt Out entry." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80d4bdf9-2016-4b45-8fb5-35824f1382f8", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "optout", ":OptOutID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "OptOutID", "description": "(Required) Unique identifier for the Opt Out entry." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c244c4b-0904-43c6-80d5-2b93b97ca477", "name": "Not Found [invalid ID or resource not yet processed]", "originalRequest": { "url": { "path": [ "optout", ":OptOutID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "OptOutID", "description": "(Required) Unique identifier for the Opt Out entry." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ErrorMessage\": [\n \"Unable to find or access the data you're looking for.\",\n \"Unable to find or access the data you're looking for.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c3a7770b-7a34-4780-b819-17d4a9a831d5", "name": "Update OptOut", "request": { "name": "Update OptOut", "description": { "content": "Edit an existing OptOut entry.\n", "type": "text/plain" }, "url": { "path": [ "optout", ":OptOutID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "OptOutID", "description": "(Required) Unique identifier for the Opt Out entry." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"DestType\": \"\",\n \"Destination\": \"\",\n \"ContactID\": \"\",\n \"SubAccount\": \"\",\n \"Department\": \"\",\n \"StopMessage\": \"\",\n \"Notes\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "74f2c59e-2de9-46e9-8092-1c594b3034ed", "name": "Entry updated.", "originalRequest": { "url": { "path": [ "optout", ":OptOutID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "OptOutID", "description": "(Required) Unique identifier for the Opt Out entry." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"DestType\": \"SMS\",\n \"Destination\": \"+6421003004\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Team Alpha\",\n \"StopMessage\": \"Stop sending me these messages\",\n \"Notes\": \"Entry edited using the API.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"DestType\": \"SMS\",\n \"ID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"Destination\": \"+6421003004\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Team Alpha\",\n \"StopMessage\": \"Stop sending me these messages\",\n \"Notes\": \"Entry edited using the API.\",\n \"OriginalMessage\": \"Hello John, thanks for being a valued customer. Here's a free discount code for your next purchase - 10OFF. From My Company Ltd. Reply STOP to OptOut.\",\n \"CreatedTimeLocal\": \"2025-05-29 05:11:03\",\n \"CreatedTimeUTC\": \"2025-05-29 17:11:03\",\n \"CreatedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"UpdatedTimeLocal\": \"0001-01-01 12:00:00\",\n \"UpdatedTimeUTC\": \"0001-01-01 00:00:00\",\n \"UpdatedTimeUTC_RFC3339\": \"0001-01-01T00:00:00.000Z\",\n \"Timezone\": \"New Zealand\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37c09ef3-8de2-4fa6-9d65-24897e5dfc75", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "optout", ":OptOutID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "OptOutID", "description": "(Required) Unique identifier for the Opt Out entry." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"DestType\": \"SMS\",\n \"Destination\": \"+6421003004\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Team Alpha\",\n \"StopMessage\": \"Stop sending me these messages\",\n \"Notes\": \"Entry edited using the API.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c615f23-c72d-4a3f-84e7-7115b4622ae3", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "optout", ":OptOutID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "OptOutID", "description": "(Required) Unique identifier for the Opt Out entry." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"DestType\": \"SMS\",\n \"Destination\": \"+6421003004\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Team Alpha\",\n \"StopMessage\": \"Stop sending me these messages\",\n \"Notes\": \"Entry edited using the API.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffad5dff-77a5-4c56-bb15-638c64f8a2f3", "name": "Not Found [invalid ID or resource not yet processed]", "originalRequest": { "url": { "path": [ "optout", ":OptOutID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "OptOutID", "description": "(Required) Unique identifier for the Opt Out entry." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"DestType\": \"SMS\",\n \"Destination\": \"+6421003004\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Team Alpha\",\n \"StopMessage\": \"Stop sending me these messages\",\n \"Notes\": \"Entry edited using the API.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ErrorMessage\": [\n \"Unable to find or access the data you're looking for.\",\n \"Unable to find or access the data you're looking for.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee3f3c4a-45d2-4541-affc-722c0f8d70ad", "name": "Unsupported Media Type [the content-type header is incorrect]", "originalRequest": { "url": { "path": [ "optout", ":OptOutID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "OptOutID", "description": "(Required) Unique identifier for the Opt Out entry." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"DestType\": \"SMS\",\n \"Destination\": \"+6421003004\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Team Alpha\",\n \"StopMessage\": \"Stop sending me these messages\",\n \"Notes\": \"Entry edited using the API.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 415,\n \"extend1\": \"info1\",\n \"extend2\": \"info2\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e01dc7b7-7bd5-4ef1-b131-f44f4db3647d", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "optout", ":OptOutID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "OptOutID", "description": "(Required) Unique identifier for the Opt Out entry." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"DestType\": \"SMS\",\n \"Destination\": \"+6421003004\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Team Alpha\",\n \"StopMessage\": \"Stop sending me these messages\",\n \"Notes\": \"Entry edited using the API.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a809e92f-498a-4d98-9f1c-6952c90c6d98", "name": "Delete OptOut", "request": { "name": "Delete OptOut", "description": { "content": "Delete an existing OptOut entry.\n", "type": "text/plain" }, "url": { "path": [ "optout", ":OptOutID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "OptOutID", "description": "(Required) Unique identifier for the Opt Out entry." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "74a43330-b98c-4e32-a5cf-37c30c7dee2a", "name": "OK [entry deleted]", "originalRequest": { "url": { "path": [ "optout", ":OptOutID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "OptOutID", "description": "(Required) Unique identifier for the Opt Out entry." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"DestType\": \"SMS\",\n \"ID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"Destination\": \"+6421003004\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Team Alpha\",\n \"StopMessage\": \"Stop sending me these messages\",\n \"Notes\": \"Entry edited using the API.\",\n \"OriginalMessage\": \"Hello John, thanks for being a valued customer. Here's a free discount code for your next purchase - 10OFF. From My Company Ltd. Reply STOP to OptOut.\",\n \"CreatedTimeLocal\": \"2025-05-29 05:11:03\",\n \"CreatedTimeUTC\": \"2025-05-29 17:11:03\",\n \"CreatedTimeUTC_RFC3339\": \"2025-05-29T17:11:03.000Z\",\n \"UpdatedTimeLocal\": \"0001-01-01 12:00:00\",\n \"UpdatedTimeUTC\": \"0001-01-01 00:00:00\",\n \"UpdatedTimeUTC_RFC3339\": \"0001-01-01T00:00:00.000Z\",\n \"Timezone\": \"New Zealand\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a602fab2-d621-4e18-95f8-9627bc8979f2", "name": "Bad Request [data incorrect]", "originalRequest": { "url": { "path": [ "optout", ":OptOutID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "OptOutID", "description": "(Required) Unique identifier for the Opt Out entry." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": \"Missing or empty field\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cd09730-c2b4-4288-b811-1db29346d631", "name": "Unauthorized [auth token is invalid]", "originalRequest": { "url": { "path": [ "optout", ":OptOutID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "OptOutID", "description": "(Required) Unique identifier for the Opt Out entry." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Unauthorized\",\n \"ErrorMessage\": \"Access denied: Auth Token or credentials are incorrect or have expired.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33ff5c40-491e-4c74-ab2b-331a83522ef8", "name": "Not Found [invalid ID or resource not yet processed]", "originalRequest": { "url": { "path": [ "optout", ":OptOutID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "OptOutID", "description": "(Required) Unique identifier for the Opt Out entry." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ErrorMessage\": [\n \"Unable to find or access the data you're looking for.\",\n \"Unable to find or access the data you're looking for.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7990d808-0670-421f-b389-9f0f2ea20ff1", "name": "Server Error [contact us]", "originalRequest": { "url": { "path": [ "optout", ":OptOutID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "OptOutID", "description": "(Required) Unique identifier for the Opt Out entry." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The media type that is acceptable for the response.", "key": "Accept", "value": "application/json; encoding=\"UTF-8\"" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Result\": \"Failed\",\n \"ErrorMessage\": [\n \"An unexpected error occurred while processing.\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "1faf41eb-0b53-48d0-a4ce-ef411ca4cd2b", "name": "Partner API", "description": { "content": "Empower your wholesale and partner accounts with direct user management capabilities. This restricted set of endpoints is designed for partners to manage their sub-accounts and user details, providing an automated way to handle account administration.\n\n![Partner API](https://www.tnz.co.nz/docs/restapi/assets/images/Integrations[128x75].png)\n", "type": "text/plain" }, "item": [], "event": [] }, { "id": "129fc723-ba3f-4c29-9bc2-c375617a94b6", "name": "Webhooks", "item": [ { "id": "143ea9ba-2e33-4ac3-9832-074cff972ac1", "name": "Webhook - Send Result", "request": { "name": "Webhook - Send Result", "description": { "content": "This webhook is sent to your server when a message completes sending. It contains detailed information about the delivery Status, Result, and other metadata.\n\nTo set up this webhook, configure your Sender settings in the TNZ Dashboard (Users > API > Reporting).\n", "type": "text/plain" }, "url": { "host": [ "{{ResultWebhook}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) The RFC3339 timestamp of the request.", "key": "X-Timestamp", "value": "" }, { "disabled": false, "description": "(Required) The email address of the sender.", "key": "X-Sender", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Version\": \"\",\n \"Sender\": \"\",\n \"APIKey\": \"\",\n \"Type\": \"\",\n \"Destination\": \"\",\n \"ContactID\": \"\",\n \"ReceivedID\": \"\",\n \"MessageID\": \"\",\n \"SubAccount\": \"\",\n \"Department\": \"\",\n \"JobNumber\": \"\",\n \"SentTimeLocal\": \"\",\n \"SendTimeUTC\": \"\",\n \"SentTimeUTC_RFC3339\": \"\",\n \"Status\": \"\",\n \"Result\": \"\",\n \"Message\": \"\",\n \"Price\": \"\",\n \"Detail\": \"\",\n \"URL\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2322f162-bcc5-4b9f-a63e-eb2b01fb575f", "name": "Success [your server acknowledged the webhook]", "originalRequest": { "url": { "host": [ "{{ResultWebhook}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The RFC3339 timestamp of the request.", "key": "X-Timestamp", "value": "2025-06-03T21:16:55.000Z" }, { "disabled": false, "description": "(Required) The email address of the sender.", "key": "X-Sender", "value": "application@domain.com" }, { "disabled": false, "description": "(Required) The sender JWT Auth Token.", "key": "Authorization", "value": "Basic ey...01" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Version\": \"v3.00\",\n \"Sender\": \"application@domain.com\",\n \"APIKey\": \"ta8wr7ymd\",\n \"Type\": \"SMS\",\n \"Destination\": \"+6421000001\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"ReceivedID\": \"minim consectetur\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"JobNumber\": \"10AB20CE\",\n \"SentTimeLocal\": \"2025-06-13 08:44:16\",\n \"SendTimeUTC\": \"2025-06-12 20:44:16\",\n \"SentTimeUTC_RFC3339\": \"2025-06-12T20:44:16.000Z\",\n \"Status\": \"Success\",\n \"Result\": \"delivered\",\n \"Message\": \"officia in elit Lorem Excep\",\n \"Price\": \"lab\",\n \"Detail\": \"SMSParts:2\",\n \"URL\": \"https://www.example.com/data\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1830fe7f-2895-4535-94a5-dab6050627d7", "name": "Failed [your server rejected the webhook (retried every 5 min for 24 hours)]", "originalRequest": { "url": { "host": [ "{{ResultWebhook}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The RFC3339 timestamp of the request.", "key": "X-Timestamp", "value": "2025-06-03T21:16:55.000Z" }, { "disabled": false, "description": "(Required) The email address of the sender.", "key": "X-Sender", "value": "application@domain.com" }, { "disabled": false, "description": "(Required) The sender JWT Auth Token.", "key": "Authorization", "value": "Basic ey...01" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Version\": \"v3.00\",\n \"Sender\": \"application@domain.com\",\n \"APIKey\": \"ta8wr7ymd\",\n \"Type\": \"SMS\",\n \"Destination\": \"+6421000001\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"ReceivedID\": \"minim consectetur\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"JobNumber\": \"10AB20CE\",\n \"SentTimeLocal\": \"2025-06-13 08:44:16\",\n \"SendTimeUTC\": \"2025-06-12 20:44:16\",\n \"SentTimeUTC_RFC3339\": \"2025-06-12T20:44:16.000Z\",\n \"Status\": \"Success\",\n \"Result\": \"delivered\",\n \"Message\": \"officia in elit Lorem Excep\",\n \"Price\": \"lab\",\n \"Detail\": \"SMSParts:2\",\n \"URL\": \"https://www.example.com/data\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7ba12800-4795-4884-9fe2-e507dc6ac3b4", "name": "Failed [your server rejected the webhook (retried every 5 min for 24 hours)]", "originalRequest": { "url": { "host": [ "{{ResultWebhook}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The RFC3339 timestamp of the request.", "key": "X-Timestamp", "value": "2025-06-03T21:16:55.000Z" }, { "disabled": false, "description": "(Required) The email address of the sender.", "key": "X-Sender", "value": "application@domain.com" }, { "disabled": false, "description": "(Required) The sender JWT Auth Token.", "key": "Authorization", "value": "Basic ey...01" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Version\": \"v3.00\",\n \"Sender\": \"application@domain.com\",\n \"APIKey\": \"ta8wr7ymd\",\n \"Type\": \"SMS\",\n \"Destination\": \"+6421000001\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"ReceivedID\": \"minim consectetur\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"JobNumber\": \"10AB20CE\",\n \"SentTimeLocal\": \"2025-06-13 08:44:16\",\n \"SendTimeUTC\": \"2025-06-12 20:44:16\",\n \"SentTimeUTC_RFC3339\": \"2025-06-12T20:44:16.000Z\",\n \"Status\": \"Success\",\n \"Result\": \"delivered\",\n \"Message\": \"officia in elit Lorem Excep\",\n \"Price\": \"lab\",\n \"Detail\": \"SMSParts:2\",\n \"URL\": \"https://www.example.com/data\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c7869341-1171-46c0-9b96-495b9020fb2e", "name": "Webhook - Inbound SMS", "request": { "name": "Webhook - Inbound SMS", "description": { "content": "This webhook is sent to your server when an Inbound SMS message is received.\n\nThe MessageID parameter refers to a matched outbound message (if one is found).\n\nTo set up this webhook, configure your Sender settings in the TNZ Dashboard (Users > API > Reporting).\n", "type": "text/plain" }, "url": { "host": [ "{{InboundSMSWebhook}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(Required) The RFC3339 timestamp of the request.", "key": "X-Timestamp", "value": "" }, { "disabled": false, "description": "(Required) The email address of the sender.", "key": "X-Sender", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Version\": \"\",\n \"Sender\": \"\",\n \"APIKey\": \"\",\n \"Type\": \"\",\n \"Destination\": \"\",\n \"ContactID\": \"\",\n \"ReceivedID\": \"\",\n \"MessageID\": \"\",\n \"SubAccount\": \"\",\n \"Department\": \"\",\n \"JobNumber\": \"\",\n \"SentTimeLocal\": \"\",\n \"SendTimeUTC\": \"\",\n \"SentTimeUTC_RFC3339\": \"\",\n \"Status\": \"\",\n \"Result\": \"\",\n \"Message\": \"\",\n \"Price\": \"\",\n \"Detail\": \"\",\n \"URL\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "86c5e7ee-10d2-4987-ad93-7210c4ead3a5", "name": "Success [your server acknowledged the webhook]", "originalRequest": { "url": { "host": [ "{{InboundSMSWebhook}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The RFC3339 timestamp of the request.", "key": "X-Timestamp", "value": "2025-06-03T21:16:55.000Z" }, { "disabled": false, "description": "(Required) The email address of the sender.", "key": "X-Sender", "value": "application@domain.com" }, { "disabled": false, "description": "(Required) The sender JWT Auth Token.", "key": "Authorization", "value": "Basic ey...01" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Version\": \"v3.00\",\n \"Sender\": \"application@domain.com\",\n \"APIKey\": \"ta8wr7ymd\",\n \"Type\": \"SMSReply\",\n \"Destination\": \"+6421000001\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"ReceivedID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"JobNumber\": \"10AB20CE\",\n \"SentTimeLocal\": \"2025-06-13 08:44:16\",\n \"SendTimeUTC\": \"2025-06-12 20:44:16\",\n \"SentTimeUTC_RFC3339\": \"2025-06-12T20:44:16.000Z\",\n \"Status\": \"RECEIVED\",\n \"Result\": \"RECEIVED\",\n \"Message\": \"This is a received message from a mobile phone.\",\n \"Price\": \"e\",\n \"Detail\": \"InputToNumber:021-777909\",\n \"URL\": \"https://www.example.com/data\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e29f8e74-92c7-4faf-8c06-92adde4a9904", "name": "Failed [your server rejected the webhook (retried every 5 min for 24 hours)]", "originalRequest": { "url": { "host": [ "{{InboundSMSWebhook}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The RFC3339 timestamp of the request.", "key": "X-Timestamp", "value": "2025-06-03T21:16:55.000Z" }, { "disabled": false, "description": "(Required) The email address of the sender.", "key": "X-Sender", "value": "application@domain.com" }, { "disabled": false, "description": "(Required) The sender JWT Auth Token.", "key": "Authorization", "value": "Basic ey...01" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Version\": \"v3.00\",\n \"Sender\": \"application@domain.com\",\n \"APIKey\": \"ta8wr7ymd\",\n \"Type\": \"SMSReply\",\n \"Destination\": \"+6421000001\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"ReceivedID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"JobNumber\": \"10AB20CE\",\n \"SentTimeLocal\": \"2025-06-13 08:44:16\",\n \"SendTimeUTC\": \"2025-06-12 20:44:16\",\n \"SentTimeUTC_RFC3339\": \"2025-06-12T20:44:16.000Z\",\n \"Status\": \"RECEIVED\",\n \"Result\": \"RECEIVED\",\n \"Message\": \"This is a received message from a mobile phone.\",\n \"Price\": \"e\",\n \"Detail\": \"InputToNumber:021-777909\",\n \"URL\": \"https://www.example.com/data\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1534f548-d319-422c-896f-a6b11665d6dd", "name": "Failed [your server rejected the webhook (retried every 5 min for 24 hours)]", "originalRequest": { "url": { "host": [ "{{InboundSMSWebhook}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "(Required) The RFC3339 timestamp of the request.", "key": "X-Timestamp", "value": "2025-06-03T21:16:55.000Z" }, { "disabled": false, "description": "(Required) The email address of the sender.", "key": "X-Sender", "value": "application@domain.com" }, { "disabled": false, "description": "(Required) The sender JWT Auth Token.", "key": "Authorization", "value": "Basic ey...01" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Version\": \"v3.00\",\n \"Sender\": \"application@domain.com\",\n \"APIKey\": \"ta8wr7ymd\",\n \"Type\": \"SMSReply\",\n \"Destination\": \"+6421000001\",\n \"ContactID\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"ReceivedID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"MessageID\": \"a1b2c3d4-e5f6-7890-1234-567890abcdee\",\n \"SubAccount\": \"Business Unit One\",\n \"Department\": \"Department Alpha\",\n \"JobNumber\": \"10AB20CE\",\n \"SentTimeLocal\": \"2025-06-13 08:44:16\",\n \"SendTimeUTC\": \"2025-06-12 20:44:16\",\n \"SentTimeUTC_RFC3339\": \"2025-06-12T20:44:16.000Z\",\n \"Status\": \"RECEIVED\",\n \"Result\": \"RECEIVED\",\n \"Message\": \"This is a received message from a mobile phone.\",\n \"Price\": \"e\",\n \"Detail\": \"InputToNumber:021-777909\",\n \"URL\": \"https://www.example.com/data\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api.tnz.co.nz/api/v3.00", "key": "baseUrl" }, { "type": "string", "value": "/", "key": "ResultWebhook" }, { "type": "string", "value": "/", "key": "InboundSMSWebhook" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "info": { "_postman_id": "d1502051-1e09-438d-b750-f5fa50ac1443", "name": "TNZ REST API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "# Introduction\n\nThis API allows you to send messages via TNZ's platform, including SMS, Email, Voice (both pre-recorded and text-to-speech), Fax, WhatsApp, RCS and Workflow messages. You can also manage your TNZ Address Book and track the status of your messages.\n\n**Sending/Receiving Messages**\n- [Workflow](#tag/workflow)\n- [SMS](#tag/sms)\n- [Email](#tag/email)\n- [Voice (pre-recorded audio)](#tag/voice)\n- [Voice (text-to-speech)](#tag/tts)\n- [Fax](#tag/fax)\n- [WhatsApp](#tag/whatsapp)\n- [RCS](#tag/rcs)\n\n**Manage Your Account:**\n- [Manage your TNZ Address Book](#tag/address-book)\n- [Manage Opt-Outs](#tag/optout)\n- [Manage users](#tag/partner-api) (restricted to Wholesale and Partner users)\n\n![REST API Features](https://www.tnz.co.nz/docs/restapi/assets/images/TNZApps[128x75].png)\n\n# Authentication\n\nTo use the API, an Auth Token is required in the Authorization HTTP header.\n\n**To export your Auth Token:**\n\n1. Login to the [TNZ Dashboard](https://my.tnz.co.nz)\n2. Navigate to 'Users'\n3. Create a new user or select an existing one\n4. Enable API access (if it's not already enabled)\n5. Click on the 'API' tab\n6. Enable 'Auth Token' and create a new Auth Token\n7. Click the 'Copy' button to copy it to your clipboard\n8. Use the Auth Token in the Authorization Header when submitting an API call (remember to prefix with Bearer, e.g. \"Bearer ey...0123\")\n\n**To refresh or invalidate your Auth Token:**\n\n1. Login to the [TNZ Dashboard](https://my.tnz.co.nz)\n2. Navigate to 'Users'\n3. Click on your API user\n4. Click on the 'API' tab\n5. Click on the refresh/recycle button in the Auth Token section\n6. Update your applications to use the new Auth Token\n\nThe TNZ API utilises JWT token Authentication. For OAuth2 authentication options, contact your TNZ representative.\n\n![REST API Authentication](https://www.tnz.co.nz/docs/restapi/assets/images/TNZ[128x75].png)\n\n# Change Log and Versioning\n\nREST API changes are documented: [Change Log](https://www.tnz.co.nz/docs/restapi/contents/APIChangeLog.html)\n\nWhen a new version of the API is released, the API Version in the URL is incremented. This gives you control over version updates.\n\n# Libraries and Plugins\n\nWe have libraries for popular programming languages and platforms to help you get started quickly:\n\n | Language | Documentation | Installation |\n | ---------------- | ------------ | ------------- |\n | Node.JS | [NodeJSLib](https://www.tnz.co.nz/docs/NodeJSLib/) | npm i tnzapi |\n | Python | [PythonLib](https://www.tnz.co.nz/docs/PythonLib/) | pip install tnzapi |\n | .NET | [dotNETLib](https://www.tnz.co.nz/docs/dotNetLib/) | dotnet add package TNZAPI.NET |\n\n\nContact Support:\n Name: Support\n Email: support@tnz.co.nz", "type": "text/plain" } } }