{ "_": { "postman_id": "9ccbf5b2-b58d-415b-97b7-eca89210e5f7" }, "item": [ { "id": "a5431171-b8cb-4b41-ba84-31a35d71dac2", "name": "Message sending", "description": { "content": "Early Access\n\nWhen you want to send a series of messages to a range of contacts, it is advised to group the messages and send them to SDC in bulk.\nSDC will process all messages in the payload one by one (bulk processing).\n\n```\n/email/v1/messages/send - Send a range of e-mail messages\n/mobile/v1/messages/push/send - Send a range of mobile push messages\n```\n\nAll the API operations are described in detail per type.", "type": "text/plain" }, "item": [ { "id": "7e037a51-397c-43d0-a995-86505bcfb4c7", "name": "Send e-mail messages", "request": { "name": "Send e-mail messages", "description": { "content": "Send a single e-mail message or messages in bulk to a range of recipients.\n\nLimitations:\n- Maximum 100 messages per request are accepted.\n- Maximum JSON body size is 4 MB (message including encoded attachments).", "type": "text/plain" }, "url": { "path": [ "email", "v1", "messages", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"reference\": \"2a0a0b3e71874163860d496b0283a790\",\n \"content\": {\n \"html\": \"This is the HTML content of the message\",\n \"text\": \"This is the Text content of the message\",\n \"attachments\": [\n {\n \"file_name\": \"placeholder1.png\",\n \"data\": \"iVBORw0KGdgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYI=\",\n \"mime_type\": \"image/png\"\n },\n {\n \"file_name\": \"placeholder2.png\",\n \"data\": \"iVBORw0KGdgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYI=\",\n \"mime_type\": \"image/png\"\n }\n ]\n },\n \"headers\": {\n \"subject\": \"Hello world from SDC\",\n \"to\": {\n \"alias\": \"John Doe\",\n \"address\": \"john.doe@example.com\"\n },\n \"from\": {\n \"alias\": \"Jane Doe\",\n \"address\": \"jane.doe@example.com\"\n },\n \"reply\": {\n \"alias\": \"John Doe\",\n \"address\": \"john.doe@example.com\"\n },\n \"list_unsubscribe\": \", \",\n \"optional\": [\n {\n \"name\": \"X-GRID-REF\",\n \"value\": \"headervalue\"\n }\n ]\n },\n \"context\": {\n \"tags\": [\n \"zuppy-bounce\",\n \"blackfriday-2022\"\n ],\n \"metadata\": \"{\\\"name\\\":\\\"john\\\",\\\"ref\\\":123}\",\n \"profile\": \"12345-ABCDEFG-6789\"\n },\n \"time_to_live\": \"P2D\",\n \"archive_enabled\": true,\n \"archive_duration\": \"P30D\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "text" }, "id": "99d2f5c8-6a10-4a4b-8f72-8673c6af1c67", "name": "Accepted", "originalRequest": { "url": { "path": [ "email", "v1", "messages", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"reference\": \"2a0a0b3e71874163860d496b0283a790\",\n \"content\": {\n \"html\": \"This is the HTML content of the message\",\n \"text\": \"This is the Text content of the message\",\n \"attachments\": [\n {\n \"file_name\": \"placeholder1.png\",\n \"data\": \"iVBORw0KGdgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYI=\",\n \"mime_type\": \"image/png\"\n },\n {\n \"file_name\": \"placeholder2.png\",\n \"data\": \"iVBORw0KGdgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYI=\",\n \"mime_type\": \"image/png\"\n }\n ]\n },\n \"headers\": {\n \"subject\": \"Hello world from SDC\",\n \"to\": {\n \"alias\": \"John Doe\",\n \"address\": \"john.doe@example.com\"\n },\n \"from\": {\n \"alias\": \"Jane Doe\",\n \"address\": \"jane.doe@example.com\"\n },\n \"reply\": {\n \"alias\": \"John Doe\",\n \"address\": \"john.doe@example.com\"\n },\n \"list_unsubscribe\": \", \",\n \"optional\": [\n {\n \"name\": \"X-GRID-REF\",\n \"value\": \"headervalue\"\n }\n ]\n },\n \"context\": {\n \"tags\": [\n \"zuppy-bounce\",\n \"blackfriday-2022\"\n ],\n \"metadata\": \"{\\\"name\\\":\\\"john\\\",\\\"ref\\\":123}\",\n \"profile\": \"12345-ABCDEFG-6789\"\n },\n \"custom_send_time\": \"2022-09-02T12:00:00\",\n \"time_to_live\": \"P2D\",\n \"archive_enabled\": true,\n \"archive_duration\": \"P30D\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [] }, { "_": { "postman_previewlanguage": "text" }, "id": "3e91535f-7136-4e01-b356-c24281f64d63", "name": "Unprocessable entity", "originalRequest": { "url": { "path": [ "email", "v1", "messages", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"reference\": \"2a0a0b3e71874163860d496b0283a790\",\n \"content\": {\n \"html\": \"This is the HTML content of the message\",\n \"text\": \"This is the Text content of the message\",\n \"attachments\": [\n {\n \"file_name\": \"placeholder1.png\",\n \"data\": \"iVBORw0KGdgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYI=\",\n \"mime_type\": \"image/png\"\n },\n {\n \"file_name\": \"placeholder2.png\",\n \"data\": \"iVBORw0KGdgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYI=\",\n \"mime_type\": \"image/png\"\n }\n ]\n },\n \"headers\": {\n \"subject\": \"Hello world from SDC\",\n \"to\": {\n \"alias\": \"John Doe\",\n \"address\": \"john.doe@example.com\"\n },\n \"from\": {\n \"alias\": \"Jane Doe\",\n \"address\": \"jane.doe@example.com\"\n },\n \"reply\": {\n \"alias\": \"John Doe\",\n \"address\": \"john.doe@example.com\"\n },\n \"list_unsubscribe\": \", \",\n \"optional\": [\n {\n \"name\": \"X-GRID-REF\",\n \"value\": \"headervalue\"\n }\n ]\n },\n \"context\": {\n \"tags\": [\n \"zuppy-bounce\",\n \"blackfriday-2022\"\n ],\n \"metadata\": \"{\\\"name\\\":\\\"john\\\",\\\"ref\\\":123}\",\n \"profile\": \"12345-ABCDEFG-6789\"\n },\n \"custom_send_time\": \"2022-09-02T12:00:00\",\n \"time_to_live\": \"P2D\",\n \"archive_enabled\": true,\n \"archive_duration\": \"P30D\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "df38b65e-55a0-4b37-bdca-2e2b0e19186a", "name": "Message archive", "description": { "content": "Early Access\n\nSelligent Delivery cloud stores the exact message of what was send and make it accessible via the Message Archive API to review and get the content per message/per contact.\n\nThe Message Archive API provides a search facility to find the message, or messages, tied to an profile of the recipient.\n\n```http\n/archive - Lists all messages for a profile\n/archive/{messageId} - Gets all the data for a single message\n/archive/{messageId}/download - Downloads a message\n/archive/{messageId}/download/{fileName} - Downloads an attachment of the message\n/archive/{messageId}/preview - Preview a message in html or as PDF file\n```\n\nAll the API operations are described in detail per type.", "type": "text/plain" }, "item": [ { "id": "98e04fb6-6ca4-4c1a-a870-fbce52d7a3a7", "name": "Get messages for a profile", "request": { "name": "Get messages for a profile", "description": { "content": "Browse through the list of archived messages for a profile.\n\nCurrently limited to the last 100 messages. Paging & date range filtering are available.", "type": "text/plain" }, "url": { "path": [ "reporting", "v1", "profile", ":profileId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Beginning of date range, expressed as ISO-8601 format. If not set, all the data since the 1st record will be returned.", "type": "text/plain" }, "key": "start", "value": "2023-01-01" }, { "disabled": false, "description": { "content": "End of date range, expressed as ISO-8601 format. If not set, all the items up untill now will be returned.", "type": "text/plain" }, "key": "end", "value": "2022-12-31" }, { "disabled": false, "description": { "content": "The number of records to return, used for pagination.", "type": "text/plain" }, "key": "$top", "value": "100" }, { "disabled": false, "description": { "content": "The number of items to skip over before returning items", "type": "text/plain" }, "key": "$skip", "value": "0" }, { "disabled": false, "description": { "content": "Request a count of matching items included with the results.", "type": "text/plain" }, "key": "$count", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a profile. For SMC customers, this would be a combination of the reference of properties : `LISTID.USERID`", "type": "text/plain" }, "type": "any", "value": "12345-ABCDEFG-6789", "key": "profileId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "8319a45e-da21-490a-9d0c-cc6575be4efb", "name": "Success", "originalRequest": { "url": { "path": [ "reporting", "v1", "profile", ":profileId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start", "value": "2023-01-01" }, { "key": "end", "value": "2022-12-31" }, { "key": "$top", "value": "100" }, { "key": "$skip", "value": "0" }, { "key": "$count", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a profile. For SMC customers, this would be a combination of the reference of properties : `LISTID.USERID`", "type": "text/plain" }, "type": "any", "value": "12345-ABCDEFG-6789", "key": "profileId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"value\": [\n {\n \"message_id\": \"370d25d7319b4549a88cefdda049989e_92233793802426\",\n \"channel\": \"email\",\n \"tags\": [\n \"zuppy-bounce\",\n \"resto-order-now-campaign-spring\"\n ],\n \"metadata\": \"{\\\"name\\\":\\\"jane.doe\\\",\\\"ref\\\":123456789}\",\n \"profile\": \"crm-id-123456789\",\n \"subject\": \"RestoBar - Order Now!\",\n \"timestamp\": \"2022-03-16T12:56:00.1260605\",\n \"time_to_live\": 31536000\n },\n {\n \"message_id\": \"674d25d7319b4549a88cefdda049989e_3456GHKJ56789\",\n \"channel\": \"email\",\n \"tags\": [\n \"zuppy-bounce\",\n \"singlesday-summer\"\n ],\n \"metadata\": \"{\\\"name\\\":\\\"jane.doe\\\",\\\"ref\\\":456}\",\n \"profile\": \"12345-ABCDEFG-6789\",\n \"attachments\": [\n {\n \"file_name\": \"message_attachment.pdf\",\n \"mime_type\": \"application/pdf\"\n }\n ],\n \"subject\": \"Singles day restaurant voucher\",\n \"timestamp\": \"2022-03-18T11:25:00.1260605\",\n \"time_to_live\": 2630000\n }\n ],\n \"@count\": 2,\n \"@previous_link\": \"https://customername.sdc.slgnt.eu/api/reporting/v1/profile/{profileId}/archive?start=2022-04-01T00:16:00Z&end=2022-06-01T00:16:00Z&$count=true&$top=3&$skip=0\",\n \"@next_link\": \"https://customername.sdc.slgnt.eu/api/reporting/v1/profile/{profileId}/archive?start=2022-04-01T00:16:00Z&end=2022-06-01T00:16:00Z&$count=true&$top=3&$skip=3\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "45dcc53b-6d68-4899-8b26-02750f809569", "name": "Delete messages for a profile", "request": { "name": "Delete messages for a profile", "description": { "content": "Delete all archived messages for a profile. The messages are deleted in an asynchronous way.", "type": "text/plain" }, "url": { "path": [ "reporting", "v1", "profile", ":profileId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a profile. For SMC customers, this would be a combination of the reference of properties : `LISTID.USERID`", "type": "text/plain" }, "type": "any", "value": "12345-ABCDEFG-6789", "key": "profileId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "_": { "postman_previewlanguage": "text" }, "id": "200f310b-8a51-43c7-8347-b01f10f83173", "name": "Success", "originalRequest": { "url": { "path": [ "reporting", "v1", "profile", ":profileId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a profile. For SMC customers, this would be a combination of the reference of properties : `LISTID.USERID`", "type": "text/plain" }, "type": "any", "value": "12345-ABCDEFG-6789", "key": "profileId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3f144128-9cc9-4d63-8c37-f2418182f30b", "name": "Get a message", "request": { "name": "Get a message", "description": { "content": "Get all the metadata for a single message.", "type": "text/plain" }, "url": { "path": [ "reporting", "v1", "profile", ":profileId", "archive", ":messageId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Request the tracking events for the matching message, to be included with the returned results", "type": "text/plain" }, "key": "$tracking", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a profile. For SMC customers, this would be a combination of the reference of properties : `LISTID.USERID`", "type": "text/plain" }, "type": "any", "value": "12345-ABCDEFG-6789", "key": "profileId" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the message.", "type": "text/plain" }, "type": "any", "value": "message-12345-abcde-6789", "key": "messageId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "0577a050-17b1-43ab-bfcd-6bc0d524570f", "name": "Success", "originalRequest": { "url": { "path": [ "reporting", "v1", "profile", ":profileId", "archive", ":messageId" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "$tracking", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a profile. For SMC customers, this would be a combination of the reference of properties : `LISTID.USERID`", "type": "text/plain" }, "type": "any", "value": "12345-ABCDEFG-6789", "key": "profileId" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the message.", "type": "text/plain" }, "type": "any", "value": "message-12345-abcde-6789", "key": "messageId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message_id\": \"674d25d7319b4549a88cefdda049989e_92233793802426\",\n \"timestamp\": \"2022-03-16T12:56:00.1260605+00:00\",\n \"channel\": \"email\",\n \"time_to_live\": 31536000,\n \"tags\": [\n \"zuppy-bounce\",\n \"resto-order-now-campaign-feb\"\n ],\n \"metadata\": \"{\\\"name\\\":\\\"jane.doe\\\",\\\"ref\\\":123456789}\",\n \"profile\": \"crm-id-123456789\",\n \"attachments\": [\n {\n \"file_name\": \"message_attachment.pdf\",\n \"mime_type\": \"application/pdf\"\n },\n {\n \"file_name\": \"message_attachment.pdf\",\n \"mime_type\": \"application/pdf\"\n }\n ],\n \"subject\": \"Hello world from SDC\",\n \"tracking\": [\n {\n \"external_reference\": \"2a0a0b3e71874163860d496b0283a790\",\n \"description\": \"Message ID 202203161230539493 accepted for delivery\",\n \"timestamp\": \"2022-03-16T12:56:00Z\",\n \"type\": \"sdc.bounces.email.complaintfiled\",\n \"id\": \"351395fa8d2c4fe3ad0fcce08f561491\"\n },\n {\n \"external_reference\": \"2a0a0b3e71874163860d496b0283a790\",\n \"description\": \"Message ID 202203161230539493 accepted for delivery\",\n \"timestamp\": \"2022-03-16T12:56:00Z\",\n \"type\": \"sdc.deliveries.email.failed\",\n \"id\": \"351395fa8d2c4fe3ad0fcce08f561491\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e89eafa9-0084-4c2c-b9a0-dcc2d6553cba", "name": "Delete a message", "request": { "name": "Delete a message", "description": { "content": "Synchronously deletes a specific archived message.", "type": "text/plain" }, "url": { "path": [ "reporting", "v1", "profile", ":profileId", "archive", ":messageId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a profile. For SMC customers, this would be a combination of the reference of properties : `LISTID.USERID`", "type": "text/plain" }, "type": "any", "value": "12345-ABCDEFG-6789", "key": "profileId" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the message.", "type": "text/plain" }, "type": "any", "value": "message-12345-abcde-6789", "key": "messageId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "_": { "postman_previewlanguage": "text" }, "id": "070f6142-5798-461b-a844-7a4bb8dbf347", "name": "No content. Archived message was deleted.", "originalRequest": { "url": { "path": [ "reporting", "v1", "profile", ":profileId", "archive", ":messageId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a profile. For SMC customers, this would be a combination of the reference of properties : `LISTID.USERID`", "type": "text/plain" }, "type": "any", "value": "12345-ABCDEFG-6789", "key": "profileId" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the message.", "type": "text/plain" }, "type": "any", "value": "message-12345-abcde-6789", "key": "messageId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [] }, { "_": { "postman_previewlanguage": "text" }, "id": "36ad78eb-0424-4276-9e9a-256b31b58f4f", "name": "The specified message has not been found.", "originalRequest": { "url": { "path": [ "reporting", "v1", "profile", ":profileId", "archive", ":messageId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a profile. For SMC customers, this would be a combination of the reference of properties : `LISTID.USERID`", "type": "text/plain" }, "type": "any", "value": "12345-ABCDEFG-6789", "key": "profileId" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the message.", "type": "text/plain" }, "type": "any", "value": "message-12345-abcde-6789", "key": "messageId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e20836cb-aa55-4587-a446-db32ca90c812", "name": "Download a message", "request": { "name": "Download a message", "description": { "content": "Get an archived message in channel specific format (.eml, .push, .sms).", "type": "text/plain" }, "url": { "path": [ "reporting", "v1", "profile", ":profileId", "archive", ":messageId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a profile. For SMC customers, this would be a combination of the reference of properties : `LISTID.USERID`", "type": "text/plain" }, "type": "any", "value": "12345-ABCDEFG-6789", "key": "profileId" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the message.", "type": "text/plain" }, "type": "any", "value": "message-12345-abcde-6789", "key": "messageId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "text" }, "id": "ad1ffa27-af69-40fe-852c-d68afb6825f8", "name": "Success", "originalRequest": { "url": { "path": [ "reporting", "v1", "profile", ":profileId", "archive", ":messageId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a profile. For SMC customers, this would be a combination of the reference of properties : `LISTID.USERID`", "type": "text/plain" }, "type": "any", "value": "12345-ABCDEFG-6789", "key": "profileId" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the message.", "type": "text/plain" }, "type": "any", "value": "message-12345-abcde-6789", "key": "messageId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "body": "esse fugiat sit ipsum", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "617c234b-301b-41be-bb2a-c5375cf938d1", "name": "Download an attachment", "request": { "name": "Download an attachment", "description": { "content": "Get the attachment of an archived message.", "type": "text/plain" }, "url": { "path": [ "reporting", "v1", "profile", ":profileId", "archive", ":messageId", "download", ":fileName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a profile. For SMC customers, this would be a combination of the reference of properties : `LISTID.USERID`", "type": "text/plain" }, "type": "any", "value": "12345-ABCDEFG-6789", "key": "profileId" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the message.", "type": "text/plain" }, "type": "any", "value": "message-12345-abcde-6789", "key": "messageId" }, { "disabled": false, "description": { "content": "(Required) The unique filename for a message attachment.", "type": "text/plain" }, "type": "any", "value": "message_attachement.pdf", "key": "fileName" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "text" }, "id": "5851cb71-c96c-4426-9156-471904096e02", "name": "Success", "originalRequest": { "url": { "path": [ "reporting", "v1", "profile", ":profileId", "archive", ":messageId", "download", ":fileName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a profile. For SMC customers, this would be a combination of the reference of properties : `LISTID.USERID`", "type": "text/plain" }, "type": "any", "value": "12345-ABCDEFG-6789", "key": "profileId" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the message.", "type": "text/plain" }, "type": "any", "value": "message-12345-abcde-6789", "key": "messageId" }, { "disabled": false, "description": { "content": "(Required) The unique filename for a message attachment.", "type": "text/plain" }, "type": "any", "value": "message_attachement.pdf", "key": "fileName" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "body": "esse fugiat sit ipsum", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "de02c55d-cc02-42aa-8996-4d7eba0120b4", "name": "Preview a message", "request": { "name": "Preview a message", "description": { "content": "Preview a single archived message as HTML or as PDF file.", "type": "text/plain" }, "url": { "path": [ "reporting", "v1", "profile", ":profileId", "archive", ":messageId", "preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a profile. For SMC customers, this would be a combination of the reference of properties : `LISTID.USERID`", "type": "text/plain" }, "type": "any", "value": "12345-ABCDEFG-6789", "key": "profileId" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the message.", "type": "text/plain" }, "type": "any", "value": "message-12345-abcde-6789", "key": "messageId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "Accept", "value": "application/pdf" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "text" }, "id": "cf566761-4d89-4666-ad73-563d54cb48b5", "name": "The message is found and can be previewed", "originalRequest": { "url": { "path": [ "reporting", "v1", "profile", ":profileId", "archive", ":messageId", "preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a profile. For SMC customers, this would be a combination of the reference of properties : `LISTID.USERID`", "type": "text/plain" }, "type": "any", "value": "12345-ABCDEFG-6789", "key": "profileId" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the message.", "type": "text/plain" }, "type": "any", "value": "message-12345-abcde-6789", "key": "messageId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "Accept", "value": "application/pdf" }, { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/pdf" } ], "body": "esse fugiat sit ipsum", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "f019e140-4ead-4682-9d20-24fef6096abb", "name": "The message is not found", "originalRequest": { "url": { "path": [ "reporting", "v1", "profile", ":profileId", "archive", ":messageId", "preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a profile. For SMC customers, this would be a combination of the reference of properties : `LISTID.USERID`", "type": "text/plain" }, "type": "any", "value": "12345-ABCDEFG-6789", "key": "profileId" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the message.", "type": "text/plain" }, "type": "any", "value": "message-12345-abcde-6789", "key": "messageId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "Accept", "value": "application/pdf" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.4\",\n \"title\": \"Not Found\",\n \"status\": 404,\n \"detail\": \"Resource does not exist.\",\n \"instance\": \"TODO BEN\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "33c9348d-be3c-48e8-9cf6-1794d8bc2e29", "name": "Invalid media type was specified in the `Accept` header (should be `application/json`, `*/*` or `text/html`)", "originalRequest": { "url": { "path": [ "reporting", "v1", "profile", ":profileId", "archive", ":messageId", "preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a profile. For SMC customers, this would be a combination of the reference of properties : `LISTID.USERID`", "type": "text/plain" }, "type": "any", "value": "12345-ABCDEFG-6789", "key": "profileId" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the message.", "type": "text/plain" }, "type": "any", "value": "message-12345-abcde-6789", "key": "messageId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "Accept", "value": "application/pdf" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Acceptable", "code": 406, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.6\",\n \"title\": \"Not Acceptable\",\n \"status\": 406,\n \"detail\": \"Accept type `application/json` is not supported. Supported types are `*/*`, `text/html`, `application/pdf`.\",\n \"traceId\": \"00-e591ed8aa555d78bbfc7c6fdbf46851e-f34656b7f3978a6c-00\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "a16d62d1-c8d7-48f8-a33e-77020ff4983b", "name": "The rendering service is unavailable", "originalRequest": { "url": { "path": [ "reporting", "v1", "profile", ":profileId", "archive", ":messageId", "preview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of a profile. For SMC customers, this would be a combination of the reference of properties : `LISTID.USERID`", "type": "text/plain" }, "type": "any", "value": "12345-ABCDEFG-6789", "key": "profileId" }, { "disabled": false, "description": { "content": "(Required) The unique identifier of the message.", "type": "text/plain" }, "type": "any", "value": "message-12345-abcde-6789", "key": "messageId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "Accept", "value": "application/pdf" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.4\",\n \"title\": \"Service Unavailable\",\n \"status\": 503,\n \"detail\": \"The server is currently unable to handle the request.\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "60d49b15-0eb4-4a7d-95ad-e7b36630c998", "name": "Webhook Events", "description": { "content": "SDC webhook events follow CloudEvents specification for describing event data in common formats to\nprovide interoperability across services, platforms and systems.", "type": "text/plain" }, "item": [], "event": [] }, { "id": "81b974e5-e53a-4f8f-91c2-884ea5aa0684", "name": "OAuth", "description": { "content": "All endpoints to authenticate yourself, to access the SDC API.", "type": "text/plain" }, "item": [ { "id": "33a6805e-c805-417b-8459-b2ad10d4a519", "name": "Get Oauth access Token", "request": { "name": "Get Oauth access Token", "description": { "content": "Request an access tokens to access SDC resources on behalf of an authenticated user.\n\nNote:\n* Access Tokens expire after 2 hours.\n* Refresh Tokens don't expire until they are used.", "type": "text/plain" }, "url": { "path": [ "oauth", "token" ], "host": [ "{{oauth-token-Url}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"client_id\": \"{{oauth_client_id}}\",\n \"client_secret\": \"{{oauth_client_secret}}\",\n \"account_id\": \"{{oauth_account_id}}\",\n \"grant_type\": \"client_credentials\",\n \"audience\": \"https://sdc.slgnt.eu\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "fe293fea-3d97-4569-a454-7c53f4a9fc4f", "name": "Success", "originalRequest": { "url": { "path": [ "oauth", "token" ], "host": [ "{{oauth-token-Url}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"client_id\": \"dolore eiusmod nulla\",\n \"client_secret\": \"123abc\",\n \"account_id\": \"12345ABCDE6789FGHIJ\",\n \"grant_type\": \"client_credentials\",\n \"audience\": \"https://sdc.slgnt.eu\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"access_token\": \"abcdefghijklmnopqrstuvwxyz1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ\",\n \"scope\": \"send:email\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 86400,\n \"refresh_token\": \"1234567890abcdefghijklmnopqrstuvwxyz1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "077e7085-0df5-4ae3-849e-d9ef8f0def3b", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "oauth", "token" ], "host": [ "{{oauth-token-Url}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"client_id\": \"dolore eiusmod nulla\",\n \"client_secret\": \"123abc\",\n \"account_id\": \"12345ABCDE6789FGHIJ\",\n \"grant_type\": \"client_credentials\",\n \"audience\": \"https://sdc.slgnt.eu\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"invalid_client\",\n \"error_description\": \"Unauthorized\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "75787a26-1ea2-454e-ba96-dd7f7b51d997", "name": "Accounts", "description": { "content": "Access information about your accounts and their settings.", "type": "text/plain" }, "item": [ { "id": "759cc229-8b9e-4fc8-8949-98db16c884f4", "name": "Get all accounts", "request": { "name": "Get all accounts", "description": { "content": "Returns a list of your SDC portal accounts for a certain tenant. The accounts are returned sorted by creation date.", "type": "text/plain" }, "url": { "path": [ "config", "v1", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "28d15c28-0929-45a6-939b-85fc1ae37b09", "name": "Successful response", "originalRequest": { "url": { "path": [ "config", "v1", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"value\": [\n {\n \"id\": \"account0-test-abcd-efgh-example12345\",\n \"name\": \"Contoso Marketing\",\n \"enabled\": true,\n \"tags\": [\n \"Demo\",\n \"Example\"\n ],\n \"description\": \"example account\",\n \"archiveEnabled\": true,\n \"archiveDuration\": \"P365D\"\n }\n ],\n \"count\": 1,\n \"previousLink\": \"https://customername.sdc.slgnt.eu/api/config/v1/tenants/DEV.EXAMPLE/accounts?$count=true&$top=3&$skip=3\",\n \"nextLink\": \"https://customername.sdc.slgnt.eu/api/config/v1/tenants/DEV.EXAMPLE/accounts?$count=true&$top=3&$skip=9\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7fcbe223-fbe9-4339-bbe7-e7cd9e6da4a6", "name": "Get a specific account", "request": { "name": "Get a specific account", "description": { "content": "Retrieves the details of an existing account, by supplying the unique account identifier.", "type": "text/plain" }, "url": { "path": [ "config", "v1", "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the portal account.", "type": "text/plain" }, "type": "any", "value": "account0-test-abcd-efgh-example12345", "key": "accountId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "dde2230a-60ef-41a2-9b46-05d0bb39243e", "name": "Successful response", "originalRequest": { "url": { "path": [ "config", "v1", "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the portal account.", "type": "text/plain" }, "type": "any", "value": "account0-test-abcd-efgh-example12345", "key": "accountId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"account0-test-abcd-efgh-example12345\",\n \"name\": \"Contoso Marketing\",\n \"enabled\": true,\n \"tags\": [\n \"Demo\",\n \"Example\"\n ],\n \"description\": \"example account\",\n \"archiveEnabled\": true,\n \"archiveDuration\": \"P365D\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "1e8a803f-bcad-4bc6-b505-299df71bf86c", "name": "Mail Domains", "description": { "content": "Retrieve all the maildomains belonging to a specific account.", "type": "text/plain" }, "item": [ { "id": "57f4bdf0-657b-4105-9833-4c0fffe02656", "name": "Get all maildomains", "request": { "name": "Get all maildomains", "description": { "content": "Returns a list of your SDC portal maildomains for a certain tenant.", "type": "text/plain" }, "url": { "path": [ "config", "v1", "maildomains" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "17a9e015-86a5-447c-9699-d0cb0c9ca61b", "name": "Successful response", "originalRequest": { "url": { "path": [ "config", "v1", "maildomains" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"value\": [\n {\n \"name\": \"service.slgnt.eu\",\n \"csaEnabled\": false,\n \"listUnsubscribe\": \"\",\n \"fromAddress\": \"info@test.eu\",\n \"replyAddress\": \"noreply@test.eu\",\n \"dkimSettings\": {\n \"selector\": \"133742.tst\",\n \"signatureDomain\": \"service.test.eu\",\n \"identityDomain\": \"service.tst.eu\"\n }\n }\n ],\n \"count\": 1,\n \"previousLink\": \"https://customername.sdc.slgnt.eu/api/config/v1/tenants/DEV.EXAMPLE/maildomains?$count=true&$top=3&$skip=3\",\n \"nextLink\": \"https://customername.sdc.slgnt.eu/api/config/v1/tenants/DEV.EXAMPLE/maildomains?$count=true&$top=3&$skip=9\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a89ae2b7-4ee7-4bc5-8419-34b819363212", "name": "Get a specific maildomain", "request": { "name": "Get a specific maildomain", "description": { "content": "Retrieves the details of an existing maildomain, by supplying the unique name identifier.", "type": "text/plain" }, "url": { "path": [ "config", "v1", "maildomains", ":mailDomainName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the portal maildomain.", "type": "text/plain" }, "type": "any", "value": "service.example.eu", "key": "mailDomainName" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "5ef2bdbe-dc65-4b60-92b2-11e6e631a7fe", "name": "Successful response", "originalRequest": { "url": { "path": [ "config", "v1", "maildomains", ":mailDomainName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the portal maildomain.", "type": "text/plain" }, "type": "any", "value": "service.example.eu", "key": "mailDomainName" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"service.slgnt.eu\",\n \"csaEnabled\": false,\n \"listUnsubscribe\": \"\",\n \"fromAddress\": \"info@test.eu\",\n \"replyAddress\": \"noreply@test.eu\",\n \"dkimSettings\": {\n \"selector\": \"133742.tst\",\n \"signatureDomain\": \"service.test.eu\",\n \"identityDomain\": \"service.tst.eu\"\n }\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d4b5bbc4-ceff-44ab-9701-ec0847c75345", "name": "Bounces", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "f35779b9-6fb9-4886-b65c-397eff2327e8", "name": "Get Bounces", "request": { "name": "Get Bounces", "description": { "content": "Get Bounces", "type": "text/plain" }, "url": { "path": [ "reporting", "v1", "bounces" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Beginning of date range, expressed as ISO-8601 format. If not set, all the data since the 1st record will be returned.", "type": "text/plain" }, "key": "start", "value": "2023-01-01" }, { "disabled": false, "description": { "content": "End of date range, expressed as ISO-8601 format. If not set, all the items up untill now will be returned.", "type": "text/plain" }, "key": "end", "value": "2022-12-31" }, { "disabled": false, "description": { "content": "The number of records to return, used for pagination.", "type": "text/plain" }, "key": "$top", "value": "100" }, { "disabled": false, "description": { "content": "The number of items to skip over before returning items", "type": "text/plain" }, "key": "$skip", "value": "0" }, { "disabled": false, "key": "type", "value": "direct" }, { "disabled": false, "key": "accountId", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "8504b9d2-7c67-4976-8c34-0410e5de46ba", "name": "Success", "originalRequest": { "url": { "path": [ "reporting", "v1", "bounces" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start", "value": "2023-01-01" }, { "key": "end", "value": "2022-12-31" }, { "key": "$top", "value": "100" }, { "key": "$skip", "value": "0" }, { "key": "type", "value": "direct" }, { "key": "accountId", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"value\": [\n {\n \"account_id\": \"3822afb319684af18b9664ee327b7c44\",\n \"mapping\": \"hard\",\n \"mode\": \"direct\",\n \"external_reference\": \"674d25d7319b4549a88cefdda049989e_92233793802426\",\n \"timestamp\": \"2023-07-25T19:19:00.0378723+00:00\",\n \"finalize_reason\": \"hardBounce\",\n \"outcome\": \"452 System is busy\",\n \"outcome_category\": \"exclusion\",\n \"domain\": \"example.com\"\n },\n {\n \"account_id\": \"3822afb319684af18b9664ee327b7c44\",\n \"mapping\": \"spam\",\n \"mode\": \"indirect\",\n \"external_reference\": \"674d25d7319b4549a88cefdda049989e_92233793802426\",\n \"timestamp\": \"2023-07-26T19:19:00.0378723+00:00\",\n \"mailbox\": \"bounces@yourdomain.slgnt.us\",\n \"domain\": \"example.com\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d9fa62a6-f0e5-4372-ba8d-b1e03bf9d3d9", "name": "Get List Unsubscribes", "request": { "name": "Get List Unsubscribes", "description": { "content": "Get List Unsubscribes", "type": "text/plain" }, "url": { "path": [ "reporting", "v1", "listunsubscribes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Beginning of date range, expressed as ISO-8601 format. If not set, all the data since the 1st record will be returned.", "type": "text/plain" }, "key": "start", "value": "2023-01-01" }, { "disabled": false, "description": { "content": "End of date range, expressed as ISO-8601 format. If not set, all the items up untill now will be returned.", "type": "text/plain" }, "key": "end", "value": "2022-12-31" }, { "disabled": false, "description": { "content": "The number of records to return, used for pagination.", "type": "text/plain" }, "key": "$top", "value": "100" }, { "disabled": false, "description": { "content": "The number of items to skip over before returning items", "type": "text/plain" }, "key": "$skip", "value": "0" }, { "disabled": false, "key": "accountId", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "9125cf43-2dcd-4ff3-a79c-8a9873355813", "name": "Success", "originalRequest": { "url": { "path": [ "reporting", "v1", "listunsubscribes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start", "value": "2023-01-01" }, { "key": "end", "value": "2022-12-31" }, { "key": "$top", "value": "100" }, { "key": "$skip", "value": "0" }, { "key": "accountId", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"value\": [\n {\n \"account_id\": \"3822afb319684af18b9664ee327b7c44\",\n \"external_reference\": \"674d25d7319b4549a88cefdda049989e_92233793802426\",\n \"timestamp\": \"2023-07-25T19:19:00.0378723+00:00\",\n \"mailbox\": \"unsubscribe@yourdomain.slgnt.us\",\n \"list_unsubscribe_header\": \", \",\n \"domain\": \"example.com\"\n },\n {\n \"account_id\": \"3822afb319684af18b9664ee327b7c44\",\n \"external_reference\": \"674d25d7319b4549a88cefdda049989e_92233793802426\",\n \"timestamp\": \"2023-07-26T19:19:00.0378723+00:00\",\n \"mailbox\": \"unsubscribe@yourdomain.slgnt.us\",\n \"list_unsubscribe_header\": \", \",\n \"domain\": \"example.com\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ba61f591-5217-4de5-8640-4edfcaa347ae", "name": "Get Complaints", "request": { "name": "Get Complaints", "description": { "content": "Get Complaints", "type": "text/plain" }, "url": { "path": [ "reporting", "v1", "complaints" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Beginning of date range, expressed as ISO-8601 format. If not set, all the data since the 1st record will be returned.", "type": "text/plain" }, "key": "start", "value": "2023-01-01" }, { "disabled": false, "description": { "content": "End of date range, expressed as ISO-8601 format. If not set, all the items up untill now will be returned.", "type": "text/plain" }, "key": "end", "value": "2022-12-31" }, { "disabled": false, "description": { "content": "The number of records to return, used for pagination.", "type": "text/plain" }, "key": "$top", "value": "100" }, { "disabled": false, "description": { "content": "The number of items to skip over before returning items", "type": "text/plain" }, "key": "$skip", "value": "0" }, { "disabled": false, "key": "accountId", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "6f2f7e19-6fa3-435c-824c-3daa96e136b7", "name": "Success", "originalRequest": { "url": { "path": [ "reporting", "v1", "complaints" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start", "value": "2023-01-01" }, { "key": "end", "value": "2022-12-31" }, { "key": "$top", "value": "100" }, { "key": "$skip", "value": "0" }, { "key": "accountId", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"value\": [\n {\n \"account_id\": \"3822afb319684af18b9664ee327b7c44\",\n \"external_reference\": \"674d25d7319b4549a88cefdda049989e_92233793802426\",\n \"timestamp\": \"2023-07-25T19:19:00.0378723+00:00\",\n \"mailbox\": \"complaints@yourdomain.slgnt.us\",\n \"domain\": \"example.com\"\n },\n {\n \"account_id\": \"3822afb319684af18b9664ee327b7c44\",\n \"external_reference\": \"674d25d7319b4549a88cefdda049989e_92233793802426\",\n \"timestamp\": \"2023-07-26T19:19:00.0378723+00:00\",\n \"mailbox\": \"complaints@yourdomain.slgnt.us\",\n \"domain\": \"example2.com\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3ab9d0d6-569a-452a-893a-9c16fe03f653", "name": "Find a bounce by external reference id", "request": { "name": "Find a bounce by external reference id", "description": { "content": "Find a bounce by external reference id", "type": "text/plain" }, "url": { "path": [ "reporting", "v1", "bounces", ":messageId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the message.", "type": "text/plain" }, "type": "any", "value": "message-12345-abcde-6789", "key": "messageId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "cfce80cf-0fcc-4247-b7a2-ba9c495d4aa0", "name": "Success", "originalRequest": { "url": { "path": [ "reporting", "v1", "bounces", ":messageId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the message.", "type": "text/plain" }, "type": "any", "value": "message-12345-abcde-6789", "key": "messageId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"account_id\": \"3822afb319684af18b9664ee327b7c44\",\n \"mapping\": \"soft\",\n \"mode\": \"direct\",\n \"external_reference\": \"674d25d7319b4549a88cefdda049989e_92233793802426\",\n \"timestamp\": \"2023-07-25T19:19:00.0378723+00:00\",\n \"finalize_reason\": \"hardBounce\",\n \"outcome\": \"452 System is busy\",\n \"outcome_category\": \"exclusion\",\n \"domain\": \"example.com\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "0799c569-5360-49f2-a817-90245aadc163", "name": "Not Found", "originalRequest": { "url": { "path": [ "reporting", "v1", "bounces", ":messageId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the message.", "type": "text/plain" }, "type": "any", "value": "message-12345-abcde-6789", "key": "messageId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.4\",\n \"title\": \"Not Found\",\n \"status\": 404,\n \"detail\": \"Resource does not exist.\",\n \"instance\": \"TODO BEN\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "be807f0e-2111-4f9b-89bf-e3098e95f489", "name": "Statistics", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "768c367a-3749-45c8-b8bd-84ad026d4e7e", "name": "Get the deliverabiliy statistics", "request": { "name": "Get the deliverabiliy statistics", "description": { "content": "Retrieves the deliverability statistics in the specified timerange", "type": "text/plain" }, "url": { "path": [ "reporting", "v1", "statistics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Beginning of time range, expressed as ISO-8601 timestamp in UTC.", "type": "text/plain" }, "key": "start", "value": "2022-01-01T13:00:56Z" }, { "disabled": false, "description": { "content": "End of time range, expressed as ISO-8601 timestamp in UTC.", "type": "text/plain" }, "key": "end", "value": "2022-12-31T13:00:56Z" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "e1813666-2591-43bd-8f61-422d8e838c27", "name": "OK", "originalRequest": { "url": { "path": [ "reporting", "v1", "statistics" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start", "value": "2022-01-01T13:00:56Z" }, { "key": "end", "value": "2022-12-31T13:00:56Z" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"value\": [\n {\n \"window\": \"2022-04-08T13:36:00+00:00\",\n \"counters\": {\n \"email_failed\": 1,\n \"email_deferred\": 2,\n \"email_sent\": 37,\n \"email_archived\": 25,\n \"mobile_failed\": 18,\n \"mobile_deferred\": 23,\n \"mobile_sent\": 42,\n \"mobile_push_archived\": 25,\n \"sms_failed\": 28,\n \"sms_sent\": 0,\n \"sms_archived\": 25\n }\n },\n {\n \"window\": \"2022-04-08T13:36:00+00:00\",\n \"counters\": {\n \"email_failed\": 1,\n \"email_deferred\": 2,\n \"email_sent\": 37,\n \"email_archived\": 25,\n \"mobile_failed\": 18,\n \"mobile_deferred\": 23,\n \"mobile_sent\": 42,\n \"mobile_push_archived\": 25,\n \"sms_failed\": 28,\n \"sms_sent\": 0,\n \"sms_archived\": 25\n }\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "91759856-7de9-4c92-b63e-e17618d95a6e", "name": "Message tracking", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "5139353d-4884-4ef1-8ed9-32bc8cea80f4", "name": "Track a message", "request": { "name": "Track a message", "description": { "content": "Get all message proccing & delivery events for a specific message reference.", "type": "text/plain" }, "url": { "path": [ "reporting", "v1", "tracking", ":messageId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the message.", "type": "text/plain" }, "type": "any", "value": "message-12345-abcde-6789", "key": "messageId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "9ef4106a-6274-43dc-b35c-c9728fd7d85a", "name": "Items are found", "originalRequest": { "url": { "path": [ "reporting", "v1", "tracking", ":messageId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the message.", "type": "text/plain" }, "type": "any", "value": "message-12345-abcde-6789", "key": "messageId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"value\": [\n {\n \"external_reference\": \"2a0a0b3e71874163860d496b0283a790\",\n \"description\": \"Message ID 202203161230539493 accepted for delivery\",\n \"timestamp\": \"2022-03-16T12:56:00Z\",\n \"type\": \"sdc.deliveries.email.failed\",\n \"id\": \"351395fa8d2c4fe3ad0fcce08f561491\"\n },\n {\n \"external_reference\": \"2a0a0b3e71874163860d496b0283a790\",\n \"description\": \"Message ID 202203161230539493 accepted for delivery\",\n \"timestamp\": \"2022-03-16T12:56:00Z\",\n \"type\": \"sdc.bounces.email.complaintfiled\",\n \"id\": \"351395fa8d2c4fe3ad0fcce08f561491\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f4d0400d-f36b-4749-a5c9-f921b51e0ce9", "name": "Configuration", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "f4c95dab-0718-4cf8-a7e5-3eddd2f9db5b", "name": "Get all accounts", "request": { "name": "Get all accounts", "description": { "content": "Returns a list of your SDC portal accounts for a certain tenant. The accounts are returned sorted by creation date.", "type": "text/plain" }, "url": { "path": [ "config", "v1", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "152d5187-9509-4d52-bc1a-7b0249d1ba8a", "name": "Successful response", "originalRequest": { "url": { "path": [ "config", "v1", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"value\": [\n {\n \"id\": \"account0-test-abcd-efgh-example12345\",\n \"name\": \"Contoso Marketing\",\n \"enabled\": true,\n \"tags\": [\n \"Demo\",\n \"Example\"\n ],\n \"description\": \"example account\",\n \"archiveEnabled\": true,\n \"archiveDuration\": \"P365D\"\n }\n ],\n \"count\": 1,\n \"previousLink\": \"https://customername.sdc.slgnt.eu/api/config/v1/tenants/DEV.EXAMPLE/accounts?$count=true&$top=3&$skip=3\",\n \"nextLink\": \"https://customername.sdc.slgnt.eu/api/config/v1/tenants/DEV.EXAMPLE/accounts?$count=true&$top=3&$skip=9\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8aedb6fc-b2f9-43fa-9065-6fec0a2482e3", "name": "Get a specific account", "request": { "name": "Get a specific account", "description": { "content": "Retrieves the details of an existing account, by supplying the unique account identifier.", "type": "text/plain" }, "url": { "path": [ "config", "v1", "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the portal account.", "type": "text/plain" }, "type": "any", "value": "account0-test-abcd-efgh-example12345", "key": "accountId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "5022e980-ef24-4cd4-b2f3-bd18464fba5a", "name": "Successful response", "originalRequest": { "url": { "path": [ "config", "v1", "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the portal account.", "type": "text/plain" }, "type": "any", "value": "account0-test-abcd-efgh-example12345", "key": "accountId" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"account0-test-abcd-efgh-example12345\",\n \"name\": \"Contoso Marketing\",\n \"enabled\": true,\n \"tags\": [\n \"Demo\",\n \"Example\"\n ],\n \"description\": \"example account\",\n \"archiveEnabled\": true,\n \"archiveDuration\": \"P365D\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "19b7fd87-135c-4096-8eb2-4c0c98dfa60d", "name": "Get all maildomains", "request": { "name": "Get all maildomains", "description": { "content": "Returns a list of your SDC portal maildomains for a certain tenant.", "type": "text/plain" }, "url": { "path": [ "config", "v1", "maildomains" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "01cf689e-19e8-4e81-b642-881c969853a9", "name": "Successful response", "originalRequest": { "url": { "path": [ "config", "v1", "maildomains" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"value\": [\n {\n \"name\": \"service.slgnt.eu\",\n \"csaEnabled\": false,\n \"listUnsubscribe\": \"\",\n \"fromAddress\": \"info@test.eu\",\n \"replyAddress\": \"noreply@test.eu\",\n \"dkimSettings\": {\n \"selector\": \"133742.tst\",\n \"signatureDomain\": \"service.test.eu\",\n \"identityDomain\": \"service.tst.eu\"\n }\n }\n ],\n \"count\": 1,\n \"previousLink\": \"https://customername.sdc.slgnt.eu/api/config/v1/tenants/DEV.EXAMPLE/maildomains?$count=true&$top=3&$skip=3\",\n \"nextLink\": \"https://customername.sdc.slgnt.eu/api/config/v1/tenants/DEV.EXAMPLE/maildomains?$count=true&$top=3&$skip=9\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e9ff3360-bd92-4324-abd6-d7cc50afc330", "name": "Get a specific maildomain", "request": { "name": "Get a specific maildomain", "description": { "content": "Retrieves the details of an existing maildomain, by supplying the unique name identifier.", "type": "text/plain" }, "url": { "path": [ "config", "v1", "maildomains", ":mailDomainName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the portal maildomain.", "type": "text/plain" }, "type": "any", "value": "service.example.eu", "key": "mailDomainName" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "72fa016f-93cb-4332-8ebf-d16f3f710281", "name": "Successful response", "originalRequest": { "url": { "path": [ "config", "v1", "maildomains", ":mailDomainName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The unique identifier of the portal maildomain.", "type": "text/plain" }, "type": "any", "value": "service.example.eu", "key": "mailDomainName" } ] }, "header": [ { "disabled": false, "description": { "content": "Oauth2 token to authorize requests.", "type": "text/plain" }, "key": "Authorization", "value": "Bearer {{oauth_access_token}}" }, { "disabled": false, "description": { "content": "(Required) Define the file type and format for the request object.", "type": "text/plain" }, "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"service.slgnt.eu\",\n \"csaEnabled\": false,\n \"listUnsubscribe\": \"\",\n \"fromAddress\": \"info@test.eu\",\n \"replyAddress\": \"noreply@test.eu\",\n \"dkimSettings\": {\n \"selector\": \"133742.tst\",\n \"signatureDomain\": \"service.test.eu\",\n \"identityDomain\": \"service.tst.eu\"\n }\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [ { "listen": "prerequest", "script": { "id": "a74bda70-b48d-4cca-869b-20df5b6a4f32", "type": "text/javascript", "exec": [ "const currentTime = new Date().getTime();", "const oauthTokenUrl = pm.environment.get('oauth_access_token_url');", "const oauthGrantType = pm.environment.get('oauth_grant_type');", "const oauthClientId = pm.environment.get('oauth_client_id');", "const oauthClientSecret = pm.environment.get('oauth_client_secret');", "const oauthAudience = pm.environment.get('oauth_audience');", "const oauthAccountId = pm.environment.get('oauth_account_id');", "const getTokenRequest = {", " method: 'POST',", " url: oauthTokenUrl,", " header: {'Content-Type': 'application/json'},", " body: {", " mode: 'raw',", " raw: JSON.stringify({", " 'grant_type': oauthGrantType,", " 'client_id': oauthClientId,", " 'client_secret': oauthClientSecret,", " 'audience': oauthAudience,", " 'account_id': oauthAccountId,", " })", " }", "};", "// Fetch new access token, if empty OR if is expired", "if (!(pm.environment.get('oauth_access_token')) || (currentTime >= pm.environment.get('oauth_access_token_expires'))) {", " pm.sendRequest(getTokenRequest, (err, res) => {", " let jsonData = res.json();", " pm.environment.set('oauth_access_token', jsonData.access_token);", " pm.environment.set('oauth_access_token_expires', new Date().getTime() + jsonData.expires_in);", " });", " console.log('Oauth access token refreshed & ready to use')", "}" ] } } ], "variable": [ { "type": "string", "value": "https://customername.sdc.slgnt.eu/api", "key": "baseUrl" }, { "type": "string", "value": "https://auth.slgnt.eu", "key": "oauth-token-Url" }, { "type": "string", "value": "https://auth.slgnt.eu/oauth/token", "key": "oauthAccessTokenUrl" }, { "type": "string", "value": "", "key": "oauthClientId" }, { "type": "string", "value": "", "key": "oauthClientSecret" }, { "type": "string", "value": "", "key": "oauthAccountId" }, { "type": "string", "value": "https://sdc.slgnt.eu", "key": "oauthAudience" }, { "type": "string", "value": "client_credentials", "key": "oauthGrantType" } ], "info": { "_postman_id": "9ccbf5b2-b58d-415b-97b7-eca89210e5f7", "name": "Selligent Delivery Cloud API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "# Selligent Delivery Cloud API\n\nBy providing a fully documented API reference, we want to enable everyone to maximize the usage of the Selligent\nPlatform for automating & exchange data.\n\nThe Selligent API is organized around the REST protocol with the use of HTTP verbs and a RESTful endpoint structure. The\nAPI provides resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses\nstandard HTTP response codes, authentication, and verbs. We strive to make the endpoints so self-explanatory and\ninformative as possible, by providing clear validation, error and success responses.\n\nThe API style is inspired by the [Microsoft API guidelines](https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md).\n\n# REST API\n\nThe SDC API endpoints are segmented.\n\n## Base URL\n\n![](assets/img/sdc-api-base-url.png)\n\n```\nhttps://customername.module.slgnt.eu\n```\n\nExample: `https://contoso.sdc.slgnt.eu/api/mobile/v1/push/send`\n\n**Definition**\n\n1. **Customer name**: refers to a unique subdomain per customer. In the example the customer is \"contoso\".\n2. **Module**: refers to a unique subdomain per product/application module. For this API reference the module is Selligent (\n Selligent).\n3. **slgnt.eu/slgnt.us**: refers to the geographical area for which the customer instance is active.\n\n **Europe**: `https://customername.module.slgnt.eu` / **United States**: `https://customername.module.slgnt.us`\n\n4. **Touchpoint**: refers to the grouped entrypoint for the user to interact/interface with the application. For this\n API reference the touch point is the API.\n5. **Component/Channel**: refers to the channels (email/mobile/sms) or towards a specific component (like messages,\n reporting, …). In the example the channel is \"push\".\n\n## URI parts\n\n![](assets/img/sdc-api-url-parts.png)\n\n```\nhttps://baseUrl/chapter/versioning/entity(_type)/{identifier}/operation|result\n```\n\nExamples:\n\n```bash\n- Portal https://contoso.sdc.slgnt.eu/api/portal/v1/policies/1234567890\n- Mail https://contoso.sdc.slgnt.eu/api/mail/v1/send\n```\n\n**Definition**\n\n0. _Part 0_: **Base URL** - The base url is a reference to the customer domain.\n1. _Part 1_: **Channel** - Refers to the SDC channels: e-mail, mobile, sms, ...\n2. _Part 2_: **Version number** - major numbering only - example: `v2`. In case no version number is part, it refers to\n the initial API version.\n3. _Part 3_: **Entity(_type)** - Refers to entity or entity type. This is depends on the chapter, if it is needed or\n not.\n4. _Part 4_: **Identifier** - Refers to the unique identifier for a specific entity.\n5. _Part 5_: **Operation|Result** - Refers to additional operations or specific sub-entities of the parent entity. This\n is depends on the chapter, if it is needed or not. Examples: lists > fields / journeys > send\n\n## Versioning\n\nCurrently, we are introducing a new version of the SDC REST API. The version number is part of the URI part of the API\nendpoint.\n\nWhen we make improvements to the current version of the API endpoints, we strive to make only backwards-incompatible\nchanges. We release improvements or new endpoints regularly. Read our API changelog to stay up-to-date with the latest\nchanges.\n\nExample for V2 for push: `https://contoso.sdc.slgnt.eu/api/mobile/v2/push`\n\nExample for V3 for push: `https://contoso.sdc.slgnt.eu/api/mobile/v3/push`\n\n## Authentication\n\nThe Selligent Delivery Cloud API uses the Oauth2.0 authorisation protocol, through bearer JSON Web Tokens (JWT), to authenticate requests. \nSelligent will provide you with a dedicated client ID and secret to authorize using OAuth.\n\nWith each API call, you will need to set request headers including your access key to authenticate yourself.\n\nThe client ID and secret carry significant privileges. Please ensure to keep them 100% secure.\nDo not share your Oauth client ID and Oauth client secret in publicly accessible areas such as versioning systems (GitHub, Bitbucket,... ) or client-side code.\n\nPer tenant, you can receive up to 3 credentials. One is a default one created when the tenant is created.\nThe default one should serve for dev purposes. The other 2 can be used as staging environment and production environment.\nFor each of those credentials, different privileges can be assigned in terms of:\n- Account(s) it can access\n- Resources it can access\n- Messages it can send \n\n\n\n## Errors\nSelligent uses the conventional HTTP response codes to indicate successful or failed API requests.\n\nCodes in the `2xx` range indicate success.\n\nCodes in the `4xx` range indicate an input related error or validation restrictions.\n\nCodes in the `5xx` range indicate an error with Selligent servers.\n\n| HTTP Status Codes | Description |\n| -------------------------- | ---------------------------------------------------------------------------------- |\n| 200 - OK | We found the request resource |\n| 201 - Created | The resource is successfully created |\n| 204 - No Content | The requested resources is empty |\n| 400 - Bad Request | There was an error with the request. The body of the response will have more info. |\n| 401 - Unauthorized | The access key was incorrect |\n| 404 - Not found | The resources cannot be found |\n| 405 - Method Not Allowed | The method is not allowed |\n| 408 - Request Timeout | The request is taking too long to respond |\n| 422 - Unprocessable Entity | The resource couldn't be created |\n| 429 - Too Many Requests | Too many requests hit the API too quickly |\n| 5xx - Server errors | Something went wrong on our end. Please try again |\n\n### 400/422 - Bad / Validation request\n\nIn the case of a validation of bad request error, the body of the response includes a JSON formatted response that tells\nyou exactly what's wrong.\n\n#### Attributes\n\nhttps://www.rfc-editor.org/rfc/rfc7807.txt\n\n\n| Attribute
| Type | Description |\n| ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------ |\n| `type` | String | A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be \"about:blank\" |\n| `title` | String | A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4) codes. |\n| `status` | Integer | The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem type. |\n| `detail` | String |A human-readable explanation specific to this occurrence of the problem. |\n| `traceId` | String | A reference ID to trace log within the SMC platform. This can be relevant for reporting to the support team. |\n| `errors[]` | Array | An array of details about specific errors that led to this reported error. |\n| `errors[].field ` | String | The problematic field in your request related to the error if the error is specific. |\n| `errors[].error` | Integer | A short string indicating the error code reported, for some errors that could be handled programmatically. In some cases, it can contain custom errors which are not documented error codes. |\n| `errors[].detail` | String | An optional human-readable description of the error. You can use this to let the user know what they can do about the error. |\n| `errors[].index` | Integer | An optional value which gives additional information about the position of the entity in the given entity batch/array. Only available when dealing with batch. |\n\nEntity failure :\n\n```json\n{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.1\",\n \"title\": \"Validation errors\",\n \"status\": 400, \n \"detail\": \"One or more validation errors occurred.\",\n \"traceId\": \"00-03f4894fecc1ae4498599fb8d5d16b5e-9d0a2aab93c57d41-00\",\n \"errors\": [\n { \n \"field\": \"PhoneNumber\",\n \"error\": \"REQUIRED_FIELD\",\n \"message\": \"this field must not be null.\"\n },\n {\n \"field\": \"age\",\n \"error\": \"INVALID_RANGE\",\n \"message\": \"value should be between 0 and 99.\"\n },\n {\n \"field\": \"Address\",\n \"error\": \"INVALID_ADDRESS\",\n \"message\": \"Address is not valid.\"\n },\n {\n \"field\": \"customField1\",\n \"error\": \"the format of field 'customField1' is invalid.\"\n }\n ]\n}\n```\n\nBached entities :\n\n```json\n{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.1\",\n \"title\": \"Validation errors\",\n \"status\": 400, \n \"detail\": \"One or more validation errors occurred.\",\n \"traceId\": \"00-03f4894fecc1ae4498599fb8d5d16b5e-9d0a2aab93c57d41-00\",\n \"errors\": [\n {\n \"index\": 0,\n \"field\": \"reference\",\n \"error\": \"INVALID_REFERENCE_EMPTY\",\n \"detail\": \"Reference is empty\"\n },\n {\n \"index\": 1,\n \"field\": \"context.tags\",\n \"error\": \"INVALID_TAG_EMPTY\",\n \"detail\": \"Tag can not be null or empty!\"\n },\n {\n \"index\": 2,\n \"field\": \"content.title\",\n \"error\": \"INVALID_EMPTY_TITLE\",\n \"detail\": \"Title cannot be empty\"\n }\n ]\n}\n```\n#### Global error codes\n\n| Code | Description |\n| ----------------------- | ----------------------------------------------------------- | \n|REQUIRED_PROPERTY | property is required. | \n|INVALID_REFERENCE_EMPTY | Message reference can not be empty. | \n|INVALID_REFERENCE_LENGTH | Message reference length threshold exceeded (64). |\n|INVALID_REFERENCE_CHAR | Message reference can only contain letters,'-' and digits. |\n|INVALID_TYPE | Request property type doesn't match expected type. |\n|INVALID_TAG_LENGTH | Tag length can not be more than 96 bytes. |\n|INVALID_TAG_EMPTY | Tag can not be null or empty. |\n|INVALID_TAG_CHAR | Tag contains an invalid character: '/'. |\n|INVALID_METADATA_LENGTH | Metadata can not contain more than 140 characters |\n|INVALID_PROFILE_LENGTH | Profile can not contain more than 140 characters |\n\n#### e-mail error codes\n\n| Code | Description |\n| ----------------------- | ----------------------------------------------------------- | \n|INVALID_SUBJECT_EMPTY | e-mail 'Subject' can not be empty. | \n|REQUIRED_TO_HEADER | To: header is required. | \n|REQUIRED_TO_ADDRESS | To: Address is required. | \n|REQUIRED_FROM_HEADER | From: header is required. | \n|REQUIRED_FROM_ADDRESS | From: Address is required. | \n|REFERENCE_DUPLICATE_DETECTED | Duplicate references have been detected in the batch |\n|Duplicate headers detected: [{0}]. | Duplicate headers detected: [{0}]. '{0}' contains the list of duplicated headers |\n|Error for optional header: name can not be null or empty. | Error for optional header: name can not be null or empty. |\n|Error for optional header: name can not be null or empty. | Error for optional header: name can not be null or empty. |\n|Error for optional header [{header.Name}]: value can not be null or empty | Error for optional header [{header.Name}]: value can not be null or empty|\n|Error for header [{header.Name}]: name of custom headers should start with 'X-'.|Error for header [{header.Name}]: name of custom headers should start with 'X-'.|\n|Error for header {header.Name}: A field name MUST be composed of printable US - ASCII characters (i.e., characters that have values between 33 and 126, inclusive), except colon|Error for header {header.Name}: A field name MUST be composed of printable US - ASCII characters (i.e., characters that have values between 33 and 126, inclusive), except colon|\n|Error for header {header.Value}:A field value MUST be composed of US - ASCII characters|Error for header {header.Value}:A field value MUST be composed of US - ASCII characters|\n|The api call does not support recipient overrides. Change the addressee instead.|The api call does not support recipient overrides. Change the addressee instead.|\n\n#### Mobile error codes\n\n| Code | Description |\n| ----------------------------- | --------------------------------------------------------------------------- | \n|INVALID_EMPTY_TOKEN | Device token is required for bulk send. | \n|INVALID_EMPTY_TITLE | Push notification title is mandatory when sending none silent notification. |\n|INVALID_EMPTY_BODY | Push notification body is mandatory when sending none silent notification. |\n|MISSING_APP_CONFIG | No configuration available for this Mobile App.\"; |\n|MISSING_PROVIDER_CONFIG_APPLE | Not credentials are defined for 'apple'. |\n|MISSING_PROVIDER_CONFIG_GOOGLE | Not credentials are defined for 'google'. |\n|MISSING_PROVIDER_CONFIG_HUAWEI | Not credentials are defined for 'huawei'. |\n|UNKNOWN_PROVIDER | Unknown provider '{0}'. |\n|BRCST_OPERATION_NOT_FOUND | Broadcast operation not found. |\n|INAPP_CONTENT_NOT_ALLOWED | InApp content is not allowed for simple push type. Use 'PushWithInApp' type of 'Silent'. |\n|INVALID_INAPP_EMPTY_TITLE | InApp content title is mandatory. |\n|INVALID_INAPP_EMPTY_BODY | InApp content body is mandatory. |\n|INVALID_TEMPLATE_REFERENCE | Invalid template reference specified. |\n\n\n\n# OpenAPI specification\n\nWe provide the API specification in the format of OpenApi files which can be found in the openapi/ directory:\n\n- OpenAPI 3.0 - JSON format :: sdc-api-rest-v1.openapi.json\n- OpenAPI 3.0 - YAML format :: sdc-api-rest-v1.openapi.yaml\n\nThe older Swagger/OpenAPI 2.0 is also available, but will be deprecated over time, since we are in favor of newer OpenAPI specification 3.0.\n\n- Swagger/OpenAPI 2.0 - JSON format :: sdc-api-rest-v1.swagger.json\n\n# Postman collection\n\nTo get you up and running and provide a hands-on experience, we provide an up-to-date Postman collection of the SDC API V1.\n\n\n\nImport the Postman collection through any of the methods specified below.\n\n\n- Use the link: postman/sdc-api-rest-v1.postman.json via \"Import\" > \"Link\"\n- Download the file sdc-api-rest-v1.postman.json and import the file via \"Import\" > \"File\"\n- Download the file sdc-api-rest-v1.postman.json and copy the contents and paste in the \"Import\" > Paste \"Raw Text\" section.\n\nThis collection takes advantage of Postman variables and environments to store/access your Selligent Oauth Client key/secret and base\nURL.\n\n\n\n\n\n\n\n\n\n\nContact Support:\n Name: Team Selligent\n Email: info@zetaglobal.com", "type": "text/plain" } } }