{ "_": { "postman_id": "c1b92fc4-90f0-4a23-a6b0-25a0d3f1255d" }, "item": [ { "id": "0a2db3ce-a506-46df-a8ce-f2d1e295af6a", "name": "Medium", "description": { "content": "All medium endpoints", "type": "text/plain" }, "item": [ { "id": "202264ff-3c07-4994-9ae9-b215c114b830", "name": "List mediums", "request": { "name": "List mediums", "description": { "content": "List defined medium configurations.", "type": "text/plain" }, "url": { "path": [ "mediums" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter mediums by medium type.", "type": "text/plain" }, "key": "filter", "value": "AmazonS3" }, { "disabled": false, "description": { "content": "Search with a specific name, api_name, description or tag(s).", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" }, { "disabled": false, "description": { "content": "The maximum amount of items to return.", "type": "text/plain" }, "key": "take", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "8763e58b-9503-4944-a936-8fb13c486447", "name": "OK", "originalRequest": { "url": { "path": [ "mediums" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter mediums by medium type.", "type": "text/plain" }, "key": "filter", "value": "AmazonS3" }, { "disabled": false, "description": { "content": "Search with a specific name, api_name, description or tag(s).", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" }, { "disabled": false, "description": { "content": "The maximum amount of items to return.", "type": "text/plain" }, "key": "take", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"mediums\": [\n {\n \"type\": \"Ftp\",\n \"api_name\": \"medium_ftp\"\n },\n {\n \"type\": \"Url\",\n \"api_name\": \"medium_url\"\n },\n {\n \"type\": \"Repository\",\n \"api_name\": \"medium_repository\"\n },\n {\n \"type\": \"AmazonS3\",\n \"api_name\": \"medium_amazonS3\"\n },\n {\n \"type\": \"AzureBlob\",\n \"api_name\": \"medium_azureBlob\"\n },\n {\n \"type\": \"GoogleCloud\",\n \"api_name\": \"medium_googleCloud\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "74b3c24a-928e-43ee-9ae9-666c13411f6a", "name": "Bad request", "originalRequest": { "url": { "path": [ "mediums" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter mediums by medium type.", "type": "text/plain" }, "key": "filter", "value": "AmazonS3" }, { "disabled": false, "description": { "content": "Search with a specific name, api_name, description or tag(s).", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" }, { "disabled": false, "description": { "content": "The maximum amount of items to return.", "type": "text/plain" }, "key": "take", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_ADMIN_CONFIG_INVALIDMEDIUMTYPE\",\n \"description\": \"Invalid medium type provided.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "56028e91-a316-42b1-a01b-a8169ccc343e", "name": "Get medium", "request": { "name": "Get medium", "description": { "content": "Retrieve medium (Ftp/Url/Repository/AmazonS3) details.", "type": "text/plain" }, "url": { "path": [ "mediums", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API name of the medium.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "3cb393c4-6523-4c87-86cf-d8ce2c559030", "name": "OK", "originalRequest": { "url": { "path": [ "mediums", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"A Repository storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "text" }, "id": "08e5dce7-9467-424f-807c-c9304472154f", "name": "Not found", "originalRequest": { "url": { "path": [ "mediums", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cc23c253-6a7d-4c32-8bbe-9cb512ef987a", "name": "Delete medium", "request": { "name": "Delete medium", "description": { "content": "Use this endpoint to delete a medium.", "type": "text/plain" }, "url": { "path": [ "mediums", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API name of the medium.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "c345e97f-661b-4298-93ad-0c4bfa353eb4", "name": "Deleted", "originalRequest": { "url": { "path": [ "mediums", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The medium has been deleted successfully\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "40486b15-20a7-4674-9e46-d8599be9ab3b", "name": "Bad request", "originalRequest": { "url": { "path": [ "mediums", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_ADMIN_CONFIG_MEDIUMNOTFOUND\",\n \"description\": \"Medium not found.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a36957b1-6f43-46db-a438-d1b78e50a78e", "name": "Create AmazonS3 medium", "request": { "name": "Create AmazonS3 medium", "description": { "content": "Use this endpoint to create a AmazonS3 medium.", "type": "text/plain" }, "url": { "path": [ "mediums", "amazons3" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"An Amazon storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "714b3a5e-c372-4de5-8cf4-5e4f8ab55afb", "name": "Created", "originalRequest": { "url": { "path": [ "mediums", "amazons3" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"An Amazon storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Medium created successfully.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "dcbfac97-14bf-4c07-90e1-2416512b3ca7", "name": "Bad request", "originalRequest": { "url": { "path": [ "mediums", "amazons3" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"An Amazon storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_ADMIN_CONFIG_INVALIDBRAND\",\n \"description\": \"Organization 'Organization1' does not exist.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8661e36a-30e8-45aa-ab93-f6f738010c58", "name": "Update AmazonS3 medium", "request": { "name": "Update AmazonS3 medium", "description": { "content": "Update a AmazonS3 medium.", "type": "text/plain" }, "url": { "path": [ "mediums", "amazons3", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API name of the medium.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"An Amazon storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "76d45eb0-32f0-4291-b38a-cf855dffafa1", "name": "Updated", "originalRequest": { "url": { "path": [ "mediums", "amazons3", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"An Amazon storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Medium updated successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "56d257aa-0e4d-4039-8cee-f34923bfc2dd", "name": "Bad request", "originalRequest": { "url": { "path": [ "mediums", "amazons3", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"An Amazon storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_MEDIUM_VALIDATION\",\n \"description\": \"Failed to update medium\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "af11dc7d-09f4-4f76-ac42-46e7b0953784", "name": "Create Azureblob medium", "request": { "name": "Create Azureblob medium", "description": { "content": "Create an Azureblob medium.", "type": "text/plain" }, "url": { "path": [ "mediums", "azureblob" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"An Microsoft Azureblob storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "0a61f275-d9e1-4eaf-86d4-3c66f14c05f2", "name": "Created", "originalRequest": { "url": { "path": [ "mediums", "azureblob" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"An Microsoft Azureblob storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Medium created successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "86a4a212-9231-41ca-b67a-24c4bb1984a4", "name": "Bad request", "originalRequest": { "url": { "path": [ "mediums", "azureblob" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"An Microsoft Azureblob storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1475a257-d360-4b9c-9602-f847dc9fce4e", "name": "Update Azureblob medium", "request": { "name": "Update Azureblob medium", "description": { "content": "Update an Azureblob medium.", "type": "text/plain" }, "url": { "path": [ "mediums", "azureblob", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API name of the medium.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"An Microsoft Azureblob storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "106e041b-4dec-4590-be8a-81f7e1e64efc", "name": "Updated", "originalRequest": { "url": { "path": [ "mediums", "azureblob", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"An Microsoft Azureblob storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Medium updated successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "d0ec571c-8da7-465a-8449-d6d21f4b190b", "name": "Bad request", "originalRequest": { "url": { "path": [ "mediums", "azureblob", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"An Microsoft Azureblob storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_MEDIUM_VALIDATION\",\n \"description\": \"Failed to update medium\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6bb2e878-63d5-4a38-840b-17f3f68aa207", "name": "Create FTP medium", "request": { "name": "Create FTP medium", "description": { "content": "Create a FTP medium.", "type": "text/plain" }, "url": { "path": [ "mediums", "ftp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"medium_1\",\n \"ftp_type\": \"Ftps\",\n \"login\": \"Admin\",\n \"name\": \"Medium One\",\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ],\n \"password\": \"Password\",\n \"server\": \"An Ftp medium.\",\n \"description\": \"A storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "dd2c40f2-7236-4ccb-b375-671e1ee7c6ac", "name": "Created", "originalRequest": { "url": { "path": [ "mediums", "ftp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"medium_1\",\n \"ftp_type\": \"Ftps\",\n \"login\": \"Admin\",\n \"name\": \"Medium One\",\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ],\n \"password\": \"Password\",\n \"server\": \"An Ftp medium.\",\n \"description\": \"A storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Medium created successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "2b239708-a29f-4025-ba43-15b8fba36287", "name": "Bad request", "originalRequest": { "url": { "path": [ "mediums", "ftp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"medium_1\",\n \"ftp_type\": \"Ftps\",\n \"login\": \"Admin\",\n \"name\": \"Medium One\",\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ],\n \"password\": \"Password\",\n \"server\": \"An Ftp medium.\",\n \"description\": \"A storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ba5c73b8-6c01-4a3b-8ad0-2bfefb97607f", "name": "Update FTP medium", "request": { "name": "Update FTP medium", "description": { "content": "Update a FTP medium.", "type": "text/plain" }, "url": { "path": [ "mediums", "ftp", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API name of the medium.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"medium_1\",\n \"name\": \"Medium One\",\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ],\n \"description\": \"A storage medium.\",\n \"ftp_type\": \"Ftps\",\n \"server\": \"An Ftp medium.\",\n \"login\": \"Admin\",\n \"password\": \"Password\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "77d5bf4e-5628-4c65-a893-dbf063428003", "name": "Updated", "originalRequest": { "url": { "path": [ "mediums", "ftp", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"medium_1\",\n \"name\": \"Medium One\",\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ],\n \"description\": \"A storage medium.\",\n \"ftp_type\": \"Ftps\",\n \"server\": \"An Ftp medium.\",\n \"login\": \"Admin\",\n \"password\": \"Password\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Medium updated successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "0e142116-0e0f-4591-997d-ec160d8d6d82", "name": "Bad request", "originalRequest": { "url": { "path": [ "mediums", "ftp", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"medium_1\",\n \"name\": \"Medium One\",\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ],\n \"description\": \"A storage medium.\",\n \"ftp_type\": \"Ftps\",\n \"server\": \"An Ftp medium.\",\n \"login\": \"Admin\",\n \"password\": \"Password\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_MEDIUM_VALIDATION\",\n \"description\": \"Failed to update medium\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dae2780a-2b69-485c-8a5e-6901cab351cd", "name": "Create GOOGLECLOUD medium", "request": { "name": "Create GOOGLECLOUD medium", "description": { "content": "Create a GOOGLECLOUD medium.", "type": "text/plain" }, "url": { "path": [ "mediums", "googlecloud" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"An google Cloud storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "ac76e329-7b50-4e84-9f74-69b759f7e587", "name": "Created", "originalRequest": { "url": { "path": [ "mediums", "googlecloud" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"An google Cloud storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Medium created successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "9138d5f3-ff75-43e8-9875-a7be0337b53a", "name": "Bad request", "originalRequest": { "url": { "path": [ "mediums", "googlecloud" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"An google Cloud storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d7de9e2b-c5ee-403f-97cc-9c2485c85ff6", "name": "Update GOOGLECLOUD medium", "request": { "name": "Update GOOGLECLOUD medium", "description": { "content": "Update a GOOGLECLOUD medium.", "type": "text/plain" }, "url": { "path": [ "mediums", "googlecloud", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API name of the medium.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"An google Cloud storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "ea1402ee-1edf-4bbb-9f56-69ffcadb78af", "name": "updated", "originalRequest": { "url": { "path": [ "mediums", "googlecloud", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"An google Cloud storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Medium updated successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "209e711b-e491-4682-8cb6-b26a64877b0b", "name": "Bad request", "originalRequest": { "url": { "path": [ "mediums", "googlecloud", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"An google Cloud storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_MEDIUM_VALIDATION\",\n \"description\": \"Failed to update medium\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "75f4cd41-7172-4b53-ad3a-819f45433586", "name": "Create Repository medium", "request": { "name": "Create Repository medium", "description": { "content": "Create a Repository medium.", "type": "text/plain" }, "url": { "path": [ "mediums", "repository" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"A Repository storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "38ff7542-5876-456b-b3d0-6611abacb697", "name": "Created", "originalRequest": { "url": { "path": [ "mediums", "repository" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"A Repository storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Medium created successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "cf3ebda3-19b1-4ada-bccd-0ac1ee0410d0", "name": "Bad request", "originalRequest": { "url": { "path": [ "mediums", "repository" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"description\": \"A Repository storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c8923710-82a8-482d-b468-33610ef03166", "name": "Update Repository medium", "request": { "name": "Update Repository medium", "description": { "content": "Update a Repository medium.", "type": "text/plain" }, "url": { "path": [ "mediums", "repository", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API name of the medium.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"A Repository storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "a0435694-f65d-4ab8-b096-b4502e03d5fb", "name": "Updated", "originalRequest": { "url": { "path": [ "mediums", "repository", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"A Repository storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Medium updated successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "42ec9108-40e0-4ba5-a97e-945840953c3f", "name": "Bad request", "originalRequest": { "url": { "path": [ "mediums", "repository", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"A Repository storage medium.\",\n \"subfolder\": \"sub_folder_1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_MEDIUM_VALIDATION\",\n \"description\": \"Failed to update medium\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "050cd135-3832-4c4b-a91d-cc2e3fa667aa", "name": "Create URL medium", "request": { "name": "Create URL medium", "description": { "content": "Create a URL medium", "type": "text/plain" }, "url": { "path": [ "mediums", "url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"medium_1\",\n \"login\": \"Admin\",\n \"name\": \"Medium One\",\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ],\n \"password\": \"Password\",\n \"url\": \"https://www.testurl.com\",\n \"description\": \"A storage medium.\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "99281dc8-9daf-41fe-b817-81aaa33f2710", "name": "Created", "originalRequest": { "url": { "path": [ "mediums", "url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"medium_1\",\n \"login\": \"Admin\",\n \"name\": \"Medium One\",\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ],\n \"password\": \"Password\",\n \"url\": \"https://www.testurl.com\",\n \"description\": \"A storage medium.\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Medium created successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "7ba0333d-71a7-45d6-b9da-8e24dad01110", "name": "Bad request", "originalRequest": { "url": { "path": [ "mediums", "url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"medium_1\",\n \"login\": \"Admin\",\n \"name\": \"Medium One\",\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ],\n \"password\": \"Password\",\n \"url\": \"https://www.testurl.com\",\n \"description\": \"A storage medium.\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8cc9664e-7a17-480a-8c63-9cb9c9e2ad88", "name": "Update URL medium", "request": { "name": "Update URL medium", "description": { "content": "Update a URL medium.", "type": "text/plain" }, "url": { "path": [ "mediums", "url", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API name of the medium.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"medium_1\",\n \"name\": \"Medium One\",\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ],\n \"description\": \"A storage medium.\",\n \"url\": \"https://www.testurl.com\",\n \"login\": \"Admin\",\n \"password\": \"Password\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "e290f878-c4fa-4cc6-8a64-cee4ac1e5df5", "name": "Updated", "originalRequest": { "url": { "path": [ "mediums", "url", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"medium_1\",\n \"name\": \"Medium One\",\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ],\n \"description\": \"A storage medium.\",\n \"url\": \"https://www.testurl.com\",\n \"login\": \"Admin\",\n \"password\": \"Password\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Medium updated successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "d8081b9b-f57a-4899-aa6c-6428c25f41cc", "name": "Bad request", "originalRequest": { "url": { "path": [ "mediums", "url", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"medium_1\",\n \"name\": \"Medium One\",\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ],\n \"description\": \"A storage medium.\",\n \"url\": \"https://www.testurl.com\",\n \"login\": \"Admin\",\n \"password\": \"Password\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_MEDIUM_VALIDATION\",\n \"description\": \"Failed to update medium\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e30abc4-b4ee-48d7-874c-5d0f95f298ae", "name": "List organization mediums", "request": { "name": "List organization mediums", "description": { "content": "Use this endpoint to get list of all mediums mapped to an organization.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "mediums" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter mediums by medium type.", "type": "text/plain" }, "key": "filter", "value": "AmazonS3" }, { "disabled": false, "description": { "content": "Search with a specific name, api_name, description or tag(s).", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" }, { "disabled": false, "description": { "content": "The maximum amount of items to return.", "type": "text/plain" }, "key": "take", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "b9d13b64-ba41-4273-97ab-011ecfbce543", "name": "This endpoint will retrieve list of mediums of an organization.", "originalRequest": { "url": { "path": [ "organizations", ":organization", "mediums" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter mediums by medium type.", "type": "text/plain" }, "key": "filter", "value": "AmazonS3" }, { "disabled": false, "description": { "content": "Search with a specific name, api_name, description or tag(s).", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" }, { "disabled": false, "description": { "content": "The maximum amount of items to return.", "type": "text/plain" }, "key": "take", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"mediums\": [\n {\n \"type\": \"Ftp\",\n \"api_name\": \"medium_ftp\"\n },\n {\n \"type\": \"Url\",\n \"api_name\": \"medium_url\"\n },\n {\n \"type\": \"Repository\",\n \"api_name\": \"medium_repository\"\n },\n {\n \"type\": \"AmazonS3\",\n \"api_name\": \"medium_amazonS3\"\n },\n {\n \"type\": \"AzureBlob\",\n \"api_name\": \"medium_azureBlob\"\n },\n {\n \"type\": \"GoogleCloud\",\n \"api_name\": \"medium_googleCloud\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "88cdbaf8-eb72-4a08-89a3-8c853835fba9", "name": "Represents a response for an unsuccessful retrieval in case of invalid medium type.", "originalRequest": { "url": { "path": [ "organizations", ":organization", "mediums" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter mediums by medium type.", "type": "text/plain" }, "key": "filter", "value": "AmazonS3" }, { "disabled": false, "description": { "content": "Search with a specific name, api_name, description or tag(s).", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" }, { "disabled": false, "description": { "content": "The maximum amount of items to return.", "type": "text/plain" }, "key": "take", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_ADMIN_CONFIG_INVALIDMEDIUMTYPE\",\n \"description\": \"Invalid medium type provided.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "bcc4438f-ecc4-4941-bd21-35e77c77bef1", "name": "Organization", "description": { "content": "All organization endpoints", "type": "text/plain" }, "item": [ { "id": "f4cd355a-c1fe-4633-a247-e4ec30191bff", "name": "Get organization", "request": { "name": "Get organization", "description": { "content": "Retrieve the details of this organization set up on your instance of Selligent Marketing Cloud.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "625e91c0-8585-429d-a3ce-2feeb9159ca0", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"My First Organization\",\n \"image_reference\": \"ref_1\",\n \"image_type\": \"png\",\n \"languages\": [\n {\n \"name\": \"English\",\n \"code\": \"en\",\n \"locale\": \"en-US\"\n },\n {\n \"name\": \"French\",\n \"code\": \"fr\",\n \"locale\": \"fr-FR\"\n }\n ],\n \"audiences\": [\n {\n \"api_name\": \"main_user_list\"\n },\n {\n \"api_name\": \"main_user_list\"\n }\n ],\n \"campaign_data_sources\": [\n {\n \"name\": \"pariatur\"\n },\n {\n \"name\": \"irure non fugiat\"\n }\n ],\n \"default_languages\": [\n \"English\",\n \"French\"\n ],\n \"default_maildomain\": \"zetaglobal.com\",\n \"sms_endpoint\": \"SMS\",\n \"mms_endpoint\": \"MMS\",\n \"mobile_push_endpoint\": \"Mobile\",\n \"facebook_endpoint\": \"Facebook\",\n \"google_customer_match_endpoint\": \"Google\",\n \"snapchat_endpoint\": \"Snapchat\",\n \"twitter_endpoint\": \"Twitter\",\n \"linkedin_endpoint\": \"LinkedIn\",\n \"whatsapp_template_endpoint\": \"WhatsApp\",\n \"trackers\": [\n {\n \"name\": \"Shopping Tracker\"\n },\n {\n \"name\": \"Basket Tracker\"\n }\n ],\n \"connector_instances\": [\n {\n \"name\": \"Connector Tracker 1\"\n },\n {\n \"name\": \"Salesforce Connector\"\n }\n ],\n \"mediums\": [\n {\n \"api_name\": \"ftp_medium_1\"\n },\n {\n \"api_name\": \"url_medium_2\"\n }\n ],\n \"taglists\": [\n {\n \"api_name\": \"Sports_Taglist\"\n },\n {\n \"api_name\": \"Food_Taglist\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "6574df23-7a4f-4d22-ab55-54ab618aca16", "name": "CIM", "description": { "content": "All cim endpoints", "type": "text/plain" }, "item": [ { "id": "dabc3052-4e57-4767-af96-aa4be9e1d0ae", "name": "Create CIM collect request", "request": { "name": "Create CIM collect request", "description": { "content": "Create a request to collect customer(s) information in the specified list, based on the provided filters.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "cim", ":api_name", "collect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the user list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filters\": [\n {\n \"field\": \"email\",\n \"value\": \"user@gmail.xyz\"\n },\n {\n \"field\": \"email\",\n \"value\": \"user@gmail.xyz\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "0a0b560c-e180-491e-a07b-7a5f34fbf195", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "cim", ":api_name", "collect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filters\": [\n {\n \"field\": \"email\",\n \"value\": \"user@gmail.xyz\"\n },\n {\n \"field\": \"email\",\n \"value\": \"user@gmail.xyz\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 123\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "48da1626-5578-4d9e-bca0-9a7d6f1997c1", "name": "Create CIM optout request", "request": { "name": "Create CIM optout request", "description": { "content": "Create a request to optout customer(s) in the specified list, based on the provided filters.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "cim", ":api_name", "optout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the user list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filters\": [\n {\n \"field\": \"email\",\n \"value\": \"user@gmail.xyz\"\n },\n {\n \"field\": \"email\",\n \"value\": \"user@gmail.xyz\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "f5b519e7-4ebc-4826-8060-5e83399d6470", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "cim", ":api_name", "optout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filters\": [\n {\n \"field\": \"email\",\n \"value\": \"user@gmail.xyz\"\n },\n {\n \"field\": \"email\",\n \"value\": \"user@gmail.xyz\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 123\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5079243a-ea4c-4dce-9bf7-eb246bf7180d", "name": "Create CIM remove request", "request": { "name": "Create CIM remove request", "description": { "content": "Create a request to remove customer(s) information in the specified list, based on the provided filters.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "cim", ":api_name", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the user list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filters\": [\n {\n \"field\": \"email\",\n \"value\": \"user@gmail.xyz\"\n },\n {\n \"field\": \"email\",\n \"value\": \"user@gmail.xyz\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "a9139020-fb86-4dbe-a381-c3b45e834f53", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "cim", ":api_name", "remove" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filters\": [\n {\n \"field\": \"email\",\n \"value\": \"user@gmail.xyz\"\n },\n {\n \"field\": \"email\",\n \"value\": \"user@gmail.xyz\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 123\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "15eaf098-570f-4edc-b3e0-c53ffb92c336", "name": "Get CIM request payload", "request": { "name": "Get CIM request payload", "description": { "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "cim", "request", ":requestId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) Id of the Customer information Management request.", "type": "text/plain" }, "type": "any", "value": "1", "key": "requestId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "c4050426-a2d9-4491-9e91-b08218c4c1e9", "name": "Returns the result of the request linked to the given requestId.", "originalRequest": { "url": { "path": [ "organizations", ":organization", "cim", "request", ":requestId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 123\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1234b9df-c1eb-498b-90a6-248280431c43", "name": "Cancel CIM request", "request": { "name": "Cancel CIM request", "description": { "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "cim", "request", ":requestId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) Id of the Customer information Management request.", "type": "text/plain" }, "type": "any", "value": "1", "key": "requestId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "3fb19e50-6e0d-4e44-a1a3-936ff718a813", "name": "Cancels the request linked to the given requestId. Only requests in state NEW can be cancelled.", "originalRequest": { "url": { "path": [ "organizations", ":organization", "cim", "request", ":requestId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 123\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bc40c8a3-1a8b-47ef-b6f4-c2b0b323f568", "name": "Get state of CIM request", "request": { "name": "Get state of CIM request", "description": { "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "cim", "request", ":requestId", "state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) Id of the Customer information Management request.", "type": "text/plain" }, "type": "any", "value": "1", "key": "requestId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "a88d593d-1307-4793-8987-ce183b8edad2", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "cim", "request", ":requestId", "state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"state\": \"Finished\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c0400c91-5c58-4949-939a-7f163d836954", "name": "Content", "description": { "content": "All content endpoints", "type": "text/plain" }, "item": [ { "id": "d75d05d5-37ab-42a3-912b-04dba91d5988", "name": "Get content", "request": { "name": "Get content", "description": { "content": "Returns information on the requested Content.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "content", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the content.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "02369b2d-f2c3-4fb4-85c7-808a7c61d48f", "name": "Object containing information about the requested content.", "originalRequest": { "url": { "path": [ "organizations", ":organization", "content", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"Email\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "775234af-838e-43d1-9b55-eebf819623a8", "name": "Remove content", "request": { "name": "Remove content", "description": { "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "content", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the content.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "6a261cad-d0fd-434d-9d95-c8664d6f1f8e", "name": "Content has been deleted.", "originalRequest": { "url": { "path": [ "organizations", ":organization", "content", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The content has been deleted successfully\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "9675d8fd-6417-4f64-b9b6-1bcfdd2adb06", "name": "Content could not be deleted.", "originalRequest": { "url": { "path": [ "organizations", ":organization", "content", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Failed\",\n \"message\": null,\n \"errors\": [\n {\n \"error_code\": \"ERR_CONTENT_VALIDATION_CONTENTISLOCK\",\n \"description\": \"Failed to delete the content since it is locked.\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b7b638d1-e56e-4132-a12b-242e61978e8a", "name": "Get content lock state", "request": { "name": "Get content lock state", "description": { "content": "returns the lock state (being edited by someone) of the requested Content.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "content", ":api_name", "lockstate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the content.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "5552e8cc-ce86-4368-be52-705fef230058", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "content", ":api_name", "lockstate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"lockstate\": \"locked\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3501fb50-c9fe-4a8c-a3a5-fbde4aaf831e", "name": "Unlock content", "request": { "name": "Unlock content", "description": { "content": "Forces an unlock for the requested Content.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "content", ":api_name", "unlock" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the content.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "e6fb3f96-f0ad-4913-9cf9-776036c78d14", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "content", ":api_name", "unlock" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The content has been unlocked successfully\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "dc2d9b52-f043-4d3d-b854-e3e89dd99723", "name": "Error ocurred while unlocking the content.", "originalRequest": { "url": { "path": [ "organizations", ":organization", "content", ":api_name", "unlock" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Failed\",\n \"message\": \"An Error occurred while unlocking the content\",\n \"errors\": [\n {\n \"error_code\": \"UNLOCKCONTENTFAILED\",\n \"description\": \"Failed to unlock content\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "263622bf-e1dc-46bd-b69b-877b85016393", "name": "Create email", "request": { "name": "Create email", "description": { "content": "API to create simple (only html) single language message of email.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "content", "email" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Indicate if the content should be published.", "type": "text/plain" }, "key": "publish", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\"\n },\n \"headers\": {\n \"nullaf\": [\n {\n \"from_domain\": \"zetaglobal.com\",\n \"from_alias\": \"Selligent\",\n \"to_alias\": \"John Doe\",\n \"preheader\": \"Your preheader text\",\n \"subject\": \"Your subjectline\",\n \"reply_email\": \"help@zetaglobal.com\",\n \"reply_alias\": \"Selligent Help\",\n \"from_address\": \"info@zetaglobal.com\",\n \"deliverygroup_api_name\": \"delivery_group_1\"\n },\n {\n \"from_domain\": \"zetaglobal.com\",\n \"from_alias\": \"Selligent\",\n \"to_alias\": \"John Doe\",\n \"preheader\": \"Your preheader text\",\n \"subject\": \"Your subjectline\",\n \"reply_email\": \"help@zetaglobal.com\",\n \"reply_alias\": \"Selligent Help\",\n \"from_address\": \"info@zetaglobal.com\",\n \"deliverygroup_api_name\": \"delivery_group_1\"\n }\n ],\n \"voluptate05\": [\n {\n \"from_domain\": \"zetaglobal.com\",\n \"from_alias\": \"Selligent\",\n \"to_alias\": \"John Doe\",\n \"preheader\": \"Your preheader text\",\n \"subject\": \"Your subjectline\",\n \"reply_email\": \"help@zetaglobal.com\",\n \"reply_alias\": \"Selligent Help\",\n \"from_address\": \"info@zetaglobal.com\",\n \"deliverygroup_api_name\": \"delivery_group_1\"\n },\n {\n \"from_domain\": \"zetaglobal.com\",\n \"from_alias\": \"Selligent\",\n \"to_alias\": \"John Doe\",\n \"preheader\": \"Your preheader text\",\n \"subject\": \"Your subjectline\",\n \"reply_email\": \"help@zetaglobal.com\",\n \"reply_alias\": \"Selligent Help\",\n \"from_address\": \"info@zetaglobal.com\",\n \"deliverygroup_api_name\": \"delivery_group_1\"\n }\n ]\n },\n \"content\": {\n \"html\": \"

Hello World!

This is Rahul

\",\n \"text\": \"Hello World!\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "42fc7aa3-b27d-4195-bb7c-6174ad07f97c", "name": "Email message content created", "originalRequest": { "url": { "path": [ "organizations", ":organization", "content", "email" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Indicate if the content should be published.", "type": "text/plain" }, "key": "publish", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\"\n },\n \"headers\": {\n \"nullaf\": [\n {\n \"from_domain\": \"zetaglobal.com\",\n \"from_alias\": \"Selligent\",\n \"to_alias\": \"John Doe\",\n \"preheader\": \"Your preheader text\",\n \"subject\": \"Your subjectline\",\n \"reply_email\": \"help@zetaglobal.com\",\n \"reply_alias\": \"Selligent Help\",\n \"from_address\": \"info@zetaglobal.com\",\n \"deliverygroup_api_name\": \"delivery_group_1\"\n },\n {\n \"from_domain\": \"zetaglobal.com\",\n \"from_alias\": \"Selligent\",\n \"to_alias\": \"John Doe\",\n \"preheader\": \"Your preheader text\",\n \"subject\": \"Your subjectline\",\n \"reply_email\": \"help@zetaglobal.com\",\n \"reply_alias\": \"Selligent Help\",\n \"from_address\": \"info@zetaglobal.com\",\n \"deliverygroup_api_name\": \"delivery_group_1\"\n }\n ],\n \"voluptate05\": [\n {\n \"from_domain\": \"zetaglobal.com\",\n \"from_alias\": \"Selligent\",\n \"to_alias\": \"John Doe\",\n \"preheader\": \"Your preheader text\",\n \"subject\": \"Your subjectline\",\n \"reply_email\": \"help@zetaglobal.com\",\n \"reply_alias\": \"Selligent Help\",\n \"from_address\": \"info@zetaglobal.com\",\n \"deliverygroup_api_name\": \"delivery_group_1\"\n },\n {\n \"from_domain\": \"zetaglobal.com\",\n \"from_alias\": \"Selligent\",\n \"to_alias\": \"John Doe\",\n \"preheader\": \"Your preheader text\",\n \"subject\": \"Your subjectline\",\n \"reply_email\": \"help@zetaglobal.com\",\n \"reply_alias\": \"Selligent Help\",\n \"from_address\": \"info@zetaglobal.com\",\n \"deliverygroup_api_name\": \"delivery_group_1\"\n }\n ]\n },\n \"content\": {\n \"html\": \"

Hello World!

This is Rahul

\",\n \"text\": \"Hello World!\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The Email message has been created successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "4c167899-b084-4bd9-9903-2cd3ed5dd93b", "name": "Email message content Not created", "originalRequest": { "url": { "path": [ "organizations", ":organization", "content", "email" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Indicate if the content should be published.", "type": "text/plain" }, "key": "publish", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\"\n },\n \"headers\": {\n \"nullaf\": [\n {\n \"from_domain\": \"zetaglobal.com\",\n \"from_alias\": \"Selligent\",\n \"to_alias\": \"John Doe\",\n \"preheader\": \"Your preheader text\",\n \"subject\": \"Your subjectline\",\n \"reply_email\": \"help@zetaglobal.com\",\n \"reply_alias\": \"Selligent Help\",\n \"from_address\": \"info@zetaglobal.com\",\n \"deliverygroup_api_name\": \"delivery_group_1\"\n },\n {\n \"from_domain\": \"zetaglobal.com\",\n \"from_alias\": \"Selligent\",\n \"to_alias\": \"John Doe\",\n \"preheader\": \"Your preheader text\",\n \"subject\": \"Your subjectline\",\n \"reply_email\": \"help@zetaglobal.com\",\n \"reply_alias\": \"Selligent Help\",\n \"from_address\": \"info@zetaglobal.com\",\n \"deliverygroup_api_name\": \"delivery_group_1\"\n }\n ],\n \"voluptate05\": [\n {\n \"from_domain\": \"zetaglobal.com\",\n \"from_alias\": \"Selligent\",\n \"to_alias\": \"John Doe\",\n \"preheader\": \"Your preheader text\",\n \"subject\": \"Your subjectline\",\n \"reply_email\": \"help@zetaglobal.com\",\n \"reply_alias\": \"Selligent Help\",\n \"from_address\": \"info@zetaglobal.com\",\n \"deliverygroup_api_name\": \"delivery_group_1\"\n },\n {\n \"from_domain\": \"zetaglobal.com\",\n \"from_alias\": \"Selligent\",\n \"to_alias\": \"John Doe\",\n \"preheader\": \"Your preheader text\",\n \"subject\": \"Your subjectline\",\n \"reply_email\": \"help@zetaglobal.com\",\n \"reply_alias\": \"Selligent Help\",\n \"from_address\": \"info@zetaglobal.com\",\n \"deliverygroup_api_name\": \"delivery_group_1\"\n }\n ]\n },\n \"content\": {\n \"html\": \"

Hello World!

This is Rahul

\",\n \"text\": \"Hello World!\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dfc1309e-1bac-474c-8c37-49d0b5ca7c55", "name": "Create MMS", "request": { "name": "Create MMS", "description": { "content": "Create an MMS template.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "content", "mms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Indicate if the content should be published.", "type": "text/plain" }, "key": "publish", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\"\n },\n \"content\": {\n \"my_language_code\": {\n \"text\": \"Hello world!\",\n \"media_type\": \"IMAGE\",\n \"media_url\": \"URL to the media\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "ad5c3484-d6fc-4b49-8e15-8b84ec2e1ef0", "name": "MMS created", "originalRequest": { "url": { "path": [ "organizations", ":organization", "content", "mms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Indicate if the content should be published.", "type": "text/plain" }, "key": "publish", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\"\n },\n \"content\": {\n \"my_language_code\": {\n \"text\": \"Hello world!\",\n \"media_type\": \"IMAGE\",\n \"media_url\": \"URL to the media\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The MMS message has been created successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "df1cdf07-69b8-4c1e-9d21-0a0e9ac0e344", "name": "Could not create MMS", "originalRequest": { "url": { "path": [ "organizations", ":organization", "content", "mms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Indicate if the content should be published.", "type": "text/plain" }, "key": "publish", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\"\n },\n \"content\": {\n \"my_language_code\": {\n \"text\": \"Hello world!\",\n \"media_type\": \"IMAGE\",\n \"media_url\": \"URL to the media\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "94817fc4-f05d-4cca-a6e7-7329d958b579", "name": "Create mobile push", "request": { "name": "Create mobile push", "description": { "content": "API to create a Mobile push message.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "content", "mobile" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Indicate if the content should be published.", "type": "text/plain" }, "key": "publish", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\",\n \"mobile_app_api_name\": \"mobile_device_list_1\"\n },\n \"mobile_properties\": {\n \"distribution_type\": \"MobilePush\",\n \"custom_in_app_content\": true,\n \"in_app_content_type\": \"Image\",\n \"rich_push_content_enabled\": true,\n \"rich_push_content_type\": \"Image\",\n \"expiration_date\": \"2025-01-01\"\n },\n \"content\": {\n \"adipisicing_3\": [\n {\n \"mobile_push\": {\n \"title\": \"Check this out!\",\n \"content\": \"Isn't this great as a body text?\"\n },\n \"in_app\": {\n \"content\": {\n \"text\": \"Great message!\",\n \"url\": \"https://zetaglobal.com\"\n },\n \"title\": \"We have news!\",\n \"in_app_buttons\": {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n },\n \"rich_push\": {\n \"content\": {\n \"image\": \"https://zetaglobal.com/assets/logo/zeta_logoLandscape_1Color_WHITE.png\"\n }\n },\n \"banner_buttons\": [\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ],\n \"main_action\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"mobile_push\": {\n \"title\": \"Check this out!\",\n \"content\": \"Isn't this great as a body text?\"\n },\n \"in_app\": {\n \"content\": {\n \"text\": \"Great message!\",\n \"url\": \"https://zetaglobal.com\"\n },\n \"title\": \"We have news!\",\n \"in_app_buttons\": {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n },\n \"rich_push\": {\n \"content\": {\n \"image\": \"https://zetaglobal.com/assets/logo/zeta_logoLandscape_1Color_WHITE.png\"\n }\n },\n \"banner_buttons\": [\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ],\n \"main_action\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ],\n \"commodo_c70\": [\n {\n \"mobile_push\": {\n \"title\": \"Check this out!\",\n \"content\": \"Isn't this great as a body text?\"\n },\n \"in_app\": {\n \"content\": {\n \"text\": \"Great message!\",\n \"url\": \"https://zetaglobal.com\"\n },\n \"title\": \"We have news!\",\n \"in_app_buttons\": {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n },\n \"rich_push\": {\n \"content\": {\n \"image\": \"https://zetaglobal.com/assets/logo/zeta_logoLandscape_1Color_WHITE.png\"\n }\n },\n \"banner_buttons\": [\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ],\n \"main_action\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"mobile_push\": {\n \"title\": \"Check this out!\",\n \"content\": \"Isn't this great as a body text?\"\n },\n \"in_app\": {\n \"content\": {\n \"text\": \"Great message!\",\n \"url\": \"https://zetaglobal.com\"\n },\n \"title\": \"We have news!\",\n \"in_app_buttons\": {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n },\n \"rich_push\": {\n \"content\": {\n \"image\": \"https://zetaglobal.com/assets/logo/zeta_logoLandscape_1Color_WHITE.png\"\n }\n },\n \"banner_buttons\": [\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ],\n \"main_action\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "f960c08d-0e14-4109-957f-df5d11c272c3", "name": "Mobile push created.", "originalRequest": { "url": { "path": [ "organizations", ":organization", "content", "mobile" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Indicate if the content should be published.", "type": "text/plain" }, "key": "publish", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\",\n \"mobile_app_api_name\": \"mobile_device_list_1\"\n },\n \"mobile_properties\": {\n \"distribution_type\": \"MobilePush\",\n \"custom_in_app_content\": true,\n \"in_app_content_type\": \"Image\",\n \"rich_push_content_enabled\": true,\n \"rich_push_content_type\": \"Image\",\n \"expiration_date\": \"2025-01-01\"\n },\n \"content\": {\n \"adipisicing_3\": [\n {\n \"mobile_push\": {\n \"title\": \"Check this out!\",\n \"content\": \"Isn't this great as a body text?\"\n },\n \"in_app\": {\n \"content\": {\n \"text\": \"Great message!\",\n \"url\": \"https://zetaglobal.com\"\n },\n \"title\": \"We have news!\",\n \"in_app_buttons\": {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n },\n \"rich_push\": {\n \"content\": {\n \"image\": \"https://zetaglobal.com/assets/logo/zeta_logoLandscape_1Color_WHITE.png\"\n }\n },\n \"banner_buttons\": [\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ],\n \"main_action\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"mobile_push\": {\n \"title\": \"Check this out!\",\n \"content\": \"Isn't this great as a body text?\"\n },\n \"in_app\": {\n \"content\": {\n \"text\": \"Great message!\",\n \"url\": \"https://zetaglobal.com\"\n },\n \"title\": \"We have news!\",\n \"in_app_buttons\": {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n },\n \"rich_push\": {\n \"content\": {\n \"image\": \"https://zetaglobal.com/assets/logo/zeta_logoLandscape_1Color_WHITE.png\"\n }\n },\n \"banner_buttons\": [\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ],\n \"main_action\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ],\n \"commodo_c70\": [\n {\n \"mobile_push\": {\n \"title\": \"Check this out!\",\n \"content\": \"Isn't this great as a body text?\"\n },\n \"in_app\": {\n \"content\": {\n \"text\": \"Great message!\",\n \"url\": \"https://zetaglobal.com\"\n },\n \"title\": \"We have news!\",\n \"in_app_buttons\": {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n },\n \"rich_push\": {\n \"content\": {\n \"image\": \"https://zetaglobal.com/assets/logo/zeta_logoLandscape_1Color_WHITE.png\"\n }\n },\n \"banner_buttons\": [\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ],\n \"main_action\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"mobile_push\": {\n \"title\": \"Check this out!\",\n \"content\": \"Isn't this great as a body text?\"\n },\n \"in_app\": {\n \"content\": {\n \"text\": \"Great message!\",\n \"url\": \"https://zetaglobal.com\"\n },\n \"title\": \"We have news!\",\n \"in_app_buttons\": {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n },\n \"rich_push\": {\n \"content\": {\n \"image\": \"https://zetaglobal.com/assets/logo/zeta_logoLandscape_1Color_WHITE.png\"\n }\n },\n \"banner_buttons\": [\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ],\n \"main_action\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The Mobile message has been created successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "2ec5b572-c190-453c-b8af-68ee4841ba71", "name": "Could not create mobile push", "originalRequest": { "url": { "path": [ "organizations", ":organization", "content", "mobile" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Indicate if the content should be published.", "type": "text/plain" }, "key": "publish", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\",\n \"mobile_app_api_name\": \"mobile_device_list_1\"\n },\n \"mobile_properties\": {\n \"distribution_type\": \"MobilePush\",\n \"custom_in_app_content\": true,\n \"in_app_content_type\": \"Image\",\n \"rich_push_content_enabled\": true,\n \"rich_push_content_type\": \"Image\",\n \"expiration_date\": \"2025-01-01\"\n },\n \"content\": {\n \"adipisicing_3\": [\n {\n \"mobile_push\": {\n \"title\": \"Check this out!\",\n \"content\": \"Isn't this great as a body text?\"\n },\n \"in_app\": {\n \"content\": {\n \"text\": \"Great message!\",\n \"url\": \"https://zetaglobal.com\"\n },\n \"title\": \"We have news!\",\n \"in_app_buttons\": {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n },\n \"rich_push\": {\n \"content\": {\n \"image\": \"https://zetaglobal.com/assets/logo/zeta_logoLandscape_1Color_WHITE.png\"\n }\n },\n \"banner_buttons\": [\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ],\n \"main_action\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"mobile_push\": {\n \"title\": \"Check this out!\",\n \"content\": \"Isn't this great as a body text?\"\n },\n \"in_app\": {\n \"content\": {\n \"text\": \"Great message!\",\n \"url\": \"https://zetaglobal.com\"\n },\n \"title\": \"We have news!\",\n \"in_app_buttons\": {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n },\n \"rich_push\": {\n \"content\": {\n \"image\": \"https://zetaglobal.com/assets/logo/zeta_logoLandscape_1Color_WHITE.png\"\n }\n },\n \"banner_buttons\": [\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ],\n \"main_action\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ],\n \"commodo_c70\": [\n {\n \"mobile_push\": {\n \"title\": \"Check this out!\",\n \"content\": \"Isn't this great as a body text?\"\n },\n \"in_app\": {\n \"content\": {\n \"text\": \"Great message!\",\n \"url\": \"https://zetaglobal.com\"\n },\n \"title\": \"We have news!\",\n \"in_app_buttons\": {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n },\n \"rich_push\": {\n \"content\": {\n \"image\": \"https://zetaglobal.com/assets/logo/zeta_logoLandscape_1Color_WHITE.png\"\n }\n },\n \"banner_buttons\": [\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ],\n \"main_action\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"mobile_push\": {\n \"title\": \"Check this out!\",\n \"content\": \"Isn't this great as a body text?\"\n },\n \"in_app\": {\n \"content\": {\n \"text\": \"Great message!\",\n \"url\": \"https://zetaglobal.com\"\n },\n \"title\": \"We have news!\",\n \"in_app_buttons\": {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n },\n \"rich_push\": {\n \"content\": {\n \"image\": \"https://zetaglobal.com/assets/logo/zeta_logoLandscape_1Color_WHITE.png\"\n }\n },\n \"banner_buttons\": [\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ],\n \"main_action\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "54c37e5e-5086-4d7a-8b3b-4c11d32b0197", "name": "Create page", "request": { "name": "Create page", "description": { "content": "API to create single language page content.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "content", "page" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Indicate if the content should be published.", "type": "text/plain" }, "key": "publish", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\"\n },\n \"content\": {\n \"html\": \"

Hello World!

This is Rahul

\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "fffda7aa-e91d-448d-99ca-049f5a80253a", "name": "Page created", "originalRequest": { "url": { "path": [ "organizations", ":organization", "content", "page" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Indicate if the content should be published.", "type": "text/plain" }, "key": "publish", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\"\n },\n \"content\": {\n \"html\": \"

Hello World!

This is Rahul

\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The Page content has been created successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "1309c68f-4b14-4e8e-8016-ca61018f9e62", "name": "Could not create page", "originalRequest": { "url": { "path": [ "organizations", ":organization", "content", "page" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Indicate if the content should be published.", "type": "text/plain" }, "key": "publish", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\"\n },\n \"content\": {\n \"html\": \"

Hello World!

This is Rahul

\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df551fe6-a5a2-4a16-84a4-9405edc0879b", "name": "Create RCS", "request": { "name": "Create RCS", "description": { "content": "Create a single language RCS.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "content", "rcs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Indicate if the content should be published.", "type": "text/plain" }, "key": "publish", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\"\n },\n \"content\": {\n \"my_language_code\": {\n \"cards\": [\n {\n \"text\": \"Hello world!\",\n \"title\": \"Hello\",\n \"media_url\": \"http://my_website.com/videos/some_video.mp4\",\n \"media_thumbnail\": \"http://my_website.com/videos/some_video_preview.jpg\",\n \"buttons\": [\n {\n \"text\": \"sint officia dolore irure\",\n \"type\": \"reply\",\n \"url\": \"https://PVnYgCRbrxIoF.rveo32rTk15zpbKw3ZAeBbiz2Wj5-LKvcvOVZmBYV5HAMSu5g7YJKGF70YDvO8NWQ4xAO\",\n \"reply\": \"nostrud u\"\n },\n {\n \"text\": \"ad laboris\",\n \"type\": \"url\",\n \"url\": \"http://YaSTICDOFZDalsgVvL.bwp-iDnSuH+YIa5.Wa8+I4QX\",\n \"title\": \"sint eu proident do in\",\n \"start_time\": \"1984-07-01T07:19:25.113Z\",\n \"end_time\": \"1986-08-28T11:40:20.035Z\",\n \"description\": \"nulla magna Lorem cupidatat irure\",\n \"location\": \"dolore ut adipisicing\",\n \"fallback_url\": \"http://blbWhlzTXFPhOBYPaznEeulvTKL.pdaNCJIDQZYqe48cTQiobv4p1EYHhNAO7f5\",\n \"reply\": \"voluptate occaecat aliquip\"\n }\n ]\n },\n {\n \"text\": \"Hello world!\",\n \"title\": \"Hello\",\n \"media_url\": \"http://my_website.com/videos/some_video.mp4\",\n \"media_thumbnail\": \"http://my_website.com/videos/some_video_preview.jpg\",\n \"buttons\": [\n {\n \"text\": \"deserunt eiusmod\",\n \"type\": \"dial_number\",\n \"url\": \"http://uslIfMvSrtDaHugTNzkjEtSpQ.blwjBZDwR\",\n \"title\": \"fugiat dolor\",\n \"start_time\": \"2005-07-13T17:39:23.433Z\",\n \"end_time\": \"2023-05-29T06:39:22.703Z\",\n \"description\": \"cupidatat voluptate fugiat consectetur\",\n \"location\": \"occaecat qui eu\",\n \"fallback_url\": \"http://neoXSMmkuqYLxbnWqTIDDWS.cyiu89o57BrS.ILoSUEJQzHMDDot1+I\",\n \"reply\": \"fugiat aliquip ut pariatur\"\n },\n {\n \"text\": \"consectetur commodo laborum\",\n \"type\": \"share_location\",\n \"url\": \"https://MAOiawUXcQaFqBsBVEOYd.itysHO,AOuV1t5P,yBENv,.PbbTxmziuSalcoCQ3SQI5ov7y1XWHlc+FTGIPDmM\",\n \"title\": \"ullamco\",\n \"start_time\": \"1970-10-28T18:28:36.400Z\",\n \"end_time\": \"2001-05-03T23:44:08.767Z\",\n \"description\": \"amet minim id\",\n \"location\": \"magna veniam\",\n \"fallback_url\": \"https://JfQXHUjfLCwzqpBoRGgP.eoC,SklFNhBjy6fMkNHsvF-CPpifyqtZA6wbW.foXs1.8dqvL41KKmf\",\n \"reply\": \"sint Lorem aliqua veniam\"\n }\n ]\n }\n ],\n \"fallback_sms\": \"We could not send an RCS, so here is SMS content.\",\n \"chips\": [\n {\n \"type\": \"url\",\n \"text\": \"commodo et\",\n \"url\": \"http://ysnIwsEaDqdsSqx.cquwdcrDKCDuympGDwhsfMvgzoR8hWiCdG9s+\"\n },\n {\n \"type\": \"url\",\n \"text\": \"dolore sunt exercitation reprehenderit\",\n \"url\": \"https://WJlPdZABzYZmjUjRCrhehj.grneaK53hXtUAWn1pffPGT9Q0yVntVOiXureDnFrr2f3A1ft6dK7NVH2vyXjFnu9\"\n }\n ]\n }\n },\n \"rcs_type\": \"RICH_CARD\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "e1bae034-260d-4ae4-870d-99e9da75b009", "name": "RCS created", "originalRequest": { "url": { "path": [ "organizations", ":organization", "content", "rcs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Indicate if the content should be published.", "type": "text/plain" }, "key": "publish", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\"\n },\n \"content\": {\n \"my_language_code\": {\n \"cards\": [\n {\n \"text\": \"Hello world!\",\n \"title\": \"Hello\",\n \"media_url\": \"http://my_website.com/videos/some_video.mp4\",\n \"media_thumbnail\": \"http://my_website.com/videos/some_video_preview.jpg\",\n \"buttons\": [\n {\n \"text\": \"sint officia dolore irure\",\n \"type\": \"reply\",\n \"url\": \"https://PVnYgCRbrxIoF.rveo32rTk15zpbKw3ZAeBbiz2Wj5-LKvcvOVZmBYV5HAMSu5g7YJKGF70YDvO8NWQ4xAO\",\n \"reply\": \"nostrud u\"\n },\n {\n \"text\": \"ad laboris\",\n \"type\": \"url\",\n \"url\": \"http://YaSTICDOFZDalsgVvL.bwp-iDnSuH+YIa5.Wa8+I4QX\",\n \"title\": \"sint eu proident do in\",\n \"start_time\": \"1984-07-01T07:19:25.113Z\",\n \"end_time\": \"1986-08-28T11:40:20.035Z\",\n \"description\": \"nulla magna Lorem cupidatat irure\",\n \"location\": \"dolore ut adipisicing\",\n \"fallback_url\": \"http://blbWhlzTXFPhOBYPaznEeulvTKL.pdaNCJIDQZYqe48cTQiobv4p1EYHhNAO7f5\",\n \"reply\": \"voluptate occaecat aliquip\"\n }\n ]\n },\n {\n \"text\": \"Hello world!\",\n \"title\": \"Hello\",\n \"media_url\": \"http://my_website.com/videos/some_video.mp4\",\n \"media_thumbnail\": \"http://my_website.com/videos/some_video_preview.jpg\",\n \"buttons\": [\n {\n \"text\": \"deserunt eiusmod\",\n \"type\": \"dial_number\",\n \"url\": \"http://uslIfMvSrtDaHugTNzkjEtSpQ.blwjBZDwR\",\n \"title\": \"fugiat dolor\",\n \"start_time\": \"2005-07-13T17:39:23.433Z\",\n \"end_time\": \"2023-05-29T06:39:22.703Z\",\n \"description\": \"cupidatat voluptate fugiat consectetur\",\n \"location\": \"occaecat qui eu\",\n \"fallback_url\": \"http://neoXSMmkuqYLxbnWqTIDDWS.cyiu89o57BrS.ILoSUEJQzHMDDot1+I\",\n \"reply\": \"fugiat aliquip ut pariatur\"\n },\n {\n \"text\": \"consectetur commodo laborum\",\n \"type\": \"share_location\",\n \"url\": \"https://MAOiawUXcQaFqBsBVEOYd.itysHO,AOuV1t5P,yBENv,.PbbTxmziuSalcoCQ3SQI5ov7y1XWHlc+FTGIPDmM\",\n \"title\": \"ullamco\",\n \"start_time\": \"1970-10-28T18:28:36.400Z\",\n \"end_time\": \"2001-05-03T23:44:08.767Z\",\n \"description\": \"amet minim id\",\n \"location\": \"magna veniam\",\n \"fallback_url\": \"https://JfQXHUjfLCwzqpBoRGgP.eoC,SklFNhBjy6fMkNHsvF-CPpifyqtZA6wbW.foXs1.8dqvL41KKmf\",\n \"reply\": \"sint Lorem aliqua veniam\"\n }\n ]\n }\n ],\n \"fallback_sms\": \"We could not send an RCS, so here is SMS content.\",\n \"chips\": [\n {\n \"type\": \"url\",\n \"text\": \"commodo et\",\n \"url\": \"http://ysnIwsEaDqdsSqx.cquwdcrDKCDuympGDwhsfMvgzoR8hWiCdG9s+\"\n },\n {\n \"type\": \"url\",\n \"text\": \"dolore sunt exercitation reprehenderit\",\n \"url\": \"https://WJlPdZABzYZmjUjRCrhehj.grneaK53hXtUAWn1pffPGT9Q0yVntVOiXureDnFrr2f3A1ft6dK7NVH2vyXjFnu9\"\n }\n ]\n }\n },\n \"rcs_type\": \"RICH_CARD\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The RCS message has been created successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "b0a1a260-586a-407d-8dc1-ee59d3c57682", "name": "Could not create RCS", "originalRequest": { "url": { "path": [ "organizations", ":organization", "content", "rcs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Indicate if the content should be published.", "type": "text/plain" }, "key": "publish", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\"\n },\n \"content\": {\n \"my_language_code\": {\n \"cards\": [\n {\n \"text\": \"Hello world!\",\n \"title\": \"Hello\",\n \"media_url\": \"http://my_website.com/videos/some_video.mp4\",\n \"media_thumbnail\": \"http://my_website.com/videos/some_video_preview.jpg\",\n \"buttons\": [\n {\n \"text\": \"sint officia dolore irure\",\n \"type\": \"reply\",\n \"url\": \"https://PVnYgCRbrxIoF.rveo32rTk15zpbKw3ZAeBbiz2Wj5-LKvcvOVZmBYV5HAMSu5g7YJKGF70YDvO8NWQ4xAO\",\n \"reply\": \"nostrud u\"\n },\n {\n \"text\": \"ad laboris\",\n \"type\": \"url\",\n \"url\": \"http://YaSTICDOFZDalsgVvL.bwp-iDnSuH+YIa5.Wa8+I4QX\",\n \"title\": \"sint eu proident do in\",\n \"start_time\": \"1984-07-01T07:19:25.113Z\",\n \"end_time\": \"1986-08-28T11:40:20.035Z\",\n \"description\": \"nulla magna Lorem cupidatat irure\",\n \"location\": \"dolore ut adipisicing\",\n \"fallback_url\": \"http://blbWhlzTXFPhOBYPaznEeulvTKL.pdaNCJIDQZYqe48cTQiobv4p1EYHhNAO7f5\",\n \"reply\": \"voluptate occaecat aliquip\"\n }\n ]\n },\n {\n \"text\": \"Hello world!\",\n \"title\": \"Hello\",\n \"media_url\": \"http://my_website.com/videos/some_video.mp4\",\n \"media_thumbnail\": \"http://my_website.com/videos/some_video_preview.jpg\",\n \"buttons\": [\n {\n \"text\": \"deserunt eiusmod\",\n \"type\": \"dial_number\",\n \"url\": \"http://uslIfMvSrtDaHugTNzkjEtSpQ.blwjBZDwR\",\n \"title\": \"fugiat dolor\",\n \"start_time\": \"2005-07-13T17:39:23.433Z\",\n \"end_time\": \"2023-05-29T06:39:22.703Z\",\n \"description\": \"cupidatat voluptate fugiat consectetur\",\n \"location\": \"occaecat qui eu\",\n \"fallback_url\": \"http://neoXSMmkuqYLxbnWqTIDDWS.cyiu89o57BrS.ILoSUEJQzHMDDot1+I\",\n \"reply\": \"fugiat aliquip ut pariatur\"\n },\n {\n \"text\": \"consectetur commodo laborum\",\n \"type\": \"share_location\",\n \"url\": \"https://MAOiawUXcQaFqBsBVEOYd.itysHO,AOuV1t5P,yBENv,.PbbTxmziuSalcoCQ3SQI5ov7y1XWHlc+FTGIPDmM\",\n \"title\": \"ullamco\",\n \"start_time\": \"1970-10-28T18:28:36.400Z\",\n \"end_time\": \"2001-05-03T23:44:08.767Z\",\n \"description\": \"amet minim id\",\n \"location\": \"magna veniam\",\n \"fallback_url\": \"https://JfQXHUjfLCwzqpBoRGgP.eoC,SklFNhBjy6fMkNHsvF-CPpifyqtZA6wbW.foXs1.8dqvL41KKmf\",\n \"reply\": \"sint Lorem aliqua veniam\"\n }\n ]\n }\n ],\n \"fallback_sms\": \"We could not send an RCS, so here is SMS content.\",\n \"chips\": [\n {\n \"type\": \"url\",\n \"text\": \"commodo et\",\n \"url\": \"http://ysnIwsEaDqdsSqx.cquwdcrDKCDuympGDwhsfMvgzoR8hWiCdG9s+\"\n },\n {\n \"type\": \"url\",\n \"text\": \"dolore sunt exercitation reprehenderit\",\n \"url\": \"https://WJlPdZABzYZmjUjRCrhehj.grneaK53hXtUAWn1pffPGT9Q0yVntVOiXureDnFrr2f3A1ft6dK7NVH2vyXjFnu9\"\n }\n ]\n }\n },\n \"rcs_type\": \"RICH_CARD\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3c0b1744-af6d-492b-a136-e89bab3fd8d9", "name": "Create SMS", "request": { "name": "Create SMS", "description": { "content": "Create a single language SMS.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "content", "sms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Indicate if the content should be published.", "type": "text/plain" }, "key": "publish", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\"\n },\n \"content\": {\n \"text\": \"Hello world!\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "7d164d78-5484-4e97-898b-8c3ead503d68", "name": "SMS created", "originalRequest": { "url": { "path": [ "organizations", ":organization", "content", "sms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Indicate if the content should be published.", "type": "text/plain" }, "key": "publish", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\"\n },\n \"content\": {\n \"text\": \"Hello world!\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The SMS message has been created successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "9c4e7a53-fb1e-4d3b-8195-6c55d121979d", "name": "Could not create SMS", "originalRequest": { "url": { "path": [ "organizations", ":organization", "content", "sms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Indicate if the content should be published.", "type": "text/plain" }, "key": "publish", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\"\n },\n \"content\": {\n \"text\": \"Hello world!\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f756824b-80a2-408c-83ed-5c487740ebda", "name": "Dictionary", "description": { "content": "All dictionary endpoints", "type": "text/plain" }, "item": [ { "id": "7cbcbd4f-bbac-4f8a-89e1-647d5ec137e9", "name": "List dictionaries", "request": { "name": "List dictionaries", "description": { "content": "List dictionaries matching the given criteria.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "dictionaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search with a specific name, api_name, description or tag(s).", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" }, { "disabled": false, "description": { "content": "The maximum amount of items to return.", "type": "text/plain" }, "key": "take", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "222f70b8-5be1-4453-97c0-2797d84639d8", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "dictionaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search with a specific name, api_name, description or tag(s).", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" }, { "disabled": false, "description": { "content": "The maximum amount of items to return.", "type": "text/plain" }, "key": "take", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"dictionaries\": [\n {\n \"api_name\": \"dictionary_1\"\n },\n {\n \"api_name\": \"dictionary_1\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "afee46c8-02e9-4ce1-b9d7-5e897e6b99b3", "name": "Create dictionary", "request": { "name": "Create dictionary", "description": { "content": "Create a dictionary.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "dictionaries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Email Message\",\n \"api_name\": \"dictionary_1\",\n \"description\": \"Description for the dictionary.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "a214a14e-5a6a-46c5-87b7-e339b9728ca2", "name": "Created", "originalRequest": { "url": { "path": [ "organizations", ":organization", "dictionaries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Email Message\",\n \"api_name\": \"dictionary_1\",\n \"description\": \"Description for the dictionary.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Dictionary created successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "c3034d74-9c77-41d1-beb7-5fb55b863fb7", "name": "Failed to create dictionary", "originalRequest": { "url": { "path": [ "organizations", ":organization", "dictionaries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Email Message\",\n \"api_name\": \"dictionary_1\",\n \"description\": \"Description for the dictionary.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_LABEL_VALIDATION\",\n \"description\": \"Failed to create dictionary.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "67668a14-9ba9-4124-9520-93d248e2ee12", "name": "Get dictionary", "request": { "name": "Get dictionary", "description": { "content": "Use this endpoint to get details of the dictionary with the given API name.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "dictionaries", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the dictionary.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "8d014998-5b64-4b0a-8063-aec586518ca6", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "dictionaries", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"api_name\": \"dictionary_1\",\n \"name\": \"Email Message\",\n \"description\": \"Description for the dictionary.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ],\n \"not_accessible_organizations_count\": 1\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "56ce88d5-57e2-4073-a51a-d5b76412adae", "name": "Update dictionary", "request": { "name": "Update dictionary", "description": { "content": "Use this endpoint to update an existing dictionary.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "dictionaries", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the dictionary.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"dictionary_1\",\n \"description\": \"Description for the dictionary.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "f3817fba-2e63-4393-a665-e15a44622f97", "name": "Updated", "originalRequest": { "url": { "path": [ "organizations", ":organization", "dictionaries", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"dictionary_1\",\n \"description\": \"Description for the dictionary.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Dictionary updated successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "586d6557-2925-43be-a479-6feff55177fa", "name": "Failed to update", "originalRequest": { "url": { "path": [ "organizations", ":organization", "dictionaries", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"dictionary_1\",\n \"description\": \"Description for the dictionary.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_LABEL_VALIDATION\",\n \"description\": \"Failed to update dictionary.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25e9760a-98aa-4a20-8e0c-242286855bdc", "name": "Delete dictionary", "request": { "name": "Delete dictionary", "description": { "content": "Use this endpoint to delete an existing dictionary.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "dictionaries", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the dictionary.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "7967947f-f022-4422-af3e-354f8f3fac33", "name": "Deleted", "originalRequest": { "url": { "path": [ "organizations", ":organization", "dictionaries", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Dictionary deleted successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "432ca746-9551-4549-ba08-66dc87de61a1", "name": "Failed to delete", "originalRequest": { "url": { "path": [ "organizations", ":organization", "dictionaries", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Failed to delete dictionary.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "303de604-697a-470b-b79b-54b120ef3a5e", "name": "Dictionary Labels", "description": { "content": "All endpoints to change labels inside a dictionary", "type": "text/plain" }, "item": [ { "id": "280cf291-9928-4177-a097-17424fe6c4fb", "name": "List dictionary labels", "request": { "name": "List dictionary labels", "description": { "content": "List labels for a particular dictionary.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "dictionaries", ":api_name", "labels" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search with a specific name, api_name, description or tag(s).", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" }, { "disabled": false, "description": { "content": "The maximum amount of items to return.", "type": "text/plain" }, "key": "take", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the data import.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "f5ce626b-bc79-4d86-ab7c-300bc90a9c83", "name": "This endpoint will retrieve all labels for a specified dictionary with given api_name.", "originalRequest": { "url": { "path": [ "organizations", ":organization", "dictionaries", ":api_name", "labels" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search with a specific name, api_name, description or tag(s).", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" }, { "disabled": false, "description": { "content": "The maximum amount of items to return.", "type": "text/plain" }, "key": "take", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"labels\": [\n {\n \"label\": \"label_1\",\n \"translations\": {\n \"EN\": \"Label1_English\",\n \"DE\": \"Label1_Dutch\"\n }\n },\n {\n \"label\": \"label_1\",\n \"translations\": {\n \"EN\": \"Label1_English\",\n \"DE\": \"Label1_Dutch\"\n }\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "08dd7b08-4469-4827-8654-69f149a401fb", "name": "Create dictionary label", "request": { "name": "Create dictionary label", "description": { "content": "Use this endpoint to create a label in a dictionary.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "dictionaries", ":api_name", "labels" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Weither or now we should sync the labels with their translations.", "type": "text/plain" }, "key": "sync", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the dictionary.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"label_1\",\n \"translations\": {\n \"EN\": \"Label1_English\",\n \"DE\": \"Label1_Dutch\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "cf527d15-8193-409d-aa15-ce8012edab4b", "name": "Created Label", "originalRequest": { "url": { "path": [ "organizations", ":organization", "dictionaries", ":api_name", "labels" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Weither or now we should sync the labels with their translations.", "type": "text/plain" }, "key": "sync", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"label_1\",\n \"translations\": {\n \"EN\": \"Label1_English\",\n \"DE\": \"Label1_Dutch\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Label created successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "dc2d33f7-dbb6-4f5d-962d-621eb18875ed", "name": "Failed to create label", "originalRequest": { "url": { "path": [ "organizations", ":organization", "dictionaries", ":api_name", "labels" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Weither or now we should sync the labels with their translations.", "type": "text/plain" }, "key": "sync", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"label_1\",\n \"translations\": {\n \"EN\": \"Label1_English\",\n \"DE\": \"Label1_Dutch\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_LABEL_VALIDATION\",\n \"description\": \"Failed to create label.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "05751cb7-3ffe-47ed-896e-6dabc92958a8", "name": "Update dictionary label", "request": { "name": "Update dictionary label", "description": { "content": "Use this endpoint to update an existing label in a dictionary.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "dictionaries", ":api_name", "labels", ":label" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Weither or now we should sync the labels with their translations.", "type": "text/plain" }, "key": "sync", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the data import.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) Identifier of the label.", "type": "text/plain" }, "type": "any", "value": "aute aliquip occaecat", "key": "label" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"translations\": {\n \"EN\": \"Label1_English\",\n \"DE\": \"Label1_Dutch\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "f7c974b3-6da8-40b1-817f-1903519ae154", "name": "This endpoint will update an existing label.", "originalRequest": { "url": { "path": [ "organizations", ":organization", "dictionaries", ":api_name", "labels", ":label" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Weither or now we should sync the labels with their translations.", "type": "text/plain" }, "key": "sync", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"translations\": {\n \"EN\": \"Label1_English\",\n \"DE\": \"Label1_Dutch\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Label updated successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "05c9423e-129a-42e7-9ea1-ae1727d395da", "name": "Failed to update label.", "originalRequest": { "url": { "path": [ "organizations", ":organization", "dictionaries", ":api_name", "labels", ":label" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Weither or now we should sync the labels with their translations.", "type": "text/plain" }, "key": "sync", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"translations\": {\n \"EN\": \"Label1_English\",\n \"DE\": \"Label1_Dutch\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_LABEL_VALIDATION\",\n \"description\": \"Failed to update label.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2f85c798-9163-42a3-8865-4f7c39d4313e", "name": "Delete dictionary label", "request": { "name": "Delete dictionary label", "description": { "content": "Use this endpoint to delete a label in a dictionary.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "dictionaries", ":api_name", "labels", ":label" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the dictionary.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) Identifier of the label.", "type": "text/plain" }, "type": "any", "value": "aute aliquip occaecat", "key": "label" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "742cfce1-4282-4377-a7ae-b5a206e37a70", "name": "Deleted", "originalRequest": { "url": { "path": [ "organizations", ":organization", "dictionaries", ":api_name", "labels", ":label" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Label deleted successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "ede842b2-656c-4e5a-837a-67a080d8093d", "name": "Failed to delete", "originalRequest": { "url": { "path": [ "organizations", ":organization", "dictionaries", ":api_name", "labels", ":label" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Failed to delete label.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "1ffdea97-74a6-483c-8845-13d198bb4b9b", "name": "Notification Group", "description": { "content": "All notification group endpoints", "type": "text/plain" }, "item": [ { "id": "4792818d-b4f4-46f2-a086-30ef47265f71", "name": "List notification groups", "request": { "name": "List notification groups", "description": { "content": "Retrieve all the notification groups.", "type": "text/plain" }, "url": { "path": [ "notificationgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "5cb0175d-31f5-42e5-a6a1-59255e96b5b2", "name": "OK", "originalRequest": { "url": { "path": [ "notificationgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"notification_groups\": [\n {\n \"api_name\": \"notification_group_1\"\n },\n {\n \"api_name\": \"notification_group_1\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "83df50db-b061-4601-a888-46e75fccb1c1", "name": "Create notification group", "request": { "name": "Create notification group", "description": { "content": "Create a new notification group.", "type": "text/plain" }, "url": { "path": [ "notificationgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"notification_group_1\",\n \"name\": \"Notification Group 1\",\n \"email_addresses\": [\n \"john.doe@example.com\",\n \"john.doe1@example.com\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "b579c128-281c-4266-9a9b-2f386aa9d958", "name": "Created", "originalRequest": { "url": { "path": [ "notificationgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"notification_group_1\",\n \"name\": \"Notification Group 1\",\n \"email_addresses\": [\n \"john.doe@example.com\",\n \"john.doe1@example.com\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Notification group saved successfully.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "0082f60c-4f71-46da-a366-e0594d306920", "name": "Bad request", "originalRequest": { "url": { "path": [ "notificationgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"notification_group_1\",\n \"name\": \"Notification Group 1\",\n \"email_addresses\": [\n \"john.doe@example.com\",\n \"john.doe1@example.com\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a99e0739-c1cb-431a-b651-f2550df3919f", "name": "Get notification group", "request": { "name": "Get notification group", "description": { "content": "Get the details of the notification group with given API name.", "type": "text/plain" }, "url": { "path": [ "notificationgroups", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API name of the notification group.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "8c4b1b2d-85c0-4aed-93bb-382d06503175", "name": "OK", "originalRequest": { "url": { "path": [ "notificationgroups", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"api_name\": \"notification_group_1\",\n \"name\": \"Notification Group 1\",\n \"email_addresses\": [\n \"john.doe@example.com\",\n \"john.doe1@example.com\"\n ],\n \"users\": [\n \"John Doe\",\n \"Johanna Doe\"\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ad71e100-f672-42e6-99eb-acc91c55d6d4", "name": "Update notification group", "request": { "name": "Update notification group", "description": { "content": "Update the properties of the given notification group.", "type": "text/plain" }, "url": { "path": [ "notificationgroups", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API name of the notification group.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"notification_group_1\",\n \"name\": \"Notification Group 1\",\n \"email_addresses\": [\n \"john.doe@example.com\",\n \"john.doe1@example.com\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "933490eb-68f9-4800-83eb-b2b0382645f6", "name": "Updated", "originalRequest": { "url": { "path": [ "notificationgroups", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"notification_group_1\",\n \"name\": \"Notification Group 1\",\n \"email_addresses\": [\n \"john.doe@example.com\",\n \"john.doe1@example.com\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Notification group saved successfully.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "70faa146-f45d-4071-bd28-4e8e4c4b2bce", "name": "Bad request", "originalRequest": { "url": { "path": [ "notificationgroups", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"notification_group_1\",\n \"name\": \"Notification Group 1\",\n \"email_addresses\": [\n \"john.doe@example.com\",\n \"john.doe1@example.com\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "80064871-a586-4b84-9534-eda267dcabfd", "name": "Delete notification group", "request": { "name": "Delete notification group", "description": { "content": "Delete a notification group.", "type": "text/plain" }, "url": { "path": [ "notificationgroups", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API name of the notification group.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "57f0113b-2536-4605-8e42-6a521623fb32", "name": "Deleted", "originalRequest": { "url": { "path": [ "notificationgroups", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Notification group deleted successfully.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "81e9b479-ef2a-468c-9987-bd0287c0bfaf", "name": "Bad request", "originalRequest": { "url": { "path": [ "notificationgroups", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Failed to delete notification group.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ed3abae3-4569-44e8-988f-900bb2a9175c", "name": "Data Export", "description": { "content": "All data export endpoints", "type": "text/plain" }, "item": [ { "id": "3b17fcbb-00d5-4b92-9faa-7f3dad2362d5", "name": "Delete data export", "request": { "name": "Delete data export", "description": { "content": "Use this endpoint to delete a data export.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "exports", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the data export.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "e8c2fb20-86f3-44e7-8e7d-deee934ea596", "name": "Deleted", "originalRequest": { "url": { "path": [ "organizations", ":organization", "exports", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Data export has been deleted successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "d39d0c50-c812-49c6-95e9-79d7c9b35627", "name": "Could not delete export", "originalRequest": { "url": { "path": [ "organizations", ":organization", "exports", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Failed to delete data export.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "207a54fc-f728-41c4-a9bf-18d332c5ca59", "name": "Folder", "description": { "content": "All folder endpoints", "type": "text/plain" }, "item": [ { "id": "faaf6b5f-75a1-4d07-8f3e-74229e351662", "name": "Create folder", "request": { "name": "Create folder", "description": { "content": "Use this endpoint to create a folder.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "folders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"folder_1\",\n \"parent_folder_id\": 1\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "c371c5a5-3f95-457d-843e-1b8b162605f0", "name": "The folder was successfully created in the given organization, under the provided parent folder.", "originalRequest": { "url": { "path": [ "organizations", ":organization", "folders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"folder_1\",\n \"parent_folder_id\": 1\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"folder\": {\n \"id\": 1,\n \"name\": \"folder_1\"\n }\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "8895559d-e72f-4027-81d4-a71d98ceed1c", "name": "Failed to create folder", "originalRequest": { "url": { "path": [ "organizations", ":organization", "folders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"folder_1\",\n \"parent_folder_id\": 1\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_LABEL_VALIDATION\",\n \"description\": \"Name already exists.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "abfa9983-013b-4447-95fa-9c73a353ac32", "name": "Get folder tree", "request": { "name": "Get folder tree", "description": { "content": "Use this endpoint to retrieve the contents of a folder on the given organization.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "folders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "1", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "109eb22c-1fe2-4bb1-8c63-b612b533091d", "name": "This endpoint will retrieve the contents of a folder on the given organization.", "originalRequest": { "url": { "path": [ "organizations", ":organization", "folders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"id\": 100,\n \"name\": \"TestFolder\",\n \"children\": [\n {\n \"id\": 10,\n \"name\": \"folder_1\",\n \"type\": \"FOLDER\"\n },\n {\n \"name\": \"TestTemplate\",\n \"api_name\": \"TestTemplate\",\n \"type\": \"TMP\",\n \"leaf_type\": \"Template\"\n },\n {\n \"name\": \"TestEmail\",\n \"api_name\": \"TestEmail\",\n \"type\": \"TMP\",\n \"leaf_type\": \"Email\"\n },\n {\n \"name\": \"TestMobilePush\",\n \"api_name\": \"TestMobilePush\",\n \"type\": \"TMP\",\n \"leaf_type\": \"MobilePush\"\n },\n {\n \"name\": \"TestPage\",\n \"api_name\": \"TestPage\",\n \"type\": \"TMP\",\n \"leaf_type\": \"Page\"\n },\n {\n \"name\": \"TestDataSync\",\n \"api_name\": \"TestDataSync\",\n \"type\": \"CRMDATASYNC\",\n \"leaf_type\": \"CRMDataSync\"\n },\n {\n \"name\": \"TestImport\",\n \"api_name\": \"TestImport\",\n \"type\": \"IMPORT\",\n \"leaf_type\": \"ImportConfig\"\n },\n {\n \"name\": \"TestTask\",\n \"api_name\": \"TestTask\",\n \"type\": \"TASK\",\n \"leaf_type\": \"Sql\"\n },\n {\n \"name\": \"TestCustomComponent\",\n \"api_name\": \"TestCustomComponent\",\n \"type\": \"CUSTOMCOMPONENTS\",\n \"leaf_type\": \"CustomComponent\"\n },\n {\n \"name\": \"TestList\",\n \"api_name\": \"TestList\",\n \"type\": \"LIST\",\n \"leaf_type\": \"Articlelist\"\n },\n {\n \"name\": \"TestContentBlock\",\n \"api_name\": \"TestContentBlock\",\n \"type\": \"CONTENTBLOCK\",\n \"leaf_type\": \"ContentBlock\"\n },\n {\n \"name\": \"TestSingleBatchJourney\",\n \"api_name\": \"TestSingleBatchJourney\",\n \"type\": \"EXEC\",\n \"leaf_type\": \"SingleBatch\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "48161e52-66dd-431a-bed1-5a1dec6dbaf3", "name": "Data Import", "description": { "content": "All data import endpoints", "type": "text/plain" }, "item": [ { "id": "1053f8b5-7451-4672-8a0a-bfd29f366c59", "name": "Delete data import", "request": { "name": "Delete data import", "description": { "content": "Use this endpoint to delete a data import.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "imports", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the data import.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "6c20814c-01c2-4c4a-8727-98ec92579ce9", "name": "Deleted", "originalRequest": { "url": { "path": [ "organizations", ":organization", "imports", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Data import has been deleted successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "49d52659-21f0-4754-9820-66be63feebc9", "name": "Could not delete Data Import", "originalRequest": { "url": { "path": [ "organizations", ":organization", "imports", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Failed to delete data import.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "53609b29-f626-4b33-8f68-a99f22130758", "name": "Journey", "description": { "content": "All journey endpoints", "type": "text/plain" }, "item": [ { "id": "22e3c2ea-4091-4e57-b6e1-5463369d53d0", "name": "list journeys", "request": { "name": "list journeys", "description": { "content": "Retrieve the last 1000 created journeys.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "4cdc7aca-dfc8-40fa-961b-d6f46c3ea17d", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"journeys\": [\n {\n \"api_name\": \"journey_1\",\n \"type\": \"singlebatch\"\n },\n {\n \"api_name\": \"journey_1\",\n \"type\": \"singlebatch\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f53cfe07-55e5-4ebe-a2bb-381cf75c087b", "name": "AB journey", "description": { "content": "Endpoints to create tests journeys to test your content", "type": "text/plain" }, "item": [ { "id": "83cdaa04-1abf-43fc-bd79-cb962508fe53", "name": "Get AB journey", "request": { "name": "Get AB journey", "description": { "content": "Use this endpoint to check whether AB journey already exists.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "ab", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the journey.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "0a922034-1afc-4031-8c4b-c070d9ec6a02", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "ab", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"api_name\": \"journey_1\",\n \"type\": \"ab\",\n \"name\": \"journey_1\",\n \"description\": \"this is the description.\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "68270069-cc53-401b-b72f-eba37432db47", "name": "Delete AB journey", "request": { "name": "Delete AB journey", "description": { "content": "Use this endpoint to delete existing AB journey.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "ab", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the journey.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "1138ff11-ce4c-4bd9-952b-aadef070c7c4", "name": "AB journey deleted", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "ab", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The journey has been deleted successfully\",\n \"errors\": []\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6b6079fd-92a2-4383-a2d7-f7178011b090", "name": "Create AB journey", "request": { "name": "Create AB journey", "description": { "content": "Use this endpoint to create an AB journey.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "ab" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"journey\": {\n \"api_name\": \"nulla minim in deseru\",\n \"name\": \"Christmas Campaign 1\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"deduplication\": {\n \"fields\": [\n \"MASTER.NAME\",\n \"MASTER.EMAIL\"\n ],\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n },\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"segment_api_name\": \"segment_1\",\n \"audience_filter\": \"endswith([MASTER.MAIL], '@my_company.com')\"\n },\n \"messages\": [\n {\n \"api_name\": \"message_1\",\n \"message_analytics_tag\": \"batch_2\"\n },\n {\n \"api_name\": \"message_1\",\n \"message_analytics_tag\": \"batch_2\"\n }\n ],\n \"test_settings\": {\n \"test_group_size\": 10,\n \"interval\": 1,\n \"interval_type\": \"Days\",\n \"criterium\": \"Clicks\"\n },\n \"folder\": \"106\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "5ce9297e-5e85-4a9e-878c-5ae21c2ed952", "name": "AB Journey created", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "ab" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"journey\": {\n \"api_name\": \"nulla minim in deseru\",\n \"name\": \"Christmas Campaign 1\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"deduplication\": {\n \"fields\": [\n \"MASTER.NAME\",\n \"MASTER.EMAIL\"\n ],\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n },\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"segment_api_name\": \"segment_1\",\n \"audience_filter\": \"endswith([MASTER.MAIL], '@my_company.com')\"\n },\n \"messages\": [\n {\n \"api_name\": \"message_1\",\n \"message_analytics_tag\": \"batch_2\"\n },\n {\n \"api_name\": \"message_1\",\n \"message_analytics_tag\": \"batch_2\"\n }\n ],\n \"test_settings\": {\n \"test_group_size\": 10,\n \"interval\": 1,\n \"interval_type\": \"Days\",\n \"criterium\": \"Clicks\"\n },\n \"folder\": \"106\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"journey\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"type\": \"singlebatch\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true\n },\n \"result_code\": \"PartiallySucceeded\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "7daf90b5-2604-4b00-b001-6ad2d26161c0", "name": "Bad request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "ab" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"journey\": {\n \"api_name\": \"nulla minim in deseru\",\n \"name\": \"Christmas Campaign 1\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"deduplication\": {\n \"fields\": [\n \"MASTER.NAME\",\n \"MASTER.EMAIL\"\n ],\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n },\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"segment_api_name\": \"segment_1\",\n \"audience_filter\": \"endswith([MASTER.MAIL], '@my_company.com')\"\n },\n \"messages\": [\n {\n \"api_name\": \"message_1\",\n \"message_analytics_tag\": \"batch_2\"\n },\n {\n \"api_name\": \"message_1\",\n \"message_analytics_tag\": \"batch_2\"\n }\n ],\n \"test_settings\": {\n \"test_group_size\": 10,\n \"interval\": 1,\n \"interval_type\": \"Days\",\n \"criterium\": \"Clicks\"\n },\n \"folder\": \"106\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"journey\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"type\": \"singlebatch\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true\n },\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ],\n \"result_code\": \"Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3a16e7f4-6277-43fd-91de-5cbc9d0561b4", "name": "Launch an AB journey", "request": { "name": "Launch an AB journey", "description": { "content": "Launch a specific AB journey journey given the schedule.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "ab", ":api_name", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the journey.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"launch_state\": \"launch\",\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "190438e3-ea66-4877-b0be-90167f841189", "name": "Launched", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "ab", ":api_name", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"launch_state\": \"launch\",\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The journey has been launched successfully.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "9621c548-177b-421d-ae51-9d54ccfab0df", "name": "Bad request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "ab", ":api_name", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"launch_state\": \"launch\",\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "4c330b6b-27c5-4666-8e5a-b17d82e3f86c", "name": "Not found", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "ab", ":api_name", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"launch_state\": \"launch\",\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "04d10058-275e-4661-9970-86f10e857d79", "name": "AB subject line journey", "description": { "content": "Endpoints to create AB tests for subject lines", "type": "text/plain" }, "item": [ { "id": "2d707209-c673-4be4-a33a-0037813c35ed", "name": "Get AB subject line journey", "request": { "name": "Get AB subject line journey", "description": { "content": "Use this endpoint to check whether AB subject line journey already exists.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "ab_subject", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the journey.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "621fec0a-9dd6-4002-92fd-5799d4f8e331", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "ab_subject", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"api_name\": \"journey_1\",\n \"type\": \"ab_subject\",\n \"name\": \"journey_1\",\n \"description\": \"this is the description.\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6481da8a-148a-4952-bf07-a8b650ccbb9a", "name": "Delete AB subject line journey", "request": { "name": "Delete AB subject line journey", "description": { "content": "Use this endpoint to delete existing AB subject line journey.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "ab_subject", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the journey.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "1271fba3-dbe5-4e0d-98d3-63816fe37e54", "name": "AB journey deleted", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "ab_subject", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The journey has been deleted successfully\",\n \"errors\": []\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fe36def6-4596-422a-8af0-2b613c6d263f", "name": "Create AB subject line journey", "request": { "name": "Create AB subject line journey", "description": { "content": "Use this endpoint to create an AB Subject line journey.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "ab_subject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"journey\": {\n \"api_name\": \"proident nostrud\",\n \"name\": \"Christmas Campaign 1\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"deduplication\": {\n \"fields\": [\n \"MASTER.NAME\",\n \"MASTER.EMAIL\"\n ],\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n },\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"segment_api_name\": \"segment_1\",\n \"audience_filter\": \"endswith([MASTER.MAIL], '@my_company.com')\"\n },\n \"message\": {\n \"api_name\": \"message_1\"\n },\n \"subjects\": [\n {\n \"message_analytics_tag\": \"batch_2\",\n \"text\": {\n \"quic1_\": \"This is a subject line\",\n \"proidentf5\": \"This is a subject line\"\n }\n },\n {\n \"message_analytics_tag\": \"batch_2\",\n \"text\": {\n \"commodo_d\": \"This is a subject line\",\n \"nisic\": \"This is a subject line\",\n \"cillum__0d\": \"This is a subject line\"\n }\n }\n ],\n \"test_settings\": {\n \"test_group_size\": 10,\n \"interval\": 1,\n \"interval_type\": \"Days\",\n \"criterium\": \"Clicks\"\n },\n \"folder\": \"106\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "ad90de51-de73-4c7c-80f8-5711fa5b8b18", "name": "AB subject line journey created", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "ab_subject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"journey\": {\n \"api_name\": \"proident nostrud\",\n \"name\": \"Christmas Campaign 1\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"deduplication\": {\n \"fields\": [\n \"MASTER.NAME\",\n \"MASTER.EMAIL\"\n ],\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n },\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"segment_api_name\": \"segment_1\",\n \"audience_filter\": \"endswith([MASTER.MAIL], '@my_company.com')\"\n },\n \"message\": {\n \"api_name\": \"message_1\"\n },\n \"subjects\": [\n {\n \"message_analytics_tag\": \"batch_2\",\n \"text\": {\n \"quic1_\": \"This is a subject line\",\n \"proidentf5\": \"This is a subject line\"\n }\n },\n {\n \"message_analytics_tag\": \"batch_2\",\n \"text\": {\n \"commodo_d\": \"This is a subject line\",\n \"nisic\": \"This is a subject line\",\n \"cillum__0d\": \"This is a subject line\"\n }\n }\n ],\n \"test_settings\": {\n \"test_group_size\": 10,\n \"interval\": 1,\n \"interval_type\": \"Days\",\n \"criterium\": \"Clicks\"\n },\n \"folder\": \"106\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"journey\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"type\": \"singlebatch\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true\n },\n \"result_code\": \"PartiallySucceeded\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "7a0714e8-8dfd-4194-ab42-467710d64101", "name": "Bad request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "ab_subject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"journey\": {\n \"api_name\": \"proident nostrud\",\n \"name\": \"Christmas Campaign 1\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"deduplication\": {\n \"fields\": [\n \"MASTER.NAME\",\n \"MASTER.EMAIL\"\n ],\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n },\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"segment_api_name\": \"segment_1\",\n \"audience_filter\": \"endswith([MASTER.MAIL], '@my_company.com')\"\n },\n \"message\": {\n \"api_name\": \"message_1\"\n },\n \"subjects\": [\n {\n \"message_analytics_tag\": \"batch_2\",\n \"text\": {\n \"quic1_\": \"This is a subject line\",\n \"proidentf5\": \"This is a subject line\"\n }\n },\n {\n \"message_analytics_tag\": \"batch_2\",\n \"text\": {\n \"commodo_d\": \"This is a subject line\",\n \"nisic\": \"This is a subject line\",\n \"cillum__0d\": \"This is a subject line\"\n }\n }\n ],\n \"test_settings\": {\n \"test_group_size\": 10,\n \"interval\": 1,\n \"interval_type\": \"Days\",\n \"criterium\": \"Clicks\"\n },\n \"folder\": \"106\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"journey\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"type\": \"singlebatch\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true\n },\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ],\n \"result_code\": \"Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b705608-b78b-4a4c-a934-f1d7e7208382", "name": "Launch an AB subject line journey", "request": { "name": "Launch an AB subject line journey", "description": { "content": "Launch a specific AB subject line journey given the schedule.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "ab_subject", ":api_name", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the journey.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"launch_state\": \"launch\",\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "45ba799b-6ae5-4ca9-aff8-e42750f55bc5", "name": "Launched", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "ab_subject", ":api_name", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"launch_state\": \"launch\",\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The journey has been launched successfully.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "abf8767b-5b9b-4240-b656-525053210336", "name": "Bad request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "ab_subject", ":api_name", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"launch_state\": \"launch\",\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "2ea1baf0-95a0-4f60-ae45-5ee167350a6e", "name": "Not found", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "ab_subject", ":api_name", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"launch_state\": \"launch\",\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "55fd0f70-f9bd-46de-be4c-3fc76eb5aec3", "name": "Recurring journey", "description": { "content": "All recurring journey endpoints", "type": "text/plain" }, "item": [ { "id": "9336a69f-855c-4167-ad79-572573dbde7f", "name": "Get recurring journey", "request": { "name": "Get recurring journey", "description": { "content": "retrieve information about the specified recurring journey, if it exists.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "recurring", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the journey.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "44d73cd9-3ed3-4254-ae23-d14c69a8577f", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "recurring", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"api_name\": \"journey_1\",\n \"type\": \"recurring\",\n \"name\": \"journey_1\",\n \"description\": \"this is the description.\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4743f153-447a-4345-8774-3213ae709d64", "name": "Delete recurring journey", "request": { "name": "Delete recurring journey", "description": { "content": "Delete an existing recurring journey.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "recurring", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the journey.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "d3344cf6-614e-490e-abfd-194d78acd8a5", "name": "Deleted", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "recurring", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The journey has been deleted successfully\",\n \"errors\": []\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "90024154-98ce-404e-97de-d63abe50fac3", "name": "Single Batch journey", "description": { "content": "All single batch journey endpoints", "type": "text/plain" }, "item": [ { "id": "3b2a8f20-2332-4926-a3a8-7bc1a0d4ee52", "name": "List Single Batch journeys", "request": { "name": "List Single Batch journeys", "description": { "content": "Use this endpoint to retrieve all journeys on the given organization of type Single Batch.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "43fb9b7c-c303-43da-9e87-e0beeaa3f983", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"journeys\": [\n {\n \"api_name\": \"api_name_1\",\n \"type\": \"singlebatch\"\n },\n {\n \"api_name\": \"api_name_2\",\n \"type\": \"singlebatch\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1155911e-ce31-4411-bc41-92318ccca72c", "name": "Create Single Batch journey", "request": { "name": "Create Single Batch journey", "description": { "content": "Use this endpoint to create a new Single-Batch journey.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"journey\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"deduplication\": {\n \"fields\": [\n \"MASTER.NAME\",\n \"MASTER.EMAIL\"\n ],\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true,\n \"segment_api_name\": \"segment_1\",\n \"audience_filter\": \"endswith([MASTER.MAIL], '@my_company.com')\"\n },\n \"message\": {\n \"api_name\": \"message_1\"\n },\n \"folder\": \"106\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "2501e374-5522-4bc9-bf69-0a5a7ca4a4cb", "name": "Created", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"journey\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"deduplication\": {\n \"fields\": [\n \"MASTER.NAME\",\n \"MASTER.EMAIL\"\n ],\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true,\n \"segment_api_name\": \"segment_1\",\n \"audience_filter\": \"endswith([MASTER.MAIL], '@my_company.com')\"\n },\n \"message\": {\n \"api_name\": \"message_1\"\n },\n \"folder\": \"106\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"journey\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"type\": \"singlebatch\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true\n },\n \"result_code\": \"PartiallySucceeded\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "7d915bba-2efd-4544-af7e-c52577aa60ed", "name": "Bad request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"journey\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"deduplication\": {\n \"fields\": [\n \"MASTER.NAME\",\n \"MASTER.EMAIL\"\n ],\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true,\n \"segment_api_name\": \"segment_1\",\n \"audience_filter\": \"endswith([MASTER.MAIL], '@my_company.com')\"\n },\n \"message\": {\n \"api_name\": \"message_1\"\n },\n \"folder\": \"106\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"journey\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"type\": \"singlebatch\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true\n },\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ],\n \"result_code\": \"Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9870264f-733c-4c50-8cb2-b355fba3aaf3", "name": "Get Single Batch journey", "request": { "name": "Get Single Batch journey", "description": { "content": "Use this endpoint to retrieve information on the Single Batch journey with the given api name.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the journey.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "9027fa45-7529-411c-b6f5-9039d0799835", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"journey\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"type\": \"singlebatch\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true\n }\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "02580704-2b9d-4602-b0fb-5754ace078b1", "name": "Delete Single Batch journey", "request": { "name": "Delete Single Batch journey", "description": { "content": "Use this endpoint to delete existing single batch journey.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the journey.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "41efc708-de2d-41ec-85af-411cdd4f99e6", "name": "Deleted", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The journey has been deleted successfully\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cf9401b3-ba70-41c5-b379-567a71736ea0", "name": "Cancel a journey", "request": { "name": "Cancel a journey", "description": { "content": "Cancel the execution or scheduled execution of a Single Batch journey.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch", ":api_name", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the journey.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "316cbc16-f890-43e1-8d1b-036c8576f20d", "name": "Journey has been cancelled successfully", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch", ":api_name", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The journey has been cancelled successfully.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "59f0a594-217a-4479-90fa-1989358e9aa1", "name": "Journey cancel was not successful", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch", ":api_name", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "3d877307-8018-42c5-8462-796db18a867c", "name": "Journey (api_name or organization) cannot be found", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch", ":api_name", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "19928caa-0c03-4b70-b736-19b1ed2ed167", "name": "Launch a single batch journey", "request": { "name": "Launch a single batch journey", "description": { "content": "Launch a specific Single Batch journey given the schedule.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch", ":api_name", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the journey.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"launch_state\": \"launch\",\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "e45891ad-40de-4baf-bd81-785781bf4864", "name": "Launched", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch", ":api_name", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"launch_state\": \"launch\",\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The journey has been launched successfully.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "8959cea3-fb8d-47a7-96cd-6291f626057b", "name": "Bad request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch", ":api_name", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"launch_state\": \"launch\",\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "03911393-3d49-41b0-a1fe-015e9b126898", "name": "Not found", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch", ":api_name", "launch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"launch_state\": \"launch\",\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7e6a78f7-962e-479a-bc1f-e2d134e4b214", "name": "Trigger single batch journey", "request": { "name": "Trigger single batch journey", "description": { "content": "Use this endpoint to trigger a Single-Batch journey execution.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch", ":api_name", "trigger" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the journey.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"journey\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"deduplication\": {\n \"fields\": [\n \"MASTER.NAME\",\n \"MASTER.EMAIL\"\n ],\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "47ed8cac-e626-4916-b987-3c508f4cf3bc", "name": "Triggered", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch", ":api_name", "trigger" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"journey\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"deduplication\": {\n \"fields\": [\n \"MASTER.NAME\",\n \"MASTER.EMAIL\"\n ],\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"journey\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"type\": \"singlebatch\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true\n },\n \"result_code\": \"PartiallySucceeded\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "80d00ac5-6689-4e14-8ff7-88a80ad414a5", "name": "Bad request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch", ":api_name", "trigger" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"journey\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"deduplication\": {\n \"fields\": [\n \"MASTER.NAME\",\n \"MASTER.EMAIL\"\n ],\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"journey\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"type\": \"singlebatch\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true\n },\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ],\n \"result_code\": \"Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ff32add3-e0bc-4503-aadf-6a2ba8ac12ce", "name": "Send Single Batch email journey", "request": { "name": "Send Single Batch email journey", "description": { "content": "Use this end point to send single batch with an email message.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch", "message" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"folder\": \"106\",\n \"journey_model\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"deduplication\": {\n \"fields\": [\n \"MASTER.NAME\",\n \"MASTER.EMAIL\"\n ],\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true,\n \"segment_api_name\": \"segment_1\",\n \"audience_filter\": \"endswith([MASTER.MAIL], '@my_company.com')\"\n },\n \"message_model\": {\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\"\n },\n \"headers\": {\n \"laboreac9\": [\n {\n \"from_domain\": \"zetaglobal.com\",\n \"from_alias\": \"Selligent\",\n \"to_alias\": \"John Doe\",\n \"preheader\": \"Your preheader text\",\n \"subject\": \"Your subjectline\",\n \"reply_email\": \"help@zetaglobal.com\",\n \"reply_alias\": \"Selligent Help\",\n \"from_address\": \"info@zetaglobal.com\",\n \"deliverygroup_api_name\": \"delivery_group_1\"\n },\n {\n \"from_domain\": \"zetaglobal.com\",\n \"from_alias\": \"Selligent\",\n \"to_alias\": \"John Doe\",\n \"preheader\": \"Your preheader text\",\n \"subject\": \"Your subjectline\",\n \"reply_email\": \"help@zetaglobal.com\",\n \"reply_alias\": \"Selligent Help\",\n \"from_address\": \"info@zetaglobal.com\",\n \"deliverygroup_api_name\": \"delivery_group_1\"\n }\n ],\n \"utc\": [\n {\n \"from_domain\": \"zetaglobal.com\",\n \"from_alias\": \"Selligent\",\n \"to_alias\": \"John Doe\",\n \"preheader\": \"Your preheader text\",\n \"subject\": \"Your subjectline\",\n \"reply_email\": \"help@zetaglobal.com\",\n \"reply_alias\": \"Selligent Help\",\n \"from_address\": \"info@zetaglobal.com\",\n \"deliverygroup_api_name\": \"delivery_group_1\"\n },\n {\n \"from_domain\": \"zetaglobal.com\",\n \"from_alias\": \"Selligent\",\n \"to_alias\": \"John Doe\",\n \"preheader\": \"Your preheader text\",\n \"subject\": \"Your subjectline\",\n \"reply_email\": \"help@zetaglobal.com\",\n \"reply_alias\": \"Selligent Help\",\n \"from_address\": \"info@zetaglobal.com\",\n \"deliverygroup_api_name\": \"delivery_group_1\"\n }\n ]\n },\n \"content\": {\n \"html\": \"

Hello World!

This is Rahul

\",\n \"text\": \"Hello World!\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "670da6e0-5396-45d4-a05a-ce28ad961d9f", "name": "Scheduled", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch", "message" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"folder\": \"106\",\n \"journey_model\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"deduplication\": {\n \"fields\": [\n \"MASTER.NAME\",\n \"MASTER.EMAIL\"\n ],\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true,\n \"segment_api_name\": \"segment_1\",\n \"audience_filter\": \"endswith([MASTER.MAIL], '@my_company.com')\"\n },\n \"message_model\": {\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\"\n },\n \"headers\": {\n \"laboreac9\": [\n {\n \"from_domain\": \"zetaglobal.com\",\n \"from_alias\": \"Selligent\",\n \"to_alias\": \"John Doe\",\n \"preheader\": \"Your preheader text\",\n \"subject\": \"Your subjectline\",\n \"reply_email\": \"help@zetaglobal.com\",\n \"reply_alias\": \"Selligent Help\",\n \"from_address\": \"info@zetaglobal.com\",\n \"deliverygroup_api_name\": \"delivery_group_1\"\n },\n {\n \"from_domain\": \"zetaglobal.com\",\n \"from_alias\": \"Selligent\",\n \"to_alias\": \"John Doe\",\n \"preheader\": \"Your preheader text\",\n \"subject\": \"Your subjectline\",\n \"reply_email\": \"help@zetaglobal.com\",\n \"reply_alias\": \"Selligent Help\",\n \"from_address\": \"info@zetaglobal.com\",\n \"deliverygroup_api_name\": \"delivery_group_1\"\n }\n ],\n \"utc\": [\n {\n \"from_domain\": \"zetaglobal.com\",\n \"from_alias\": \"Selligent\",\n \"to_alias\": \"John Doe\",\n \"preheader\": \"Your preheader text\",\n \"subject\": \"Your subjectline\",\n \"reply_email\": \"help@zetaglobal.com\",\n \"reply_alias\": \"Selligent Help\",\n \"from_address\": \"info@zetaglobal.com\",\n \"deliverygroup_api_name\": \"delivery_group_1\"\n },\n {\n \"from_domain\": \"zetaglobal.com\",\n \"from_alias\": \"Selligent\",\n \"to_alias\": \"John Doe\",\n \"preheader\": \"Your preheader text\",\n \"subject\": \"Your subjectline\",\n \"reply_email\": \"help@zetaglobal.com\",\n \"reply_alias\": \"Selligent Help\",\n \"from_address\": \"info@zetaglobal.com\",\n \"deliverygroup_api_name\": \"delivery_group_1\"\n }\n ]\n },\n \"content\": {\n \"html\": \"

Hello World!

This is Rahul

\",\n \"text\": \"Hello World!\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"journey\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"type\": \"singlebatch\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true\n },\n \"result_code\": \"PartiallySucceeded\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "12362f16-e565-4b2c-824c-3c1894ec8511", "name": "Bad request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch", "message" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"folder\": \"106\",\n \"journey_model\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"deduplication\": {\n \"fields\": [\n \"MASTER.NAME\",\n \"MASTER.EMAIL\"\n ],\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true,\n \"segment_api_name\": \"segment_1\",\n \"audience_filter\": \"endswith([MASTER.MAIL], '@my_company.com')\"\n },\n \"message_model\": {\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\"\n },\n \"headers\": {\n \"laboreac9\": [\n {\n \"from_domain\": \"zetaglobal.com\",\n \"from_alias\": \"Selligent\",\n \"to_alias\": \"John Doe\",\n \"preheader\": \"Your preheader text\",\n \"subject\": \"Your subjectline\",\n \"reply_email\": \"help@zetaglobal.com\",\n \"reply_alias\": \"Selligent Help\",\n \"from_address\": \"info@zetaglobal.com\",\n \"deliverygroup_api_name\": \"delivery_group_1\"\n },\n {\n \"from_domain\": \"zetaglobal.com\",\n \"from_alias\": \"Selligent\",\n \"to_alias\": \"John Doe\",\n \"preheader\": \"Your preheader text\",\n \"subject\": \"Your subjectline\",\n \"reply_email\": \"help@zetaglobal.com\",\n \"reply_alias\": \"Selligent Help\",\n \"from_address\": \"info@zetaglobal.com\",\n \"deliverygroup_api_name\": \"delivery_group_1\"\n }\n ],\n \"utc\": [\n {\n \"from_domain\": \"zetaglobal.com\",\n \"from_alias\": \"Selligent\",\n \"to_alias\": \"John Doe\",\n \"preheader\": \"Your preheader text\",\n \"subject\": \"Your subjectline\",\n \"reply_email\": \"help@zetaglobal.com\",\n \"reply_alias\": \"Selligent Help\",\n \"from_address\": \"info@zetaglobal.com\",\n \"deliverygroup_api_name\": \"delivery_group_1\"\n },\n {\n \"from_domain\": \"zetaglobal.com\",\n \"from_alias\": \"Selligent\",\n \"to_alias\": \"John Doe\",\n \"preheader\": \"Your preheader text\",\n \"subject\": \"Your subjectline\",\n \"reply_email\": \"help@zetaglobal.com\",\n \"reply_alias\": \"Selligent Help\",\n \"from_address\": \"info@zetaglobal.com\",\n \"deliverygroup_api_name\": \"delivery_group_1\"\n }\n ]\n },\n \"content\": {\n \"html\": \"

Hello World!

This is Rahul

\",\n \"text\": \"Hello World!\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"journey\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"type\": \"singlebatch\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true\n },\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ],\n \"result_code\": \"Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fc75dc5e-3f7b-4d36-abca-d8017681299b", "name": "Send Single Batch mobile push journey", "request": { "name": "Send Single Batch mobile push journey", "description": { "content": "Use this end point to send single batch with a mobile push message.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch", "mobile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"folder\": \"106\",\n \"journey_model\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"deduplication\": {\n \"fields\": [\n \"MASTER.NAME\",\n \"MASTER.EMAIL\"\n ],\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true,\n \"segment_api_name\": \"segment_1\",\n \"audience_filter\": \"endswith([MASTER.MAIL], '@my_company.com')\"\n },\n \"mobile_message_model\": {\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\",\n \"mobile_app_api_name\": \"mobile_device_list_1\"\n },\n \"mobile_properties\": {\n \"distribution_type\": \"MobilePush\",\n \"custom_in_app_content\": true,\n \"in_app_content_type\": \"Image\",\n \"rich_push_content_enabled\": true,\n \"rich_push_content_type\": \"Image\",\n \"expiration_date\": \"2025-01-01\"\n },\n \"content\": {\n \"cillumf_7\": [\n {\n \"mobile_push\": {\n \"title\": \"Check this out!\",\n \"content\": \"Isn't this great as a body text?\"\n },\n \"in_app\": {\n \"content\": {\n \"text\": \"Great message!\",\n \"url\": \"https://zetaglobal.com\"\n },\n \"title\": \"We have news!\",\n \"in_app_buttons\": {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n },\n \"rich_push\": {\n \"content\": {\n \"image\": \"https://zetaglobal.com/assets/logo/zeta_logoLandscape_1Color_WHITE.png\"\n }\n },\n \"banner_buttons\": [\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ],\n \"main_action\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"mobile_push\": {\n \"title\": \"Check this out!\",\n \"content\": \"Isn't this great as a body text?\"\n },\n \"in_app\": {\n \"content\": {\n \"text\": \"Great message!\",\n \"url\": \"https://zetaglobal.com\"\n },\n \"title\": \"We have news!\",\n \"in_app_buttons\": {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n },\n \"rich_push\": {\n \"content\": {\n \"image\": \"https://zetaglobal.com/assets/logo/zeta_logoLandscape_1Color_WHITE.png\"\n }\n },\n \"banner_buttons\": [\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ],\n \"main_action\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "d69f56b1-89fb-4334-8997-d29b60ac7b24", "name": "Scheduled", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch", "mobile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"folder\": \"106\",\n \"journey_model\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"deduplication\": {\n \"fields\": [\n \"MASTER.NAME\",\n \"MASTER.EMAIL\"\n ],\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true,\n \"segment_api_name\": \"segment_1\",\n \"audience_filter\": \"endswith([MASTER.MAIL], '@my_company.com')\"\n },\n \"mobile_message_model\": {\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\",\n \"mobile_app_api_name\": \"mobile_device_list_1\"\n },\n \"mobile_properties\": {\n \"distribution_type\": \"MobilePush\",\n \"custom_in_app_content\": true,\n \"in_app_content_type\": \"Image\",\n \"rich_push_content_enabled\": true,\n \"rich_push_content_type\": \"Image\",\n \"expiration_date\": \"2025-01-01\"\n },\n \"content\": {\n \"cillumf_7\": [\n {\n \"mobile_push\": {\n \"title\": \"Check this out!\",\n \"content\": \"Isn't this great as a body text?\"\n },\n \"in_app\": {\n \"content\": {\n \"text\": \"Great message!\",\n \"url\": \"https://zetaglobal.com\"\n },\n \"title\": \"We have news!\",\n \"in_app_buttons\": {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n },\n \"rich_push\": {\n \"content\": {\n \"image\": \"https://zetaglobal.com/assets/logo/zeta_logoLandscape_1Color_WHITE.png\"\n }\n },\n \"banner_buttons\": [\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ],\n \"main_action\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"mobile_push\": {\n \"title\": \"Check this out!\",\n \"content\": \"Isn't this great as a body text?\"\n },\n \"in_app\": {\n \"content\": {\n \"text\": \"Great message!\",\n \"url\": \"https://zetaglobal.com\"\n },\n \"title\": \"We have news!\",\n \"in_app_buttons\": {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n },\n \"rich_push\": {\n \"content\": {\n \"image\": \"https://zetaglobal.com/assets/logo/zeta_logoLandscape_1Color_WHITE.png\"\n }\n },\n \"banner_buttons\": [\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ],\n \"main_action\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"journey\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"type\": \"singlebatch\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true\n },\n \"result_code\": \"PartiallySucceeded\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "6e4e4413-f7b1-4801-a039-ba9b592563c4", "name": "Bad request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch", "mobile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"folder\": \"106\",\n \"journey_model\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"deduplication\": {\n \"fields\": [\n \"MASTER.NAME\",\n \"MASTER.EMAIL\"\n ],\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true,\n \"segment_api_name\": \"segment_1\",\n \"audience_filter\": \"endswith([MASTER.MAIL], '@my_company.com')\"\n },\n \"mobile_message_model\": {\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\",\n \"mobile_app_api_name\": \"mobile_device_list_1\"\n },\n \"mobile_properties\": {\n \"distribution_type\": \"MobilePush\",\n \"custom_in_app_content\": true,\n \"in_app_content_type\": \"Image\",\n \"rich_push_content_enabled\": true,\n \"rich_push_content_type\": \"Image\",\n \"expiration_date\": \"2025-01-01\"\n },\n \"content\": {\n \"cillumf_7\": [\n {\n \"mobile_push\": {\n \"title\": \"Check this out!\",\n \"content\": \"Isn't this great as a body text?\"\n },\n \"in_app\": {\n \"content\": {\n \"text\": \"Great message!\",\n \"url\": \"https://zetaglobal.com\"\n },\n \"title\": \"We have news!\",\n \"in_app_buttons\": {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n },\n \"rich_push\": {\n \"content\": {\n \"image\": \"https://zetaglobal.com/assets/logo/zeta_logoLandscape_1Color_WHITE.png\"\n }\n },\n \"banner_buttons\": [\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ],\n \"main_action\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"mobile_push\": {\n \"title\": \"Check this out!\",\n \"content\": \"Isn't this great as a body text?\"\n },\n \"in_app\": {\n \"content\": {\n \"text\": \"Great message!\",\n \"url\": \"https://zetaglobal.com\"\n },\n \"title\": \"We have news!\",\n \"in_app_buttons\": {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n },\n \"rich_push\": {\n \"content\": {\n \"image\": \"https://zetaglobal.com/assets/logo/zeta_logoLandscape_1Color_WHITE.png\"\n }\n },\n \"banner_buttons\": [\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n },\n {\n \"label\": \"buy_1\",\n \"link\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ],\n \"main_action\": {\n \"type\": \"Simple\",\n \"target\": \"https://zetaglobal.com\"\n }\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"journey\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"type\": \"singlebatch\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true\n },\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ],\n \"result_code\": \"Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "79ef3b97-7ea1-40e0-921a-b3f3774f66d5", "name": "Send Single Batch SMS journey", "request": { "name": "Send Single Batch SMS journey", "description": { "content": "Use this end point to send single batch with an SMS.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch", "sms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"folder\": \"106\",\n \"journey_model\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"deduplication\": {\n \"fields\": [\n \"MASTER.NAME\",\n \"MASTER.EMAIL\"\n ],\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true,\n \"segment_api_name\": \"segment_1\",\n \"audience_filter\": \"endswith([MASTER.MAIL], '@my_company.com')\"\n },\n \"sms_model\": {\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\"\n },\n \"content\": {\n \"text\": \"Hello world!\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "6f37e721-9a31-480f-b27a-071e02461368", "name": "Scheduled", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch", "sms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"folder\": \"106\",\n \"journey_model\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"deduplication\": {\n \"fields\": [\n \"MASTER.NAME\",\n \"MASTER.EMAIL\"\n ],\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true,\n \"segment_api_name\": \"segment_1\",\n \"audience_filter\": \"endswith([MASTER.MAIL], '@my_company.com')\"\n },\n \"sms_model\": {\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\"\n },\n \"content\": {\n \"text\": \"Hello world!\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"journey\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"type\": \"singlebatch\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true\n },\n \"result_code\": \"PartiallySucceeded\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "91584f6b-cfc7-4655-ad30-436ce2e6bab0", "name": "Bad request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "singlebatch", "sms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"folder\": \"106\",\n \"journey_model\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"deduplication\": {\n \"fields\": [\n \"MASTER.NAME\",\n \"MASTER.EMAIL\"\n ],\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"scheduling\": {\n \"launch_date\": \"2023-12-15T10:11:17.9968156Z\"\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true,\n \"segment_api_name\": \"segment_1\",\n \"audience_filter\": \"endswith([MASTER.MAIL], '@my_company.com')\"\n },\n \"sms_model\": {\n \"properties\": {\n \"api_name\": \"message_1\",\n \"audience_api_name\": \"audience_1\",\n \"languages\": [\n \"EN_US\",\n \"FR\"\n ],\n \"name\": \"Email Message\",\n \"description\": \"Description for the message.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"default_language\": \"EN\",\n \"empty_language\": \"FR\",\n \"folder\": \"106\"\n },\n \"content\": {\n \"text\": \"Hello world!\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"journey\": {\n \"api_name\": \"journey_1\",\n \"name\": \"Christmas Campaign 1\",\n \"type\": \"singlebatch\",\n \"campaign_analytics_tag\": \"christmas_2424\",\n \"send_in_waves\": {\n \"type\": \"Waves\",\n \"number_of_waves\": 5,\n \"interval_in_minutes\": 60,\n \"items_per_wave\": 50000\n },\n \"sending_limit\": {\n \"percentage\": 15,\n \"sort_selection\": \"Sorted\",\n \"type\": \"Absolute\",\n \"sort_field\": \"MASTER.ID\",\n \"sort_descending\": true\n },\n \"disable_tracking\": true,\n \"launch_state\": \"launch\",\n \"seed_group\": {\n \"send_to_all_available_groups\": false,\n \"segment_api_names\": [\n \"seedgroup_segment_apiname_1\",\n \"seedgroup_segment_apiname_2\"\n ]\n },\n \"message_analytics_tag\": \"batch_2\",\n \"disable_flags\": true\n },\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ],\n \"result_code\": \"Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "7116a4cc-ef82-4c70-9bc1-f02ed65bf9c3", "name": "Transactional journey", "description": { "content": "All transactional journey endpoints", "type": "text/plain" }, "item": [ { "id": "50b2d5ff-403e-4eb3-a770-aeba1a4014a7", "name": "List Transactional journeys", "request": { "name": "List Transactional journeys", "description": { "content": "Use this endpoint to retrieve all journeys on the given organization of type Transactional.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "transactional" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "7bc8c3ab-255a-465a-b24d-3c39d26861eb", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "transactional" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"journeys\": [\n {\n \"api_name\": \"api_name_1\",\n \"type\": \"transactional\"\n },\n {\n \"api_name\": \"api_name_2\",\n \"type\": \"transactional\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9a2dad64-c161-410b-9212-24f8a06207c6", "name": "Get Transactional journey", "request": { "name": "Get Transactional journey", "description": { "content": "Use this endpoint to retrieve information on the transactional journey with the given api name.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "transactional", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the journey.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "da493a6a-6b60-424b-8f11-1cc8a3685042", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "transactional", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"api_name\": \"journey_1\",\n \"type\": \"transactional\",\n \"launch_state\": \"none\",\n \"name\": \"Christmas Campaign 1\",\n \"campaign_analytics_tag\": \"christmas_campaign\",\n \"message_analytics_tag\": \"christmas_campaign_message\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f793d73e-a4b6-4546-92c1-bc92a975cf3c", "name": "Delete Transactional journey", "request": { "name": "Delete Transactional journey", "description": { "content": "Use this endpoint to delete existing transactional journey.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "transactional", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the journey.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "558d90a1-7346-44df-a816-797a7eafddf0", "name": "Deleted", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "transactional", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The journey has been deleted successfully.\",\n \"errors\": []\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3133a21b-bac5-4d7c-9b76-164db4de3b18", "name": "Trigger Transactional journey(s)", "request": { "name": "Trigger Transactional journey(s)", "description": { "content": "Use this endpoint to send (multiple) transactional messages (email mobile push sms).", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "transactional", ":api_name", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the journey.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": {\n \"recipient\": \"john.doe@doe.com\",\n \"language\": \"en-US\",\n \"email\": \"john.doe@doe.com\",\n \"data\": {\n \"required_string_1\": \"John\",\n \"optional_integer_1\": 1,\n \"required_integer_1\": 5\n },\n \"dtsdata\": [\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n },\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n }\n ],\n \"lookup\": {\n \"field\": \"MAIL\",\n \"scope\": \"MASTER\"\n },\n \"sg_external_id\": \"c1379533-b642-48ee-968a-b952c042ed94\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "bd51d456-ee3d-4263-8bf0-d957274faec5", "name": "Scheduled", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "transactional", ":api_name", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": {\n \"recipient\": \"john.doe@doe.com\",\n \"language\": \"en-US\",\n \"email\": \"john.doe@doe.com\",\n \"data\": {\n \"required_string_1\": \"John\",\n \"optional_integer_1\": 1,\n \"required_integer_1\": 5\n },\n \"dtsdata\": [\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n },\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n }\n ],\n \"lookup\": {\n \"field\": \"MAIL\",\n \"scope\": \"MASTER\"\n },\n \"sg_external_id\": \"c1379533-b642-48ee-968a-b952c042ed94\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"PartiallySucceeded\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ],\n \"response_data\": [\n {\n \"email\": \"john.doe@doe.com\",\n \"recipient\": \"john.doe@doe.com\",\n \"language\": \"en-US\",\n \"data\": {\n \"required_string_1\": \"John\",\n \"optional_integer_1\": 1,\n \"required_integer_1\": 5\n },\n \"dtsdata\": [\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n },\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n }\n ],\n \"lookup\": {\n \"field\": \"MAIL\",\n \"scope\": \"MASTER\"\n },\n \"sg_external_id\": \"c1379533-b642-48ee-968a-b952c042ed94\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ]\n },\n {\n \"email\": \"john.doe@doe.com\",\n \"recipient\": \"john.doe@doe.com\",\n \"language\": \"en-US\",\n \"data\": {\n \"required_string_1\": \"John\",\n \"optional_integer_1\": 1,\n \"required_integer_1\": 5\n },\n \"dtsdata\": [\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n },\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n }\n ],\n \"lookup\": {\n \"field\": \"MAIL\",\n \"scope\": \"MASTER\"\n },\n \"sg_external_id\": \"c1379533-b642-48ee-968a-b952c042ed94\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ]\n }\n ],\n \"messages\": [\n {\n \"id\": \"e82d48e6-f083-4a88-a842-524b3d8992de\"\n },\n {\n \"id\": \"e82d48e6-f083-4a88-a842-524b3d8992de\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "8c39ddfd-de5e-44be-bf8d-45436c4359fe", "name": "Not found", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "transactional", ":api_name", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": {\n \"recipient\": \"john.doe@doe.com\",\n \"language\": \"en-US\",\n \"email\": \"john.doe@doe.com\",\n \"data\": {\n \"required_string_1\": \"John\",\n \"optional_integer_1\": 1,\n \"required_integer_1\": 5\n },\n \"dtsdata\": [\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n },\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n }\n ],\n \"lookup\": {\n \"field\": \"MAIL\",\n \"scope\": \"MASTER\"\n },\n \"sg_external_id\": \"c1379533-b642-48ee-968a-b952c042ed94\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"PartiallySucceeded\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ],\n \"response_data\": [\n {\n \"email\": \"john.doe@doe.com\",\n \"recipient\": \"john.doe@doe.com\",\n \"language\": \"en-US\",\n \"data\": {\n \"required_string_1\": \"John\",\n \"optional_integer_1\": 1,\n \"required_integer_1\": 5\n },\n \"dtsdata\": [\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n },\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n }\n ],\n \"lookup\": {\n \"field\": \"MAIL\",\n \"scope\": \"MASTER\"\n },\n \"sg_external_id\": \"c1379533-b642-48ee-968a-b952c042ed94\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ]\n },\n {\n \"email\": \"john.doe@doe.com\",\n \"recipient\": \"john.doe@doe.com\",\n \"language\": \"en-US\",\n \"data\": {\n \"required_string_1\": \"John\",\n \"optional_integer_1\": 1,\n \"required_integer_1\": 5\n },\n \"dtsdata\": [\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n },\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n }\n ],\n \"lookup\": {\n \"field\": \"MAIL\",\n \"scope\": \"MASTER\"\n },\n \"sg_external_id\": \"c1379533-b642-48ee-968a-b952c042ed94\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ]\n }\n ],\n \"messages\": [\n {\n \"id\": \"e82d48e6-f083-4a88-a842-524b3d8992de\"\n },\n {\n \"id\": \"e82d48e6-f083-4a88-a842-524b3d8992de\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "2ee52946-e94e-4fe7-b701-1ca88ee4005c", "name": "Content to large", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "transactional", ":api_name", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": {\n \"recipient\": \"john.doe@doe.com\",\n \"language\": \"en-US\",\n \"email\": \"john.doe@doe.com\",\n \"data\": {\n \"required_string_1\": \"John\",\n \"optional_integer_1\": 1,\n \"required_integer_1\": 5\n },\n \"dtsdata\": [\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n },\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n }\n ],\n \"lookup\": {\n \"field\": \"MAIL\",\n \"scope\": \"MASTER\"\n },\n \"sg_external_id\": \"c1379533-b642-48ee-968a-b952c042ed94\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"PartiallySucceeded\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ],\n \"response_data\": [\n {\n \"email\": \"john.doe@doe.com\",\n \"recipient\": \"john.doe@doe.com\",\n \"language\": \"en-US\",\n \"data\": {\n \"required_string_1\": \"John\",\n \"optional_integer_1\": 1,\n \"required_integer_1\": 5\n },\n \"dtsdata\": [\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n },\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n }\n ],\n \"lookup\": {\n \"field\": \"MAIL\",\n \"scope\": \"MASTER\"\n },\n \"sg_external_id\": \"c1379533-b642-48ee-968a-b952c042ed94\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ]\n },\n {\n \"email\": \"john.doe@doe.com\",\n \"recipient\": \"john.doe@doe.com\",\n \"language\": \"en-US\",\n \"data\": {\n \"required_string_1\": \"John\",\n \"optional_integer_1\": 1,\n \"required_integer_1\": 5\n },\n \"dtsdata\": [\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n },\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n }\n ],\n \"lookup\": {\n \"field\": \"MAIL\",\n \"scope\": \"MASTER\"\n },\n \"sg_external_id\": \"c1379533-b642-48ee-968a-b952c042ed94\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ]\n }\n ],\n \"messages\": [\n {\n \"id\": \"e82d48e6-f083-4a88-a842-524b3d8992de\"\n },\n {\n \"id\": \"e82d48e6-f083-4a88-a842-524b3d8992de\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bdb11bef-9c2c-41d3-9865-27e484e125a3", "name": "Update User and trigger Transactional journey", "request": { "name": "Update User and trigger Transactional journey", "description": { "content": "Use this endpoint to update the user profile with given data and then send (multiple) transactional messages (email mobile push sms).", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "transactional", "shortcut", ":api_name", "updateProfileAndSend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the journey.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": {\n \"recipient\": \"john.doe@doe.com\",\n \"language\": \"en-US\",\n \"email\": \"john.doe@doe.com\",\n \"data\": {\n \"required_string_1\": \"John\",\n \"optional_integer_1\": 1,\n \"required_integer_1\": 5\n },\n \"dtsdata\": [\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n },\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n }\n ],\n \"lookup\": {\n \"field\": \"MAIL\",\n \"scope\": \"MASTER\"\n },\n \"sg_external_id\": \"c1379533-b642-48ee-968a-b952c042ed94\",\n \"profile\": [\n {\n \"scope\": \"MASTER\",\n \"fields\": {\n \"NAME\": \"John\",\n \"PREFERENCE\": \"Food\"\n }\n },\n {\n \"scope\": \"MASTER\",\n \"fields\": {\n \"NAME\": \"John\",\n \"PREFERENCE\": \"Food\"\n }\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "30108bcc-5c7a-493e-81ab-c7dea1412c33", "name": "Updated", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "transactional", "shortcut", ":api_name", "updateProfileAndSend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": {\n \"recipient\": \"john.doe@doe.com\",\n \"language\": \"en-US\",\n \"email\": \"john.doe@doe.com\",\n \"data\": {\n \"required_string_1\": \"John\",\n \"optional_integer_1\": 1,\n \"required_integer_1\": 5\n },\n \"dtsdata\": [\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n },\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n }\n ],\n \"lookup\": {\n \"field\": \"MAIL\",\n \"scope\": \"MASTER\"\n },\n \"sg_external_id\": \"c1379533-b642-48ee-968a-b952c042ed94\",\n \"profile\": [\n {\n \"scope\": \"MASTER\",\n \"fields\": {\n \"NAME\": \"John\",\n \"PREFERENCE\": \"Food\"\n }\n },\n {\n \"scope\": \"MASTER\",\n \"fields\": {\n \"NAME\": \"John\",\n \"PREFERENCE\": \"Food\"\n }\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"PartiallySucceeded\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ],\n \"response_data\": [\n {\n \"email\": \"john.doe@doe.com\",\n \"recipient\": \"john.doe@doe.com\",\n \"language\": \"en-US\",\n \"data\": {\n \"required_string_1\": \"John\",\n \"optional_integer_1\": 1,\n \"required_integer_1\": 5\n },\n \"dtsdata\": [\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n },\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n }\n ],\n \"lookup\": {\n \"field\": \"MAIL\",\n \"scope\": \"MASTER\"\n },\n \"sg_external_id\": \"c1379533-b642-48ee-968a-b952c042ed94\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ]\n },\n {\n \"email\": \"john.doe@doe.com\",\n \"recipient\": \"john.doe@doe.com\",\n \"language\": \"en-US\",\n \"data\": {\n \"required_string_1\": \"John\",\n \"optional_integer_1\": 1,\n \"required_integer_1\": 5\n },\n \"dtsdata\": [\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n },\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n }\n ],\n \"lookup\": {\n \"field\": \"MAIL\",\n \"scope\": \"MASTER\"\n },\n \"sg_external_id\": \"c1379533-b642-48ee-968a-b952c042ed94\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ]\n }\n ],\n \"messages\": [\n {\n \"id\": \"e82d48e6-f083-4a88-a842-524b3d8992de\"\n },\n {\n \"id\": \"e82d48e6-f083-4a88-a842-524b3d8992de\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "caa7b683-5df3-4144-a4b1-02fc86c29b83", "name": "Not found", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "transactional", "shortcut", ":api_name", "updateProfileAndSend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": {\n \"recipient\": \"john.doe@doe.com\",\n \"language\": \"en-US\",\n \"email\": \"john.doe@doe.com\",\n \"data\": {\n \"required_string_1\": \"John\",\n \"optional_integer_1\": 1,\n \"required_integer_1\": 5\n },\n \"dtsdata\": [\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n },\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n }\n ],\n \"lookup\": {\n \"field\": \"MAIL\",\n \"scope\": \"MASTER\"\n },\n \"sg_external_id\": \"c1379533-b642-48ee-968a-b952c042ed94\",\n \"profile\": [\n {\n \"scope\": \"MASTER\",\n \"fields\": {\n \"NAME\": \"John\",\n \"PREFERENCE\": \"Food\"\n }\n },\n {\n \"scope\": \"MASTER\",\n \"fields\": {\n \"NAME\": \"John\",\n \"PREFERENCE\": \"Food\"\n }\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"PartiallySucceeded\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ],\n \"response_data\": [\n {\n \"email\": \"john.doe@doe.com\",\n \"recipient\": \"john.doe@doe.com\",\n \"language\": \"en-US\",\n \"data\": {\n \"required_string_1\": \"John\",\n \"optional_integer_1\": 1,\n \"required_integer_1\": 5\n },\n \"dtsdata\": [\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n },\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n }\n ],\n \"lookup\": {\n \"field\": \"MAIL\",\n \"scope\": \"MASTER\"\n },\n \"sg_external_id\": \"c1379533-b642-48ee-968a-b952c042ed94\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ]\n },\n {\n \"email\": \"john.doe@doe.com\",\n \"recipient\": \"john.doe@doe.com\",\n \"language\": \"en-US\",\n \"data\": {\n \"required_string_1\": \"John\",\n \"optional_integer_1\": 1,\n \"required_integer_1\": 5\n },\n \"dtsdata\": [\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n },\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n }\n ],\n \"lookup\": {\n \"field\": \"MAIL\",\n \"scope\": \"MASTER\"\n },\n \"sg_external_id\": \"c1379533-b642-48ee-968a-b952c042ed94\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ]\n }\n ],\n \"messages\": [\n {\n \"id\": \"e82d48e6-f083-4a88-a842-524b3d8992de\"\n },\n {\n \"id\": \"e82d48e6-f083-4a88-a842-524b3d8992de\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "2305cd32-a14d-48ab-8991-b1035f7cfbef", "name": "Content to large", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "transactional", "shortcut", ":api_name", "updateProfileAndSend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": {\n \"recipient\": \"john.doe@doe.com\",\n \"language\": \"en-US\",\n \"email\": \"john.doe@doe.com\",\n \"data\": {\n \"required_string_1\": \"John\",\n \"optional_integer_1\": 1,\n \"required_integer_1\": 5\n },\n \"dtsdata\": [\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n },\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n }\n ],\n \"lookup\": {\n \"field\": \"MAIL\",\n \"scope\": \"MASTER\"\n },\n \"sg_external_id\": \"c1379533-b642-48ee-968a-b952c042ed94\",\n \"profile\": [\n {\n \"scope\": \"MASTER\",\n \"fields\": {\n \"NAME\": \"John\",\n \"PREFERENCE\": \"Food\"\n }\n },\n {\n \"scope\": \"MASTER\",\n \"fields\": {\n \"NAME\": \"John\",\n \"PREFERENCE\": \"Food\"\n }\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"PartiallySucceeded\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ],\n \"response_data\": [\n {\n \"email\": \"john.doe@doe.com\",\n \"recipient\": \"john.doe@doe.com\",\n \"language\": \"en-US\",\n \"data\": {\n \"required_string_1\": \"John\",\n \"optional_integer_1\": 1,\n \"required_integer_1\": 5\n },\n \"dtsdata\": [\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n },\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n }\n ],\n \"lookup\": {\n \"field\": \"MAIL\",\n \"scope\": \"MASTER\"\n },\n \"sg_external_id\": \"c1379533-b642-48ee-968a-b952c042ed94\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ]\n },\n {\n \"email\": \"john.doe@doe.com\",\n \"recipient\": \"john.doe@doe.com\",\n \"language\": \"en-US\",\n \"data\": {\n \"required_string_1\": \"John\",\n \"optional_integer_1\": 1,\n \"required_integer_1\": 5\n },\n \"dtsdata\": [\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n },\n {\n \"data_selection\": \"Data_selection_1\",\n \"content\": [\n {},\n {}\n ]\n }\n ],\n \"lookup\": {\n \"field\": \"MAIL\",\n \"scope\": \"MASTER\"\n },\n \"sg_external_id\": \"c1379533-b642-48ee-968a-b952c042ed94\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ]\n }\n ],\n \"messages\": [\n {\n \"id\": \"e82d48e6-f083-4a88-a842-524b3d8992de\"\n },\n {\n \"id\": \"e82d48e6-f083-4a88-a842-524b3d8992de\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d41229fd-ddbe-46ec-bb21-764f64e7c8d7", "name": "List status Transactional journeys", "request": { "name": "List status Transactional journeys", "description": { "content": "Use this endpoint to get the status of multiple transactional messages.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "transactional", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"055979c7-d2ec-4d83-abb4-fde70cc1aac5\",\n \"754c4ea5-621c-4a9d-9932-53ef68542945\"\n ],\n \"sg_external_ids\": [\n \"c1379533-b642-48ee-968a-b952c042ed94\",\n \"7efd3f07-3eb4-4bce-b26c-672603ea7f20\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "8869d6d9-98b5-499a-8353-e917b88a9ba8", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "transactional", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"055979c7-d2ec-4d83-abb4-fde70cc1aac5\",\n \"754c4ea5-621c-4a9d-9932-53ef68542945\"\n ],\n \"sg_external_ids\": [\n \"c1379533-b642-48ee-968a-b952c042ed94\",\n \"7efd3f07-3eb4-4bce-b26c-672603ea7f20\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"7aba31fe-490c-46f0-bd5e-82a0bc5648fc\",\n \"sg_external_id\": \"c1379533-b642-48ee-968a-b952c042ed94\",\n \"status\": 30,\n \"status_message\": \"Mail was sent\"\n },\n {\n \"id\": \"7aba31fe-490c-46f0-bd5e-82a0bc5648fc\",\n \"sg_external_id\": \"c1379533-b642-48ee-968a-b952c042ed94\",\n \"status\": 30,\n \"status_message\": \"Mail was sent\"\n }\n]", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "39a52cd0-828e-4a0b-8966-ba90b5310abc", "name": "Get status transactional journey", "request": { "name": "Get status transactional journey", "description": { "content": "Use this endpoint to get the status of a transactional message with a given id.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "transactional", "status", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) ID of the message. This is found in the return model of the [Send](#tag/Transactional-journey/operation/Transactional_Send) or [UpdateProfileAndSend](#tag/Transactional-journey/operation/TransactionalShortcut_UpdateProfileAndSendTransactional) call.", "type": "text/plain" }, "type": "any", "value": "973592c1-7198-4b10-aab1-db0da381cd13", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "9dcef3eb-2dd6-495a-aeee-7a2c1cfeeca6", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "transactional", "status", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"7aba31fe-490c-46f0-bd5e-82a0bc5648fc\",\n \"sg_external_id\": \"c1379533-b642-48ee-968a-b952c042ed94\",\n \"status\": 30,\n \"status_message\": \"Mail was sent\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "7fd5ca14-a18f-4f0d-a7df-6cc11843bdc3", "name": "Transactional Bulk journey", "description": { "content": "All transactional bulk journey endpoints", "type": "text/plain" }, "item": [ { "id": "238eeb63-bd51-4489-93db-06e3f75088d4", "name": "Trigger Transactional Bulk journey", "request": { "name": "Trigger Transactional Bulk journey", "description": { "content": "Use this method to trigger a bulk journey in a transactional way", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "transactional", "bulk", ":api_name", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the journey.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "c247e3b0-6d25-41f2-b4a9-5ed88b9c2156", "name": "Scheduled", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "transactional", "bulk", ":api_name", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"PartiallySucceeded\",\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"an error has occurred\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "0b41783f-76d8-49e9-a3bf-296543d61e02", "name": "Custom journey", "description": { "content": "All custom journey endpoints", "type": "text/plain" }, "item": [ { "id": "d9a9f945-3861-475e-ab72-fed220924f8d", "name": "Get custom journey", "request": { "name": "Get custom journey", "description": { "content": "Use this endpoint to check whether custom journey already exists.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "custom", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the journey.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "9fb51284-2d38-467e-beda-0312ff29f876", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "custom", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"api_name\": \"journey_1\",\n \"type\": \"custom\",\n \"name\": \"journey_1\",\n \"description\": \"this is the description.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "699ec43f-43b1-45d3-869d-731aafea0a02", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "custom", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "aute aliquip occaecat", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "beab8a8e-4314-4f67-a213-81ba45af849e", "name": "Delete custom journey", "request": { "name": "Delete custom journey", "description": { "content": "Use this endpoint to delete existing custom journey.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "custom", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the journey.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "adc9904b-5565-4fd3-8a97-0322b44d0f33", "name": "Deleted", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "custom", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The journey has been deleted successfully\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "521074a3-3028-4da2-8e26-fd00ac4473f6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "custom", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "aute aliquip occaecat", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "993052f6-5bfc-4a2e-a6a0-76e173406e02", "name": "Custom journey entrypoint", "description": { "content": "All custom journey endpoints", "type": "text/plain" }, "item": [ { "id": "faddf76b-3437-42ee-a473-4f3c5db3bade", "name": "List custom journey entrypoint components", "request": { "name": "List custom journey entrypoint components", "description": { "content": "Lists all entry point components in the custom journey usable via api.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "custom", ":api_name", "entrypoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the journey.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "957ee8ed-03de-4fe5-9541-a1e13ccfce14", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "custom", ":api_name", "entrypoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"info\": null,\n \"model\": {\n \"entry_point_type\": \"Input\",\n \"name\": \"My name of the entry point\",\n \"api_name\": \"entrypoint_api_name\"\n }\n },\n {\n \"info\": \"this entry point can not be used to trigger the journey as it is not yet published\",\n \"model\": {\n \"entry_point_type\": \"Input\",\n \"name\": null,\n \"api_name\": null\n }\n }\n]", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "6d7ad6e6-8ba4-4aa5-842f-f5175c2a9130", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "custom", ":api_name", "entrypoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "aute aliquip occaecat", "cookie": [] }, { "_": { "postman_previewlanguage": "text" }, "id": "75ba6923-f63a-41c3-b082-2ee4ba6b8e8d", "name": "Not found", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "custom", ":api_name", "entrypoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "196812be-9e5b-4912-a165-a26d96995cd8", "name": "Get custom journey entrypoint", "request": { "name": "Get custom journey entrypoint", "description": { "content": "Gets detailed information about the entry point component.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "custom", ":api_name", "entrypoints", ":entrypoint_api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the journey.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) the api name of the entry point defined in the custom journey.", "type": "text/plain" }, "type": "any", "value": "entrypoint_api_name_custom_journey", "key": "entrypoint_api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "0ba76933-6547-4553-b64a-c70f8e75c598", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "custom", ":api_name", "entrypoints", ":entrypoint_api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"system_info\": \"some optional system information about the entry point.\",\n \"model\": {\n \"entry_point_type\": \"Input\",\n \"name\": \"My name of the entry point\",\n \"api_name\": \"entrypoint_api_name\",\n \"parameters\": [\n {\n \"name\": \"PARAM1\",\n \"required\": true\n },\n {\n \"name\": \"PARAM2\",\n \"required\": false\n }\n ]\n }\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "48f5946c-cba6-4461-9a3d-710dbbcc4e54", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "custom", ":api_name", "entrypoints", ":entrypoint_api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "aute aliquip occaecat", "cookie": [] }, { "_": { "postman_previewlanguage": "text" }, "id": "2d1a59d5-45e3-4354-9bc8-b721a1ef4d7c", "name": "Not found", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "custom", ":api_name", "entrypoints", ":entrypoint_api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8cd69252-0324-4979-ae47-022ca799f3e4", "name": "Trigger custom journey entrypoint", "request": { "name": "Trigger custom journey entrypoint", "description": { "content": "This will trigger a specific start component in the custom journey", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "journeys", "custom", ":api_name", "entrypoints", ":entrypoint_api_name", "trigger" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the journey.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) the api name of the entry point defined in the custom journey.", "type": "text/plain" }, "type": "any", "value": "entrypoint_api_name_custom_journey", "key": "entrypoint_api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": 1,\n \"parameter_values\": {\n \"est_566\": \"tempor est eiusmod\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "a28c58b4-e404-4c8e-b2e4-1299e1d0b6fb", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "custom", ":api_name", "entrypoints", ":entrypoint_api_name", "trigger" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": 1,\n \"parameter_values\": {\n \"est_566\": \"tempor est eiusmod\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"PartiallySucceeded\",\n \"result_type\": \"Content\",\n \"body\": \"\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "d8ceb872-1a88-4f56-8ca0-35821ed79381", "name": "Failed to trigger", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "custom", ":api_name", "entrypoints", ":entrypoint_api_name", "trigger" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": 1,\n \"parameter_values\": {\n \"est_566\": \"tempor est eiusmod\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Success\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "3d5ee3a1-183c-498d-97d8-a38c3851667b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "custom", ":api_name", "entrypoints", ":entrypoint_api_name", "trigger" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": 1,\n \"parameter_values\": {\n \"est_566\": \"tempor est eiusmod\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "aute aliquip occaecat", "cookie": [] }, { "_": { "postman_previewlanguage": "text" }, "id": "2e52391a-afa5-48c6-afba-9a577002adda", "name": "Not found", "originalRequest": { "url": { "path": [ "organizations", ":organization", "journeys", "custom", ":api_name", "entrypoints", ":entrypoint_api_name", "trigger" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": 1,\n \"parameter_values\": {\n \"est_566\": \"tempor est eiusmod\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "3daac8ec-bf73-4c9e-acb6-af164f198942", "name": "List", "description": { "content": "All list endpoints", "type": "text/plain" }, "item": [ { "id": "7be4d3cb-7073-4aa8-a20b-9cb0b4af3db7", "name": "Get lists", "request": { "name": "Get lists", "description": { "content": "Get Lists defined for an organization.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by list typ(s). Multiple types can be provided comma separated.", "type": "text/plain" }, "key": "filter", "value": "UserList, Datalist" }, { "disabled": false, "description": { "content": "Search with a specific name, api_name, description or tag(s).", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" }, { "disabled": false, "description": { "content": "The maximum amount of items to return.", "type": "text/plain" }, "key": "take", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "14860a6a-0589-48b4-ba40-ceff5960694e", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by list typ(s). Multiple types can be provided comma separated.", "type": "text/plain" }, "key": "filter", "value": "UserList, Datalist" }, { "disabled": false, "description": { "content": "Search with a specific name, api_name, description or tag(s).", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" }, { "disabled": false, "description": { "content": "The maximum amount of items to return.", "type": "text/plain" }, "key": "take", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"list\": [\n {\n \"api_name\": \"list_1\",\n \"name\": \"List 1\",\n \"id\": 1,\n \"type\": \"Userlist\"\n },\n {\n \"api_name\": \"list_1\",\n \"name\": \"List 1\",\n \"id\": 1,\n \"type\": \"Userlist\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "97b470e4-a37f-4ab3-bd35-7020b2695de8", "name": "Create list", "request": { "name": "Create list", "description": { "content": "Create a new list in the given organization.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"list_1\",\n \"name\": \"List 1\",\n \"type\": \"Userlist\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"description\": \"This is my first userlist\",\n \"enforce_segment_selection\": true,\n \"folder\": \"folder_1\",\n \"optionlist_codetype\": \"Text\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "e8c0be78-c860-440e-a9c4-75158839c2ce", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"list_1\",\n \"name\": \"List 1\",\n \"type\": \"Userlist\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"description\": \"This is my first userlist\",\n \"enforce_segment_selection\": true,\n \"folder\": \"folder_1\",\n \"optionlist_codetype\": \"Text\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"List created successfully.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "15806a09-75d0-469d-8c68-c18825e15311", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"list_1\",\n \"name\": \"List 1\",\n \"type\": \"Userlist\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"description\": \"This is my first userlist\",\n \"enforce_segment_selection\": true,\n \"folder\": \"folder_1\",\n \"optionlist_codetype\": \"Text\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bd2e6c0f-7329-48e0-93b7-e93a42e90691", "name": "Get List", "request": { "name": "Get List", "description": { "content": "Get a list of details for the list with the given API name.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "73c9572b-0b33-4ccb-9ac5-01ed84288ad6", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"api_name\": \"list_1\",\n \"name\": \"List 1\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"enforce_segment_selection\": true,\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ],\n \"not_accessible_organizations_count\": 1,\n \"email_quality_configuration\": {\n \"email_quality_type\": \"Normal\",\n \"invalid_email_syntax\": 1,\n \"non_existing_domain\": 1,\n \"hard_bounce\": 1,\n \"soft_bounce\": 3,\n \"bounce_scope\": \"MASTER\",\n \"email_quality_actions\": [\n {\n \"field_name\": \"OPTOUT\",\n \"field_value\": \"esse proident fugiat\"\n },\n {\n \"field_name\": \"OPTOUT\",\n \"field_value\": \"dolore in incididunt\"\n }\n ],\n \"bounce_stored_procedures\": [\n \"SP_HANDLE_EMAIL_QUALITY_CONTROL\"\n ]\n },\n \"taglist_api_name\": \"tag_list_1\",\n \"type\": \"Userlist\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bec134c4-2d79-4dcf-8bd8-b97b1a10c042", "name": "Update list", "request": { "name": "Update list", "description": { "content": "Use this endpoint to update a list.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"list_1\",\n \"name\": \"List 1\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"description\": \"This is my first userlist\",\n \"enforce_segment_selection\": true,\n \"taglist_api_name\": \"tag_list_1\",\n \"email_quality_configuration\": {\n \"email_quality_type\": \"Normal\",\n \"bounce_scope\": \"MASTER\",\n \"email_quality_actions\": [\n {\n \"field_name\": \"OPTOUT\",\n \"field_value\": \"ea est quis\"\n },\n {\n \"field_name\": \"OPTOUT\",\n \"field_value\": \"in dolor\"\n }\n ],\n \"bounce_stored_procedures\": [\n \"SP_HANDLE_EMAIL_QUALITY_CONTROL\"\n ]\n },\n \"type\": \"Userlist\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "7ef162c6-d906-498d-b6cd-e3c3389748cb", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"list_1\",\n \"name\": \"List 1\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"description\": \"This is my first userlist\",\n \"enforce_segment_selection\": true,\n \"taglist_api_name\": \"tag_list_1\",\n \"email_quality_configuration\": {\n \"email_quality_type\": \"Normal\",\n \"bounce_scope\": \"MASTER\",\n \"email_quality_actions\": [\n {\n \"field_name\": \"OPTOUT\",\n \"field_value\": \"ea est quis\"\n },\n {\n \"field_name\": \"OPTOUT\",\n \"field_value\": \"in dolor\"\n }\n ],\n \"bounce_stored_procedures\": [\n \"SP_HANDLE_EMAIL_QUALITY_CONTROL\"\n ]\n },\n \"type\": \"Userlist\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"List updated successfully.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "82bede6b-5ad0-4b46-a67d-aac26b3b4a8b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"list_1\",\n \"name\": \"List 1\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"description\": \"This is my first userlist\",\n \"enforce_segment_selection\": true,\n \"taglist_api_name\": \"tag_list_1\",\n \"email_quality_configuration\": {\n \"email_quality_type\": \"Normal\",\n \"bounce_scope\": \"MASTER\",\n \"email_quality_actions\": [\n {\n \"field_name\": \"OPTOUT\",\n \"field_value\": \"ea est quis\"\n },\n {\n \"field_name\": \"OPTOUT\",\n \"field_value\": \"in dolor\"\n }\n ],\n \"bounce_stored_procedures\": [\n \"SP_HANDLE_EMAIL_QUALITY_CONTROL\"\n ]\n },\n \"type\": \"Userlist\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb2ab73a-0349-46e5-be84-cff1b1c2b026", "name": "Delete list", "request": { "name": "Delete list", "description": { "content": "Delete a list by its API name in the given organization.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specify if the associated table is to be deleted.", "type": "text/plain" }, "key": "dropTable", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "92cac067-d28e-4c73-9462-626d22889d04", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specify if the associated table is to be deleted.", "type": "text/plain" }, "key": "dropTable", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The list has been deleted successfully\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "c9caaa6f-3769-4f61-9c20-70347046e388", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specify if the associated table is to be deleted.", "type": "text/plain" }, "key": "dropTable", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_VALIDATION\",\n \"description\": \"Failed to delete list.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bdbdbf1c-e8bc-4bb1-9375-2b8d515cc2cd", "name": "Set (upsert) the business key of a list", "request": { "name": "Set (upsert) the business key of a list", "description": { "content": "Define or replace the business key of a list. A list has at most one business key,\ncomposed of 1–3 fields. The declaration is stored as metadata and, when no compatible\nunique index already exists on the underlying table, a `UNIQUE NONCLUSTERED` index is\ncreated automatically by the platform. Existing DBA-managed unique indexes that cover\nthe declared fields are honored as-is (no new index is created).\n\nThis endpoint has upsert semantics — it replaces whatever key is currently declared (or\ndeclares the first one) and always returns `200 OK` on success.\n\n**Guards:**\n\n- The list must be empty when no existing unique index already covers the requested fields.\n Use `GET /organizations/{organization}/lists/{api_name}/businesskey` to check the current\n declaration, and `DELETE` to remove it before redefining on a non-empty list.\n- Fields must exist on the list with indexable types.\n- The combined key size must fit within SQL Server's 900-byte unique-index budget.\n\nThe response `fields` array is sorted alphabetically (case-insensitive). The supplied\nfield order only controls the physical index column order at creation time.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "businesskey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"CUSTOMER_ID\",\n \"COUNTRY\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "11bb8be5-3880-4f36-82a4-2cabb05a0494", "name": "Business key set successfully (created or replaced).", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "businesskey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"CUSTOMER_ID\",\n \"COUNTRY\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"business_key\": {\n \"fields\": [\n \"COUNTRY\",\n \"CUSTOMER_ID\"\n ]\n }\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "136c99d6-7ee5-487f-a3e3-5d549464bae3", "name": "List is not empty and no existing unique index covers the requested fields", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "businesskey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"CUSTOMER_ID\",\n \"COUNTRY\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_LIST_BUSINESS_KEY_LIST_NOT_EMPTY\",\n \"description\": \"Cannot set a business key on a non-empty list when no unique index already covers the requested fields.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"error_code\": \"list_not_empty\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "de62bab1-179e-408b-93a1-f82d2a3f0a54", "name": "One or more fields do not exist or have non-indexable types", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "businesskey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"CUSTOMER_ID\",\n \"COUNTRY\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_LIST_BUSINESS_KEY_INVALID_FIELDS\",\n \"description\": \"Field 'UNKNOWN_FIELD' does not exist on the list.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"error_code\": \"invalid_fields\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "text" }, "id": "41034e8a-3f88-4ac7-8e00-f36abbabcb5e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "businesskey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"CUSTOMER_ID\",\n \"COUNTRY\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [] }, { "_": { "postman_previewlanguage": "text" }, "id": "994b91af-bcf1-4754-a119-186f30925dc3", "name": "Forbidden", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "businesskey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"CUSTOMER_ID\",\n \"COUNTRY\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [], "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "7088cac0-cfd4-4b02-a5d6-4b7c0823fac8", "name": "The list was not found.", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "businesskey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"CUSTOMER_ID\",\n \"COUNTRY\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_LIST_NOT_FOUND\",\n \"description\": \"The list was not found.\"\n }\n ],\n \"result_code\": \"NotFound\",\n \"error_code\": \"list_not_found\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "text" }, "id": "b3637361-53d9-44f8-b4db-3a17ddaed783", "name": "Too many requests", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "businesskey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"CUSTOMER_ID\",\n \"COUNTRY\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [], "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25fc0b3a-429f-4536-a36f-0eb19758389b", "name": "Get the business key of a list", "request": { "name": "Get the business key of a list", "description": { "content": "Retrieve the current business key declaration for a list. The key is modeled as a\ncomposite member of the list resource.\n\n- When a business key is declared, `business_key.fields` contains the field names sorted\n alphabetically (case-insensitive).\n- When no business key is declared, `business_key.fields` is an empty array.\n- `404` is only returned if the list itself does not exist.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "businesskey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "5f752e47-cd95-494c-89d5-385914531a94", "name": "List has a business key declared", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "businesskey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"business_key\": {\n \"fields\": [\n \"COUNTRY\",\n \"CUSTOMER_ID\"\n ]\n }\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "4dd86400-9f3a-43b1-b0c9-f9006cbfe2b3", "name": "List exists but no business key is declared", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "businesskey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"business_key\": {\n \"fields\": []\n }\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "text" }, "id": "48f6b7a1-c482-48e2-b53d-4c4c2bb55a04", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "businesskey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [] }, { "_": { "postman_previewlanguage": "text" }, "id": "b7c4cab2-ae24-4739-bd04-d103ef20fc2c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "businesskey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [], "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "5cdb5c69-c56a-4d19-abe4-3e55e69c3e9b", "name": "The list was not found.", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "businesskey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_LIST_NOT_FOUND\",\n \"description\": \"The list was not found.\"\n }\n ],\n \"result_code\": \"NotFound\",\n \"error_code\": \"list_not_found\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "text" }, "id": "8963fc31-90b2-4ffe-9b8e-c0047ec13440", "name": "Too many requests", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "businesskey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [], "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b9ff80bb-fbd5-4927-9b9e-63b95b2083cf", "name": "Delete the business key of a list", "request": { "name": "Delete the business key of a list", "description": { "content": "Remove the business key declaration from a list. Clears the metadata flags and drops\nthe backing platform-managed index (`UK_KEYDECL_*`) when one exists. DBA-managed unique\nindexes are left untouched.\n\nThis operation is safe at any row count — `DROP INDEX` is cheap and does not lock the table\nfor the duration of the operation. The key-field index guard on bulk import endpoints will\nre-apply on the next import if no other covering unique index remains.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "businesskey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "text" }, "id": "95fd1a99-c60f-4f04-99bb-b781672f0fd9", "name": "The business key was deleted successfully.", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "businesskey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [] }, { "_": { "postman_previewlanguage": "text" }, "id": "9f480cbc-14cf-4089-b749-b78b3612a8ea", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "businesskey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [] }, { "_": { "postman_previewlanguage": "text" }, "id": "d1956f36-23f8-418c-bf18-0bfc88c7a024", "name": "Forbidden", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "businesskey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [], "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "fd1af0d5-136c-4e55-8063-a71c8e3bcb39", "name": "The list or the business key was not found.", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "businesskey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_LIST_NOT_FOUND\",\n \"description\": \"The list was not found.\"\n }\n ],\n \"result_code\": \"NotFound\",\n \"error_code\": \"list_not_found\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "text" }, "id": "ffc54b4f-301b-4dfd-926d-b9c869089b8c", "name": "Too many requests", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "businesskey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [], "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "1f63e486-c18b-4fd7-a226-580e2112b16e", "name": "List Custom Event", "description": { "content": "All list event endpoints", "type": "text/plain" }, "item": [ { "id": "af26687a-c1df-4bd1-bbfe-24cdbca30200", "name": "List Custom Events", "request": { "name": "List Custom Events", "description": { "content": "Use this endpoint to get custom events", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by event type.", "type": "text/plain" }, "key": "filter", "value": "Streaming,Scheduled" }, { "disabled": false, "description": { "content": "Search with a specific name, api_name, description or tag(s).", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" }, { "disabled": false, "description": { "content": "The maximum amount of items to return.", "type": "text/plain" }, "key": "take", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "ff07aba3-fec6-4e66-94f4-38343b79a015", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by event type.", "type": "text/plain" }, "key": "filter", "value": "Streaming,Scheduled" }, { "disabled": false, "description": { "content": "Search with a specific name, api_name, description or tag(s).", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" }, { "disabled": false, "description": { "content": "The maximum amount of items to return.", "type": "text/plain" }, "key": "take", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"custom_events\": [\n {\n \"name\": \"Custom event 1\"\n },\n {\n \"name\": \"Custom event 2\"\n },\n {\n \"name\": \"Custom event 3\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "53476ab2-2bad-4148-b963-d48daac1aa9c", "name": "Create List Custom Event", "request": { "name": "Create List Custom Event", "description": { "content": "Use this endpoint to create a new custom event.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Custom event 1\",\n \"type\": \"Streaming\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"description\": \"This is my first custom event\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "a4efc0be-d126-4ed2-a74e-85aa870a1fd9", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Custom event 1\",\n \"type\": \"Streaming\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"description\": \"This is my first custom event\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The custom event has been saved successfully.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "5f98b9af-7a80-4a8c-bb47-043140c2cfd4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Custom event 1\",\n \"type\": \"Streaming\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"description\": \"This is my first custom event\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "14d672d6-700d-455c-945b-ca2fb6b79cad", "name": "Get List Custom Event", "request": { "name": "Get List Custom Event", "description": { "content": "Use this endpoint to get custom event details based on list API name and custom event name.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents", ":custom_event_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) Name of the custom event.", "type": "text/plain" }, "type": "any", "value": "custom_event_1", "key": "custom_event_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "99e568cc-8e33-440d-b602-d6cc830b2da6", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents", ":custom_event_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"custom_event\": {\n \"name\": \"Custom event 1\",\n \"description\": \"This is my first custom event\",\n \"type\": \"Streaming\",\n \"transaction_field\": \"USER_ID\"\n }\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "054b026c-9b9f-45b8-a127-903df5274f9b", "name": "Update List Custom Event", "request": { "name": "Update List Custom Event", "description": { "content": "Use this endpoint to update a custom event.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents", ":custom_event_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) Name of the custom event.", "type": "text/plain" }, "type": "any", "value": "custom_event_1", "key": "custom_event_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"Custom event 1\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"description\": \"This is my first custom event\",\n \"transaction_field\": \"USER_ID\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "e1d8c9ac-2bef-4dae-a4f1-0c67caf377de", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents", ":custom_event_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"Custom event 1\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"description\": \"This is my first custom event\",\n \"transaction_field\": \"USER_ID\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The custom event has been updated successfully.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "2aaa5ed9-d391-400a-944e-6b7142ac8af7", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents", ":custom_event_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"Custom event 1\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"description\": \"This is my first custom event\",\n \"transaction_field\": \"USER_ID\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8848dcbe-3242-4083-bd46-5af8760e26e6", "name": "Delete List Custom Event by name", "request": { "name": "Delete List Custom Event by name", "description": { "content": "Use this endpoint to delete a custom event by its name in the given organization.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents", ":custom_event_name" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specify if the associated table is to be deleted.", "type": "text/plain" }, "key": "dropTable", "value": "false" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) Name of the custom event.", "type": "text/plain" }, "type": "any", "value": "custom_event_1", "key": "custom_event_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "17a7b696-3984-4523-8846-3e291b9b9ff3", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents", ":custom_event_name" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specify if the associated table is to be deleted.", "type": "text/plain" }, "key": "dropTable", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The custom event has been deleted successfully\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "155c12cc-e86f-4463-8f14-25f7c30157be", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents", ":custom_event_name" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Specify if the associated table is to be deleted.", "type": "text/plain" }, "key": "dropTable", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_VALIDATION\",\n \"description\": \"Failed to delete custom event.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "79d1c45a-8b38-4526-ac3a-49c3246406c2", "name": "Trigger custom event Data processing", "request": { "name": "Trigger custom event Data processing", "description": { "content": "Use this endpoint to trigger the system, to process all incoming data on the custom event.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents", ":custom_event_name", "trigger" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) Name of the custom event.", "type": "text/plain" }, "type": "any", "value": "custom_event_1", "key": "custom_event_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "791aa96f-234e-4b91-9ffa-e4298e3070fb", "name": "Accepted", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents", ":custom_event_name", "trigger" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"trigger custom event request accepted and waiting to be processed.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "b0580836-3486-4333-9ea1-4ea731d77dbf", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents", ":custom_event_name", "trigger" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"triggering a custom event has failed\",\n \"errors\": [\n {\n \"error_code\": \"ERR_VALIDATION\",\n \"description\": \"Failed to trigger the custom event.\"\n }\n ],\n \"result_code\": \"Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "573d1f13-3e28-48a5-9828-6054e9e30f2c", "name": "Get custom event fields", "request": { "name": "Get custom event fields", "description": { "content": "Use this endpoint to get custom event fields based on list API name and custom event name.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents", ":custom_event_name", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) Name of the custom event.", "type": "text/plain" }, "type": "any", "value": "custom_event_1", "key": "custom_event_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "2f0c5c90-5411-4ba4-9ca4-4e2ffbcf2222", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents", ":custom_event_name", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"fields\": [\n {\n \"name\": \"field_1\",\n \"length\": 50,\n \"data_type\": \"Text\",\n \"description\": \"This is a field of type text.\",\n \"allow_null\": false,\n \"content\": \"Free\"\n },\n {\n \"name\": \"field_2\",\n \"data_type\": \"Numeric\",\n \"description\": \"This is a field of type numeric.\",\n \"allow_null\": false,\n \"content\": \"Free\"\n },\n {\n \"name\": \"field_3\",\n \"length\": 50,\n \"data_type\": \"Text\",\n \"description\": \"This is a field of type text with text optionlist association.\",\n \"allow_null\": true,\n \"content\": \"Multi\",\n \"optionlist\": \"Optionlist_Text_ApiName\"\n },\n {\n \"name\": \"field_4\",\n \"data_type\": \"Numeric\",\n \"description\": \"This is a field of type numeric with numeric optionlist association.\",\n \"allow_null\": false,\n \"content\": \"Single\",\n \"optionlist\": \"Optionlist_Numeric_ApiName\"\n },\n {\n \"name\": \"field_5\",\n \"data_type\": \"Boolean\",\n \"description\": \"This is a field of type boolean.\",\n \"allow_null\": false,\n \"content\": \"Free\"\n },\n {\n \"name\": \"field_6\",\n \"length\": 50,\n \"data_type\": \"Text\",\n \"description\": \"This is a field of type text.\",\n \"allow_null\": true,\n \"content\": \"ComputedPersisted\",\n \"value_definition\": \"[%[MASTER.ID]%]\"\n },\n {\n \"name\": \"field_7\",\n \"data_type\": \"Json\",\n \"description\": \"This is a field of type json.\",\n \"allow_null\": true,\n \"content\": \"Free\",\n \"json_schema\": [\n {\n \"name\": \"TextElement\",\n \"input_type\": \"Text\",\n \"required\": true\n },\n {\n \"name\": \"DateElement\",\n \"input_type\": \"Date\",\n \"required\": true\n },\n {\n \"name\": \"ArrayElement\",\n \"input_type\": \"Array\",\n \"required\": true,\n \"child_data\": [\n {\n \"name\": \"SubProperty1\",\n \"input_type\": \"Text\",\n \"required\": true\n },\n {\n \"name\": \"SubProperty2\",\n \"input_type\": \"Boolean\",\n \"required\": true\n }\n ]\n }\n ]\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "32ce6f8d-1a17-45e4-977b-d540d3ddfb6f", "name": "Create custom event field", "request": { "name": "Create custom event field", "description": { "content": "Use this endpoint to create a custom event fields.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents", ":custom_event_name", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) Name of the custom event.", "type": "text/plain" }, "type": "any", "value": "custom_event_1", "key": "custom_event_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n {\n \"name\": \"field_1\",\n \"length\": 50,\n \"data_type\": \"Text\",\n \"description\": \"This is a field of type text.\",\n \"allow_null\": false,\n \"content\": \"Free\"\n },\n {\n \"name\": \"field_2\",\n \"data_type\": \"Numeric\",\n \"description\": \"This is a field of type numeric.\",\n \"allow_null\": false,\n \"content\": \"Free\"\n },\n {\n \"name\": \"field_3\",\n \"length\": 50,\n \"data_type\": \"Text\",\n \"description\": \"This is a field of type text with text optionlist association.\",\n \"allow_null\": true,\n \"content\": \"Multi\",\n \"optionlist\": \"Optionlist_Text_ApiName\"\n },\n {\n \"name\": \"field_4\",\n \"data_type\": \"Numeric\",\n \"description\": \"This is a field of type numeric with numeric optionlist association.\",\n \"allow_null\": false,\n \"content\": \"Single\",\n \"optionlist\": \"Optionlist_Numeric_ApiName\"\n },\n {\n \"name\": \"field_5\",\n \"data_type\": \"Boolean\",\n \"description\": \"This is a field of type boolean.\",\n \"allow_null\": false,\n \"content\": \"Free\"\n },\n {\n \"name\": \"field_6\",\n \"length\": 50,\n \"data_type\": \"Text\",\n \"description\": \"This is a field of type text.\",\n \"allow_null\": true,\n \"content\": \"ComputedPersisted\",\n \"value_definition\": \"[%[MASTER.ID]%]\"\n },\n {\n \"name\": \"field_7\",\n \"data_type\": \"Json\",\n \"description\": \"This is a field of type json.\",\n \"allow_null\": true,\n \"content\": \"Free\",\n \"json_schema\": [\n {\n \"name\": \"TextElement\",\n \"input_type\": \"Text\",\n \"required\": true\n },\n {\n \"name\": \"DateElement\",\n \"input_type\": \"Date\",\n \"required\": true\n },\n {\n \"name\": \"ArrayElement\",\n \"input_type\": \"Array\",\n \"required\": true,\n \"child_data\": [\n {\n \"name\": \"SubProperty1\",\n \"input_type\": \"Text\",\n \"required\": true\n },\n {\n \"name\": \"SubProperty2\",\n \"input_type\": \"Boolean\",\n \"required\": true\n }\n ]\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "4143f89e-1c52-4125-93e5-bee5e4ad4e07", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents", ":custom_event_name", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n {\n \"name\": \"field_1\",\n \"length\": 50,\n \"data_type\": \"Text\",\n \"description\": \"This is a field of type text.\",\n \"allow_null\": false,\n \"content\": \"Free\"\n },\n {\n \"name\": \"field_2\",\n \"data_type\": \"Numeric\",\n \"description\": \"This is a field of type numeric.\",\n \"allow_null\": false,\n \"content\": \"Free\"\n },\n {\n \"name\": \"field_3\",\n \"length\": 50,\n \"data_type\": \"Text\",\n \"description\": \"This is a field of type text with text optionlist association.\",\n \"allow_null\": true,\n \"content\": \"Multi\",\n \"optionlist\": \"Optionlist_Text_ApiName\"\n },\n {\n \"name\": \"field_4\",\n \"data_type\": \"Numeric\",\n \"description\": \"This is a field of type numeric with numeric optionlist association.\",\n \"allow_null\": false,\n \"content\": \"Single\",\n \"optionlist\": \"Optionlist_Numeric_ApiName\"\n },\n {\n \"name\": \"field_5\",\n \"data_type\": \"Boolean\",\n \"description\": \"This is a field of type boolean.\",\n \"allow_null\": false,\n \"content\": \"Free\"\n },\n {\n \"name\": \"field_6\",\n \"length\": 50,\n \"data_type\": \"Text\",\n \"description\": \"This is a field of type text.\",\n \"allow_null\": true,\n \"content\": \"ComputedPersisted\",\n \"value_definition\": \"[%[MASTER.ID]%]\"\n },\n {\n \"name\": \"field_7\",\n \"data_type\": \"Json\",\n \"description\": \"This is a field of type json.\",\n \"allow_null\": true,\n \"content\": \"Free\",\n \"json_schema\": [\n {\n \"name\": \"TextElement\",\n \"input_type\": \"Text\",\n \"required\": true\n },\n {\n \"name\": \"DateElement\",\n \"input_type\": \"Date\",\n \"required\": true\n },\n {\n \"name\": \"ArrayElement\",\n \"input_type\": \"Array\",\n \"required\": true,\n \"child_data\": [\n {\n \"name\": \"SubProperty1\",\n \"input_type\": \"Text\",\n \"required\": true\n },\n {\n \"name\": \"SubProperty2\",\n \"input_type\": \"Boolean\",\n \"required\": true\n }\n ]\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Fields created successfully.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "69bf733e-f19f-43c7-bd7b-16185217a0c0", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents", ":custom_event_name", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n {\n \"name\": \"field_1\",\n \"length\": 50,\n \"data_type\": \"Text\",\n \"description\": \"This is a field of type text.\",\n \"allow_null\": false,\n \"content\": \"Free\"\n },\n {\n \"name\": \"field_2\",\n \"data_type\": \"Numeric\",\n \"description\": \"This is a field of type numeric.\",\n \"allow_null\": false,\n \"content\": \"Free\"\n },\n {\n \"name\": \"field_3\",\n \"length\": 50,\n \"data_type\": \"Text\",\n \"description\": \"This is a field of type text with text optionlist association.\",\n \"allow_null\": true,\n \"content\": \"Multi\",\n \"optionlist\": \"Optionlist_Text_ApiName\"\n },\n {\n \"name\": \"field_4\",\n \"data_type\": \"Numeric\",\n \"description\": \"This is a field of type numeric with numeric optionlist association.\",\n \"allow_null\": false,\n \"content\": \"Single\",\n \"optionlist\": \"Optionlist_Numeric_ApiName\"\n },\n {\n \"name\": \"field_5\",\n \"data_type\": \"Boolean\",\n \"description\": \"This is a field of type boolean.\",\n \"allow_null\": false,\n \"content\": \"Free\"\n },\n {\n \"name\": \"field_6\",\n \"length\": 50,\n \"data_type\": \"Text\",\n \"description\": \"This is a field of type text.\",\n \"allow_null\": true,\n \"content\": \"ComputedPersisted\",\n \"value_definition\": \"[%[MASTER.ID]%]\"\n },\n {\n \"name\": \"field_7\",\n \"data_type\": \"Json\",\n \"description\": \"This is a field of type json.\",\n \"allow_null\": true,\n \"content\": \"Free\",\n \"json_schema\": [\n {\n \"name\": \"TextElement\",\n \"input_type\": \"Text\",\n \"required\": true\n },\n {\n \"name\": \"DateElement\",\n \"input_type\": \"Date\",\n \"required\": true\n },\n {\n \"name\": \"ArrayElement\",\n \"input_type\": \"Array\",\n \"required\": true,\n \"child_data\": [\n {\n \"name\": \"SubProperty1\",\n \"input_type\": \"Text\",\n \"required\": true\n },\n {\n \"name\": \"SubProperty2\",\n \"input_type\": \"Boolean\",\n \"required\": true\n }\n ]\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c7bbbd9e-504d-4b65-ac4e-3c6314859bcb", "name": "Delete Custom Event field", "request": { "name": "Delete Custom Event field", "description": { "content": "Use this endpoint to delete a custom event field based on list's API name, custom event name and name of the field.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents", ":custom_event_name", "fields", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) Name of the custom event.", "type": "text/plain" }, "type": "any", "value": "custom_event_1", "key": "custom_event_name" }, { "disabled": false, "description": { "content": "(Required) Name of the field.", "type": "text/plain" }, "type": "any", "value": "storedprocedure_1", "key": "name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "cbfdcf68-3e78-468f-a8ee-9cbff5fbd043", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents", ":custom_event_name", "fields", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The custom event field has been deleted successfully\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "07886cba-07f9-4a35-af2b-c8ac2a08cc39", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents", ":custom_event_name", "fields", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_VALIDATION\",\n \"description\": \"Failed to delete custom event field.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "13c9829a-4daa-4320-b270-3e8a95b79000", "name": "Update list custom event field", "request": { "name": "Update list custom event field", "description": { "content": "Use this endpoint to update a custom event field.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents", ":custom_event_name", "fields", ":field_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) Name of the custom event.", "type": "text/plain" }, "type": "any", "value": "custom_event_1", "key": "custom_event_name" }, { "disabled": false, "description": { "content": "(Required) Name of the field.", "type": "text/plain" }, "type": "any", "value": "field_1", "key": "field_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"FIELD\",\n \"description\": \"This is FIELD with text optionlist association.\",\n \"content\": \"Free\",\n \"optionlist\": \"option_list_api_name\",\n \"json_schema\": [\n {\n \"name\": \"TextElement\",\n \"input_type\": \"Text\",\n \"required\": true\n },\n {\n \"name\": \"DateElement\",\n \"input_type\": \"Date\",\n \"required\": true\n },\n {\n \"name\": \"ArrayElement\",\n \"input_type\": \"Array\",\n \"required\": true,\n \"child_data\": [\n {\n \"name\": \"SubProperty1\",\n \"input_type\": \"Text\",\n \"required\": true\n },\n {\n \"name\": \"SubProperty2\",\n \"input_type\": \"Boolean\",\n \"required\": true\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "17884bd0-7f85-4c23-801f-2e4131b13f82", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents", ":custom_event_name", "fields", ":field_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"FIELD\",\n \"description\": \"This is FIELD with text optionlist association.\",\n \"content\": \"Free\",\n \"optionlist\": \"option_list_api_name\",\n \"json_schema\": [\n {\n \"name\": \"TextElement\",\n \"input_type\": \"Text\",\n \"required\": true\n },\n {\n \"name\": \"DateElement\",\n \"input_type\": \"Date\",\n \"required\": true\n },\n {\n \"name\": \"ArrayElement\",\n \"input_type\": \"Array\",\n \"required\": true,\n \"child_data\": [\n {\n \"name\": \"SubProperty1\",\n \"input_type\": \"Text\",\n \"required\": true\n },\n {\n \"name\": \"SubProperty2\",\n \"input_type\": \"Boolean\",\n \"required\": true\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The custom event field has been updated successfully.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "4570b822-e2d5-4586-b0d8-b2bc9fae40f7", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "customevents", ":custom_event_name", "fields", ":field_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"FIELD\",\n \"description\": \"This is FIELD with text optionlist association.\",\n \"content\": \"Free\",\n \"optionlist\": \"option_list_api_name\",\n \"json_schema\": [\n {\n \"name\": \"TextElement\",\n \"input_type\": \"Text\",\n \"required\": true\n },\n {\n \"name\": \"DateElement\",\n \"input_type\": \"Date\",\n \"required\": true\n },\n {\n \"name\": \"ArrayElement\",\n \"input_type\": \"Array\",\n \"required\": true,\n \"child_data\": [\n {\n \"name\": \"SubProperty1\",\n \"input_type\": \"Text\",\n \"required\": true\n },\n {\n \"name\": \"SubProperty2\",\n \"input_type\": \"Boolean\",\n \"required\": true\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_VALIDATION\",\n \"description\": \"Failed to update the field.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Error message\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b6995bb7-8e11-4796-bc1a-61037d7fec91", "name": "List data", "description": { "content": "All list data endpoints", "type": "text/plain" }, "item": [ { "id": "63cdafec-2dbd-4f48-8429-96d330c9511e", "name": "Create / Update data record", "request": { "name": "Create / Update data record", "description": { "content": "Use this endpoint to create or update a single record with data on a 1:1 relation.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "data" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma-separated list of fields used to identify records for upsert or delete matching.\n\n**Index requirement (bulk endpoints):** The destination list table must have a **unique** index whose key columns cover all specified fields. A non-unique index does not satisfy this requirement. When no compatible unique index exists, bulk operations return `400 ValidationFailed` with code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`. Use `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API.", "type": "text/plain" }, "key": "keyFields", "value": "USERID,BULK_MAIL_TYPE" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "Indicates the data import option during an import data.", "type": "text/plain" }, "type": "any", "value": "InsertAndUpdate", "key": "data_import_option" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"1\",\n \"mail\": \"john.doe@gmail.com\",\n \"master.name\": \"Doe\",\n \"scope1.field\": \"someValue\",\n \"scope2.field\": \"someOtherValue\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "030f2fdc-8869-406c-8ffa-6a871938e9e4", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "data" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma-separated list of fields used to identify records for upsert or delete matching.\n\n**Index requirement (bulk endpoints):** The destination list table must have a **unique** index whose key columns cover all specified fields. A non-unique index does not satisfy this requirement. When no compatible unique index exists, bulk operations return `400 ValidationFailed` with code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`. Use `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API.", "type": "text/plain" }, "key": "keyFields", "value": "USERID,BULK_MAIL_TYPE" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"1\",\n \"mail\": \"john.doe@gmail.com\",\n \"master.name\": \"Doe\",\n \"scope1.field\": \"someValue\",\n \"scope2.field\": \"someOtherValue\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Record ID 13 inserted on List DataApiOneToOne_A.\",\n \"record_status\": \"Inserted\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c7715559-5d23-43c0-a09c-37faf7cb932a", "name": "Delete list data records", "request": { "name": "Delete list data records", "description": { "content": "Use this endpoint to delete data in bulk from a specific list table. Records are matched for deletion using the `keyFields` parameter.\n\n**Key-field index requirement:** The destination table must have a **unique** index whose key columns cover all specified `keyFields`. When no compatible unique index exists:\n\n- Requests against tables with **≥ 5,000,000 rows** are rejected immediately (`400 ValidationFailed`, code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`).\n- Requests against smaller tables are allowed but aborted once **100,000 records** have been streamed.\n\nUse `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API, or create a DBA-managed unique index directly on the underlying table.\n\n**Per-list concurrency limit:** Only one bulk operation per list is permitted at a time. A second concurrent request against the same list is rejected immediately with `429 Too Many Requests`. Retry once the in-flight operation has completed.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "data" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma-separated list of fields used to identify records for upsert or delete matching.\n\n**Index requirement (bulk endpoints):** The destination list table must have a **unique** index whose key columns cover all specified fields. A non-unique index does not satisfy this requirement. When no compatible unique index exists, bulk operations return `400 ValidationFailed` with code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`. Use `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API.", "type": "text/plain" }, "key": "keyFields", "value": "USERID,BULK_MAIL_TYPE" }, { "disabled": false, "description": { "content": "A comma-separated list of the fields that are in the provided data records. Make sure that this list contains ALL fields (including the key fields) in the correct order. If this parameter is not provided, the first row of the provided data records will be used to determine the fields.", "type": "text/plain" }, "key": "fields", "value": "field1,field2" }, { "disabled": false, "description": { "content": "The mode of data transfer.", "type": "text/plain" }, "key": "mode", "value": "Sync" }, { "disabled": false, "description": { "content": "Parameter indicates error handling options whether to stop on error or continue on error. (None, StopOnError or ContinueOnError)", "type": "text/plain" }, "key": "errorHandling", "value": "StopOnError" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "c8db2d8a-7f5c-4214-85ce-3a6edc8954e8", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "data" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma-separated list of fields used to identify records for upsert or delete matching.\n\n**Index requirement (bulk endpoints):** The destination list table must have a **unique** index whose key columns cover all specified fields. A non-unique index does not satisfy this requirement. When no compatible unique index exists, bulk operations return `400 ValidationFailed` with code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`. Use `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API.", "type": "text/plain" }, "key": "keyFields", "value": "USERID,BULK_MAIL_TYPE" }, { "disabled": false, "description": { "content": "A comma-separated list of the fields that are in the provided data records. Make sure that this list contains ALL fields (including the key fields) in the correct order. If this parameter is not provided, the first row of the provided data records will be used to determine the fields.", "type": "text/plain" }, "key": "fields", "value": "field1,field2" }, { "disabled": false, "description": { "content": "The mode of data transfer.", "type": "text/plain" }, "key": "mode", "value": "Sync" }, { "disabled": false, "description": { "content": "Parameter indicates error handling options whether to stop on error or continue on error. (None, StopOnError or ContinueOnError)", "type": "text/plain" }, "key": "errorHandling", "value": "StopOnError" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ],\n \"result_code\": \"PartiallySucceeded\",\n \"number_of_duplicate_records\": 0,\n \"number_of_failed_records\": 2,\n \"number_of_records_not_found\": 0,\n \"invalid_records\": [\n {\n \"record_index\": 17,\n \"field_name\": \"EMAIL\",\n \"message\": \"Record contains incorrect number of fields\",\n \"validation_code\": \"InvalidFieldCount\"\n },\n {\n \"record_index\": 17,\n \"field_name\": \"EMAIL\",\n \"message\": \"Record contains incorrect number of fields\",\n \"validation_code\": \"InvalidFieldCount\"\n }\n ],\n \"number_of_deleted_records\": 48\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "ba28a321-0549-484d-b4eb-38e984a8b18a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "data" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma-separated list of fields used to identify records for upsert or delete matching.\n\n**Index requirement (bulk endpoints):** The destination list table must have a **unique** index whose key columns cover all specified fields. A non-unique index does not satisfy this requirement. When no compatible unique index exists, bulk operations return `400 ValidationFailed` with code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`. Use `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API.", "type": "text/plain" }, "key": "keyFields", "value": "USERID,BULK_MAIL_TYPE" }, { "disabled": false, "description": { "content": "A comma-separated list of the fields that are in the provided data records. Make sure that this list contains ALL fields (including the key fields) in the correct order. If this parameter is not provided, the first row of the provided data records will be used to determine the fields.", "type": "text/plain" }, "key": "fields", "value": "field1,field2" }, { "disabled": false, "description": { "content": "The mode of data transfer.", "type": "text/plain" }, "key": "mode", "value": "Sync" }, { "disabled": false, "description": { "content": "Parameter indicates error handling options whether to stop on error or continue on error. (None, StopOnError or ContinueOnError)", "type": "text/plain" }, "key": "errorHandling", "value": "StopOnError" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"ValidationFailed\",\n \"error_code\": \"LOAD_RECORDS_FAILED_BY_MISSING_INDEX\",\n \"message\": \"Table 'DATA_SUBSCRIPTIONS' has ~8000000 rows and no index on key fields [USERID, BULK_MAIL_TYPE]. Threshold: 5000000.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "text" }, "id": "cf8dd08a-2b2f-430c-a6b5-a1476ddd2025", "name": "A bulk operation is already in progress on this list. Retry once the in-flight operation has completed.", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "data" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma-separated list of fields used to identify records for upsert or delete matching.\n\n**Index requirement (bulk endpoints):** The destination list table must have a **unique** index whose key columns cover all specified fields. A non-unique index does not satisfy this requirement. When no compatible unique index exists, bulk operations return `400 ValidationFailed` with code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`. Use `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API.", "type": "text/plain" }, "key": "keyFields", "value": "USERID,BULK_MAIL_TYPE" }, { "disabled": false, "description": { "content": "A comma-separated list of the fields that are in the provided data records. Make sure that this list contains ALL fields (including the key fields) in the correct order. If this parameter is not provided, the first row of the provided data records will be used to determine the fields.", "type": "text/plain" }, "key": "fields", "value": "field1,field2" }, { "disabled": false, "description": { "content": "The mode of data transfer.", "type": "text/plain" }, "key": "mode", "value": "Sync" }, { "disabled": false, "description": { "content": "Parameter indicates error handling options whether to stop on error or continue on error. (None, StopOnError or ContinueOnError)", "type": "text/plain" }, "key": "errorHandling", "value": "StopOnError" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "API calls quota exceeded!", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2f0a3ae5-54d3-4e76-b626-38a16dee1f35", "name": "Create / update List data", "request": { "name": "Create / update List data", "description": { "content": "Use this endpoint to load data in bulk into a specific list table. Records are upserted using the `keyFields` parameter to match existing rows.\n\n**Key-field index requirement:** The destination table must have a **unique** index whose key columns cover all specified `keyFields`. When no compatible unique index exists:\n\n- Requests against tables with **≥ 5,000,000 rows** are rejected immediately (`400 ValidationFailed`, code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`).\n- Requests against smaller tables are allowed but aborted once **100,000 records** have been streamed.\n\nUse `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API, or create a DBA-managed unique index directly on the underlying table.\n\n**Per-list concurrency limit:** Only one bulk operation per list is permitted at a time. A second concurrent request against the same list is rejected immediately with `429 Too Many Requests`. Retry once the in-flight operation has completed.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "data", "load" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma-separated list of fields used to identify records for upsert or delete matching.\n\n**Index requirement (bulk endpoints):** The destination list table must have a **unique** index whose key columns cover all specified fields. A non-unique index does not satisfy this requirement. When no compatible unique index exists, bulk operations return `400 ValidationFailed` with code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`. Use `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API.", "type": "text/plain" }, "key": "keyFields", "value": "USERID,BULK_MAIL_TYPE" }, { "disabled": false, "description": { "content": "A comma-separated list of the fields that are in the provided data records. Make sure that this list contains ALL fields (including the key fields) in the correct order. If this parameter is not provided, the first row of the provided data records will be used to determine the fields.", "type": "text/plain" }, "key": "fields", "value": "field1,field2" }, { "disabled": false, "description": { "content": "The mode of data transfer.", "type": "text/plain" }, "key": "mode", "value": "Sync" }, { "disabled": false, "description": { "content": "The de-duplication option to use.", "type": "text/plain" }, "key": "deduplication", "value": "ImportLastMatch" }, { "disabled": false, "description": { "content": "Indicates the data import option during an import data.", "type": "text/plain" }, "key": "data_import_option", "value": "InsertAndUpdate" }, { "disabled": false, "description": { "content": "Indicates the name of segment at the time of segment creation.", "type": "text/plain" }, "key": "create_segment_name", "value": "Segment name" }, { "disabled": false, "description": { "content": "Indicates the api name of segment at the time of segment creation.", "type": "text/plain" }, "key": "create_segment_api_name", "value": "segment_api_name" }, { "disabled": false, "description": { "content": "Parameter indicates error handling options: whether to stop on error or continue on error.", "type": "text/plain" }, "key": "errorHandling", "value": "StopOnError" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "62549fb2-08ac-438d-98c6-18c250077906", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "data", "load" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma-separated list of fields used to identify records for upsert or delete matching.\n\n**Index requirement (bulk endpoints):** The destination list table must have a **unique** index whose key columns cover all specified fields. A non-unique index does not satisfy this requirement. When no compatible unique index exists, bulk operations return `400 ValidationFailed` with code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`. Use `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API.", "type": "text/plain" }, "key": "keyFields", "value": "USERID,BULK_MAIL_TYPE" }, { "disabled": false, "description": { "content": "A comma-separated list of the fields that are in the provided data records. Make sure that this list contains ALL fields (including the key fields) in the correct order. If this parameter is not provided, the first row of the provided data records will be used to determine the fields.", "type": "text/plain" }, "key": "fields", "value": "field1,field2" }, { "disabled": false, "description": { "content": "The mode of data transfer.", "type": "text/plain" }, "key": "mode", "value": "Sync" }, { "disabled": false, "description": { "content": "The de-duplication option to use.", "type": "text/plain" }, "key": "deduplication", "value": "ImportLastMatch" }, { "disabled": false, "description": { "content": "Indicates the data import option during an import data.", "type": "text/plain" }, "key": "data_import_option", "value": "InsertAndUpdate" }, { "disabled": false, "description": { "content": "Indicates the name of segment at the time of segment creation.", "type": "text/plain" }, "key": "create_segment_name", "value": "Segment name" }, { "disabled": false, "description": { "content": "Indicates the api name of segment at the time of segment creation.", "type": "text/plain" }, "key": "create_segment_api_name", "value": "segment_api_name" }, { "disabled": false, "description": { "content": "Parameter indicates error handling options: whether to stop on error or continue on error.", "type": "text/plain" }, "key": "errorHandling", "value": "StopOnError" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"PartiallySucceeded\",\n \"number_of_inserted_records\": 50,\n \"number_of_failed_records\": 2,\n \"number_of_updated_records\": 48,\n \"number_of_duplicate_records\": 0,\n \"number_of_records_not_found\": 0,\n \"invalid_records\": [\n {\n \"record_index\": 10,\n \"field_name\": \"SOMESTRING\",\n \"message\": \"Length of string (53) exceeds maximum field length (50)\",\n \"validation_code\": \"MaxStringLengthExceeded\"\n },\n {\n \"record_index\": 17,\n \"message\": \"Record contains incorrect number of fields\",\n \"validation_code\": \"InvalidFieldCount\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "2aa4f83f-e8a1-4427-a1bd-244617ee2cdb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "data", "load" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma-separated list of fields used to identify records for upsert or delete matching.\n\n**Index requirement (bulk endpoints):** The destination list table must have a **unique** index whose key columns cover all specified fields. A non-unique index does not satisfy this requirement. When no compatible unique index exists, bulk operations return `400 ValidationFailed` with code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`. Use `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API.", "type": "text/plain" }, "key": "keyFields", "value": "USERID,BULK_MAIL_TYPE" }, { "disabled": false, "description": { "content": "A comma-separated list of the fields that are in the provided data records. Make sure that this list contains ALL fields (including the key fields) in the correct order. If this parameter is not provided, the first row of the provided data records will be used to determine the fields.", "type": "text/plain" }, "key": "fields", "value": "field1,field2" }, { "disabled": false, "description": { "content": "The mode of data transfer.", "type": "text/plain" }, "key": "mode", "value": "Sync" }, { "disabled": false, "description": { "content": "The de-duplication option to use.", "type": "text/plain" }, "key": "deduplication", "value": "ImportLastMatch" }, { "disabled": false, "description": { "content": "Indicates the data import option during an import data.", "type": "text/plain" }, "key": "data_import_option", "value": "InsertAndUpdate" }, { "disabled": false, "description": { "content": "Indicates the name of segment at the time of segment creation.", "type": "text/plain" }, "key": "create_segment_name", "value": "Segment name" }, { "disabled": false, "description": { "content": "Indicates the api name of segment at the time of segment creation.", "type": "text/plain" }, "key": "create_segment_api_name", "value": "segment_api_name" }, { "disabled": false, "description": { "content": "Parameter indicates error handling options: whether to stop on error or continue on error.", "type": "text/plain" }, "key": "errorHandling", "value": "StopOnError" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"ValidationFailed\",\n \"number_of_inserted_records\": 0,\n \"number_of_failed_records\": 0,\n \"number_of_updated_records\": 0,\n \"number_of_duplicate_records\": 0,\n \"number_of_records_not_found\": 0,\n \"invalid_records\": null,\n \"error_code\": \"LOAD_RECORDS_FAILED_BY_MISSING_INDEX\",\n \"message\": \"Table 'DATA_SUBSCRIPTIONS' has ~8000000 rows and no index on key fields [USERID, BULK_MAIL_TYPE]. Threshold: 5000000.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "b1cf3c3f-a6b6-4f6d-bc11-b76675f44b53", "name": "Conflict", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "data", "load" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma-separated list of fields used to identify records for upsert or delete matching.\n\n**Index requirement (bulk endpoints):** The destination list table must have a **unique** index whose key columns cover all specified fields. A non-unique index does not satisfy this requirement. When no compatible unique index exists, bulk operations return `400 ValidationFailed` with code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`. Use `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API.", "type": "text/plain" }, "key": "keyFields", "value": "USERID,BULK_MAIL_TYPE" }, { "disabled": false, "description": { "content": "A comma-separated list of the fields that are in the provided data records. Make sure that this list contains ALL fields (including the key fields) in the correct order. If this parameter is not provided, the first row of the provided data records will be used to determine the fields.", "type": "text/plain" }, "key": "fields", "value": "field1,field2" }, { "disabled": false, "description": { "content": "The mode of data transfer.", "type": "text/plain" }, "key": "mode", "value": "Sync" }, { "disabled": false, "description": { "content": "The de-duplication option to use.", "type": "text/plain" }, "key": "deduplication", "value": "ImportLastMatch" }, { "disabled": false, "description": { "content": "Indicates the data import option during an import data.", "type": "text/plain" }, "key": "data_import_option", "value": "InsertAndUpdate" }, { "disabled": false, "description": { "content": "Indicates the name of segment at the time of segment creation.", "type": "text/plain" }, "key": "create_segment_name", "value": "Segment name" }, { "disabled": false, "description": { "content": "Indicates the api name of segment at the time of segment creation.", "type": "text/plain" }, "key": "create_segment_api_name", "value": "segment_api_name" }, { "disabled": false, "description": { "content": "Parameter indicates error handling options: whether to stop on error or continue on error.", "type": "text/plain" }, "key": "errorHandling", "value": "StopOnError" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "aute aliquip occaecat", "cookie": [] }, { "_": { "postman_previewlanguage": "text" }, "id": "342c8fc3-7f49-4abe-908e-e357fccecac9", "name": "A bulk operation is already in progress on this list. Retry once the in-flight operation has completed.", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "data", "load" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma-separated list of fields used to identify records for upsert or delete matching.\n\n**Index requirement (bulk endpoints):** The destination list table must have a **unique** index whose key columns cover all specified fields. A non-unique index does not satisfy this requirement. When no compatible unique index exists, bulk operations return `400 ValidationFailed` with code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`. Use `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API.", "type": "text/plain" }, "key": "keyFields", "value": "USERID,BULK_MAIL_TYPE" }, { "disabled": false, "description": { "content": "A comma-separated list of the fields that are in the provided data records. Make sure that this list contains ALL fields (including the key fields) in the correct order. If this parameter is not provided, the first row of the provided data records will be used to determine the fields.", "type": "text/plain" }, "key": "fields", "value": "field1,field2" }, { "disabled": false, "description": { "content": "The mode of data transfer.", "type": "text/plain" }, "key": "mode", "value": "Sync" }, { "disabled": false, "description": { "content": "The de-duplication option to use.", "type": "text/plain" }, "key": "deduplication", "value": "ImportLastMatch" }, { "disabled": false, "description": { "content": "Indicates the data import option during an import data.", "type": "text/plain" }, "key": "data_import_option", "value": "InsertAndUpdate" }, { "disabled": false, "description": { "content": "Indicates the name of segment at the time of segment creation.", "type": "text/plain" }, "key": "create_segment_name", "value": "Segment name" }, { "disabled": false, "description": { "content": "Indicates the api name of segment at the time of segment creation.", "type": "text/plain" }, "key": "create_segment_api_name", "value": "segment_api_name" }, { "disabled": false, "description": { "content": "Parameter indicates error handling options: whether to stop on error or continue on error.", "type": "text/plain" }, "key": "errorHandling", "value": "StopOnError" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "API calls quota exceeded!", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "29be3374-68dd-4170-b046-e9bb6df61d60", "name": "Search List records", "request": { "name": "Search List records", "description": { "content": "Use this endpoint to search for data records in a specific table. Searching data can be done synchronous or streamed. The data in the response will be in a Json format.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "data", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The mode of data transfer.", "type": "text/plain" }, "key": "mode", "value": "Sync" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"MASTER.FIELD_1\",\n \"MASTER.EMAIL\",\n \"SCOPE_1.FIELD_1\",\n \"SYSTEM.SELLIGENTID\"\n ],\n \"skip\": 1,\n \"take\": 1,\n \"order_by\": \"MASTER.NAME\",\n \"order_by_direction\": \"ASC\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "21a0647d-fc2b-4a14-a69a-7a2b942d243a", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "data", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The mode of data transfer.", "type": "text/plain" }, "key": "mode", "value": "Sync" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"MASTER.FIELD_1\",\n \"MASTER.EMAIL\",\n \"SCOPE_1.FIELD_1\",\n \"SYSTEM.SELLIGENTID\"\n ],\n \"skip\": 1,\n \"take\": 1,\n \"order_by\": \"MASTER.NAME\",\n \"order_by_direction\": \"ASC\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"fields\": [\n \"FIELD1\",\n \"MASTER.ID\"\n ],\n \"data\": [\n [\n \"RECORD1_FIELD1_VALUE\",\n 1\n ],\n [\n \"RECORD2_FIELD1_VALUE\",\n 2\n ],\n [\n \"RECORD3_FIELD1_VALUE\",\n 3\n ]\n ],\n \"result_code\": \"Succeeded\",\n \"errors\": []\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b97803f3-bd98-4ca8-8a9d-e121c96afeb5", "name": "List engagement", "description": { "content": "All list engagement endpoints", "type": "text/plain" }, "item": [ { "id": "f72100ce-1211-4387-b34a-19af51d1d0fa", "name": "Get List engagement structure", "request": { "name": "Get List engagement structure", "description": { "content": "This endpoint will return the engagement list structure for specified channel type for a user list.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "engagement", ":channel", "structure" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) Channel type.", "type": "text/plain" }, "type": "any", "value": "Email", "key": "channel" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "f58bb9e0-69b7-4229-a64a-6125f97c3bcb", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "engagement", ":channel", "structure" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"fields\": [\n {\n \"name\": \"ID\",\n \"data_type\": \"Numeric\",\n \"allow_null\": false,\n \"length\": null\n },\n {\n \"name\": \"USERID\",\n \"data_type\": \"Numeric\",\n \"allow_null\": true,\n \"length\": null\n },\n {\n \"name\": \"DELIVERED\",\n \"data_type\": \"Numeric\",\n \"allow_null\": true,\n \"length\": null\n },\n {\n \"name\": \"CLICKED\",\n \"data_type\": \"Numeric\",\n \"allow_null\": true,\n \"length\": null\n },\n {\n \"name\": \"VIEWED\",\n \"data_type\": \"Numeric\",\n \"allow_null\": true,\n \"length\": null\n },\n {\n \"name\": \"DELIVERED_LASTDT\",\n \"data_type\": \"DateTime\",\n \"allow_null\": true\n },\n {\n \"name\": \"VIEWED_LASTDT\",\n \"data_type\": \"DateTime\",\n \"allow_null\": true\n },\n {\n \"name\": \"CLICKED_LASTDT\",\n \"data_type\": \"DateTime\",\n \"allow_null\": true\n },\n {\n \"name\": \"DELIVERY_RATE\",\n \"data_type\": \"Float\",\n \"allow_null\": true\n },\n {\n \"name\": \"VIEW_RATE\",\n \"data_type\": \"Float\",\n \"allow_null\": true\n },\n {\n \"name\": \"CLICK_RATE_CTR\",\n \"data_type\": \"Float\",\n \"allow_null\": true\n },\n {\n \"name\": \"DESKTOP_ENGAGEMENTS\",\n \"data_type\": \"Numeric\",\n \"allow_null\": true,\n \"length\": null\n },\n {\n \"name\": \"MOBILE_ENGAGEMENTS\",\n \"data_type\": \"Numeric\",\n \"allow_null\": true,\n \"length\": null\n },\n {\n \"name\": \"TABLET_ENGAGEMENTS\",\n \"data_type\": \"Numeric\",\n \"allow_null\": true,\n \"length\": null\n },\n {\n \"name\": \"MOBILE_USAGE_RATE\",\n \"data_type\": \"Float\",\n \"allow_null\": true\n },\n {\n \"name\": \"TABLET_USAGE_RATE\",\n \"data_type\": \"Float\",\n \"allow_null\": true\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "f95ae10d-a5c9-4fd7-932b-73b2f6800521", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "engagement", ":channel", "structure" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_LIST_VALIDATION_RETRIEVEENGAGEMENTLISTSTRUCTUREFAILED\",\n \"description\": \"Failed to retrieve engagement list structure.\"\n }\n ],\n \"result_code\": \"ValidationFailed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e8884132-c30f-4166-9c77-dc0b7f6a2532", "name": "List Engagement data", "request": { "name": "List Engagement data", "description": { "content": "Get engagement list record data for specified channel type and master list record.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "engagement", ":channel", "data", ":record_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) Channel type.", "type": "text/plain" }, "type": "any", "value": "Email", "key": "channel" }, { "disabled": false, "description": { "content": "(Required) Parameter for record id associated with a list.", "type": "text/plain" }, "type": "any", "value": "1", "key": "record_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "e1faabb7-55e4-49a9-b920-3d8ae1ba8206", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "engagement", ":channel", "data", ":record_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"record\": {\n \"ID\": 1,\n \"USERID\": 1,\n \"DELIVERED\": 100,\n \"VIEWED\": 11602651,\n \"CLICKED\": 47020429,\n \"DELIVERED_LASTDT\": \"2023-09-11T10:01:03.01\",\n \"VIEWED_LASTDT\": \"2023-09-12T11:10:03.02\",\n \"CLICKED_LASTDT\": \"2023-09-13T14:25:04.03\",\n \"DELIVERY_RATE\": 95,\n \"VIEW_RATE\": 90,\n \"CLICK_RATE_CTR\": 85\n }\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "456a141b-55d4-4510-83d3-e2200cfaa726", "name": "List field", "description": { "content": "All list field endpoints", "type": "text/plain" }, "item": [ { "id": "e0762d25-c949-460d-9d2e-a66f9437847a", "name": "Get list fields", "request": { "name": "Get list fields", "description": { "content": "Use this endpoint to get list fields based on API name of list.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "03a2b565-dc8f-4675-af03-7cf216078215", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"fields\": [\n {\n \"name\": \"field_1\",\n \"length\": 50,\n \"data_type\": \"Text\",\n \"description\": \"This is a field of type text.\",\n \"allow_null\": false,\n \"content\": \"Free\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "98022d2d-0dff-4c33-8c6c-df3749512944", "name": "Create list fields", "request": { "name": "Create list fields", "description": { "content": "Use this endpoint to create list fields.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n {\n \"allow_null\": false,\n \"data_type\": \"Text\",\n \"description\": \"Some text field\",\n \"length\": 50,\n \"name\": \"TextField\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Boolean\",\n \"description\": \"Some boolean field\",\n \"name\": \"BooleanField\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Date\",\n \"description\": \"Some date field\",\n \"name\": \"DateField\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"DateTime\",\n \"description\": \"Some date time field\",\n \"name\": \"DateTimeField\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Float\",\n \"description\": \"Some float field\",\n \"name\": \"FloatField\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Long\",\n \"description\": \"Some long field\",\n \"name\": \"LongField\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"LongText\",\n \"description\": \"Some long text field\",\n \"name\": \"LongTextField\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Numeric\",\n \"description\": \"Some numeric field\",\n \"name\": \"NumericField\"\n },\n {\n \"allow_null\": false,\n \"data_type\": \"Numeric\",\n \"description\": \"Some numeric field\",\n \"name\": \"NumericFieldWithNumericOptionList\",\n \"content\": \"Single\",\n \"optionlist\": \"Optionlist_Numeric_ApiName\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Text\",\n \"length\": 50,\n \"description\": \"Some text field\",\n \"name\": \"TextFieldWithTextOptionList\",\n \"content\": \"Multi\",\n \"optionlist\": \"Optionlist_Text_ApiName\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Boolean\",\n \"description\": \"Some boolean field\",\n \"name\": \"BooleanFieldWithContentFree\",\n \"content\": \"Free\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Text\",\n \"description\": \"Some field\",\n \"name\": \"ComputedNonPersistedField\",\n \"content\": \"ComputedNonPersisted\",\n \"value_definition\": \"[%[MASTER.NAME]%]\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Text\",\n \"description\": \"Some field\",\n \"name\": \"ComputedPersistedField\",\n \"content\": \"ComputedPersisted\",\n \"value_definition\": \"[%lower( [MASTER.NAME] )%]\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Text\",\n \"length\": 50,\n \"name\": \"TextFieldWithIdentifiers\",\n \"description\": \"The type Lookup is used for a 'Data Selection Identifiers Set' field\",\n \"content\": \"Lookup\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "e2c24ac6-b48d-488f-bf52-20c261d55c15", "name": "Created", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n {\n \"allow_null\": false,\n \"data_type\": \"Text\",\n \"description\": \"Some text field\",\n \"length\": 50,\n \"name\": \"TextField\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Boolean\",\n \"description\": \"Some boolean field\",\n \"name\": \"BooleanField\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Date\",\n \"description\": \"Some date field\",\n \"name\": \"DateField\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"DateTime\",\n \"description\": \"Some date time field\",\n \"name\": \"DateTimeField\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Float\",\n \"description\": \"Some float field\",\n \"name\": \"FloatField\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Long\",\n \"description\": \"Some long field\",\n \"name\": \"LongField\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"LongText\",\n \"description\": \"Some long text field\",\n \"name\": \"LongTextField\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Numeric\",\n \"description\": \"Some numeric field\",\n \"name\": \"NumericField\"\n },\n {\n \"allow_null\": false,\n \"data_type\": \"Numeric\",\n \"description\": \"Some numeric field\",\n \"name\": \"NumericFieldWithNumericOptionList\",\n \"content\": \"Single\",\n \"optionlist\": \"Optionlist_Numeric_ApiName\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Text\",\n \"length\": 50,\n \"description\": \"Some text field\",\n \"name\": \"TextFieldWithTextOptionList\",\n \"content\": \"Multi\",\n \"optionlist\": \"Optionlist_Text_ApiName\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Boolean\",\n \"description\": \"Some boolean field\",\n \"name\": \"BooleanFieldWithContentFree\",\n \"content\": \"Free\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Text\",\n \"description\": \"Some field\",\n \"name\": \"ComputedNonPersistedField\",\n \"content\": \"ComputedNonPersisted\",\n \"value_definition\": \"[%[MASTER.NAME]%]\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Text\",\n \"description\": \"Some field\",\n \"name\": \"ComputedPersistedField\",\n \"content\": \"ComputedPersisted\",\n \"value_definition\": \"[%lower( [MASTER.NAME] )%]\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Text\",\n \"length\": 50,\n \"name\": \"TextFieldWithIdentifiers\",\n \"description\": \"The type Lookup is used for a 'Data Selection Identifiers Set' field\",\n \"content\": \"Lookup\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Fields created successfully.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "553ff445-c856-45b7-8b24-86823dd38bbb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n {\n \"allow_null\": false,\n \"data_type\": \"Text\",\n \"description\": \"Some text field\",\n \"length\": 50,\n \"name\": \"TextField\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Boolean\",\n \"description\": \"Some boolean field\",\n \"name\": \"BooleanField\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Date\",\n \"description\": \"Some date field\",\n \"name\": \"DateField\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"DateTime\",\n \"description\": \"Some date time field\",\n \"name\": \"DateTimeField\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Float\",\n \"description\": \"Some float field\",\n \"name\": \"FloatField\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Long\",\n \"description\": \"Some long field\",\n \"name\": \"LongField\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"LongText\",\n \"description\": \"Some long text field\",\n \"name\": \"LongTextField\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Numeric\",\n \"description\": \"Some numeric field\",\n \"name\": \"NumericField\"\n },\n {\n \"allow_null\": false,\n \"data_type\": \"Numeric\",\n \"description\": \"Some numeric field\",\n \"name\": \"NumericFieldWithNumericOptionList\",\n \"content\": \"Single\",\n \"optionlist\": \"Optionlist_Numeric_ApiName\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Text\",\n \"length\": 50,\n \"description\": \"Some text field\",\n \"name\": \"TextFieldWithTextOptionList\",\n \"content\": \"Multi\",\n \"optionlist\": \"Optionlist_Text_ApiName\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Boolean\",\n \"description\": \"Some boolean field\",\n \"name\": \"BooleanFieldWithContentFree\",\n \"content\": \"Free\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Text\",\n \"description\": \"Some field\",\n \"name\": \"ComputedNonPersistedField\",\n \"content\": \"ComputedNonPersisted\",\n \"value_definition\": \"[%[MASTER.NAME]%]\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Text\",\n \"description\": \"Some field\",\n \"name\": \"ComputedPersistedField\",\n \"content\": \"ComputedPersisted\",\n \"value_definition\": \"[%lower( [MASTER.NAME] )%]\"\n },\n {\n \"allow_null\": true,\n \"data_type\": \"Text\",\n \"length\": 50,\n \"name\": \"TextFieldWithIdentifiers\",\n \"description\": \"The type Lookup is used for a 'Data Selection Identifiers Set' field\",\n \"content\": \"Lookup\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cb78e281-2a22-412e-8bfb-510235ec9ad5", "name": "Update list field", "request": { "name": "Update list field", "description": { "content": "Use this endpoint to update an existing field of list.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "fields", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) Name of the field.", "type": "text/plain" }, "type": "any", "value": "storedprocedure_1", "key": "name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"field 1\",\n \"description\": \"This is a text field.\",\n \"content\": \"Lookup\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "56f4fec5-b524-42a6-acb4-5377accea696", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "fields", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"field 1\",\n \"description\": \"This is a text field.\",\n \"content\": \"Lookup\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The field has been updated successfully.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "d8735be9-4825-406d-ab21-e9aaa1ac347f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "fields", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"field 1\",\n \"description\": \"This is a text field.\",\n \"content\": \"Lookup\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_VALIDATION\",\n \"description\": \"Failed to update the field.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Error message\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "160e80cd-2c47-474b-9110-50a31008b60c", "name": "Delete list field", "request": { "name": "Delete list field", "description": { "content": "Use this endpoint to delete a list field based on list's API name and name of the field", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "fields", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) Name of the field.", "type": "text/plain" }, "type": "any", "value": "storedprocedure_1", "key": "name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "60cce847-e227-4e8f-8181-f5ace92ee4c5", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "fields", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"List field deleted successfully.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "a50b6817-98ed-497a-b8c3-36c7b1c2828d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "fields", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_VALIDATION\",\n \"description\": \"Failed to delete field.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "da8edbc9-3656-4d8a-a81b-193a8e59662a", "name": "List interest", "description": { "content": "All list interest endpoints", "type": "text/plain" }, "item": [ { "id": "b99065d4-14fc-4a90-a824-e43ce52b6c02", "name": "Get interest structure", "request": { "name": "Get interest structure", "description": { "content": "This endpoint will return the interest list structure for specified channel type for an user list.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "interest", ":channel", "structure" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) Channel type.", "type": "text/plain" }, "type": "any", "value": "Email", "key": "channel" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "45a9661b-b7da-4443-a663-58d35cb72871", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "interest", ":channel", "structure" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"fields\": [\n {\n \"name\": \"ID\",\n \"data_type\": \"Numeric\",\n \"allow_null\": false\n },\n {\n \"name\": \"USERID\",\n \"data_type\": \"Numeric\",\n \"allow_null\": true\n },\n {\n \"name\": \"TOP_TAG_1\",\n \"data_type\": \"Text\",\n \"length\": 255,\n \"allow_null\": true\n },\n {\n \"name\": \"TOP_TAG_2\",\n \"data_type\": \"Text\",\n \"length\": 255,\n \"allow_null\": true\n },\n {\n \"name\": \"TOP_TAG_3\",\n \"data_type\": \"Text\",\n \"length\": 255,\n \"allow_null\": true\n },\n {\n \"name\": \"TOP_TAG_4\",\n \"data_type\": \"Text\",\n \"length\": 255,\n \"allow_null\": true\n },\n {\n \"name\": \"TOP_TAG_5\",\n \"data_type\": \"Text\",\n \"length\": 255,\n \"allow_null\": true\n },\n {\n \"name\": \"TAG_CLICK_TOTAL\",\n \"data_type\": \"Numeric\",\n \"allow_null\": true\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "7ffb44ad-2910-42bf-8ce8-f974bc7b8a05", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "interest", ":channel", "structure" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_LIST_VALIDATION_RETRIEVEINTERESTLISTSTRUCTUREFAILED\",\n \"description\": \"Failed to retrieve interest list structure.\"\n }\n ],\n \"result_code\": \"ValidationFailed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e4c2207f-21bf-4363-b654-2a95dbc525ee", "name": "Get interest record", "request": { "name": "Get interest record", "description": { "content": "Use this endpoint to retrieve interest list record data for specified channel type and master list record.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "interest", ":channel", "data", ":record_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) Channel type.", "type": "text/plain" }, "type": "any", "value": "Email", "key": "channel" }, { "disabled": false, "description": { "content": "(Required) Parameter for record id associated with a list.", "type": "text/plain" }, "type": "any", "value": "1", "key": "record_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "64c14119-c6c5-4679-974b-34b3385e46b6", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "interest", ":channel", "data", ":record_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"record\": {\n \"ID\": 1,\n \"USERID\": 1,\n \"TOP_TAG_1\": \"Tag 1\",\n \"TOP_TAG_2\": \"Tag 2\",\n \"TOP_TAG_3\": \"Tag 3\",\n \"TOP_TAG_4\": \"Tag 4\",\n \"TOP_TAG_5\": \"Tag 5\",\n \"TAG_CLICK_TOTAL\": 10\n }\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "6c555db0-e6ad-40f8-9da4-60a47171fcfa", "name": "List record", "description": { "content": "All list record endpoints", "type": "text/plain" }, "item": [ { "id": "417d64cb-e88c-43ac-95e1-6e5733c7784e", "name": "List record count", "request": { "name": "List record count", "description": { "content": "Use this endpoint to get records count by API name of list.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "6b085fff-1e7c-4e01-b895-99c0eb10959f", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 4761\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8f51dd53-3893-4306-af76-10e5dc6dd7ab", "name": "Delete record", "request": { "name": "Delete record", "description": { "content": "Use this endpoint to delete single record by its record Id.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "records", ":record_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) Required Parameter to specify if the associated record is to be deleted.", "type": "text/plain" }, "type": "any", "value": "4761", "key": "record_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "0c57f6b4-dc98-4be1-9b66-8037bb271345", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "records", ":record_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "72570bf7-d33b-430d-995f-f7e9452e4012", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "records", ":record_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_VALIDATION\",\n \"description\": \"Failed to delete list record.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f0287715-9be3-4029-86f9-bc8bc5544055", "name": "List relation", "description": { "content": "All list relation endpoints", "type": "text/plain" }, "item": [ { "id": "3af29c33-749e-4ebb-943a-c0cd1ecf3a76", "name": "List list relations", "request": { "name": "List list relations", "description": { "content": "Use this endpoint to get all relations associated with a list.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "relations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter relations by relation type.", "type": "text/plain" }, "key": "filter", "value": "OneToOne, OneToMany" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "1e0d2c4d-2dc4-4956-a0de-a71f822a7e33", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "relations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter relations by relation type.", "type": "text/plain" }, "key": "filter", "value": "OneToOne, OneToMany" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"relations\": [\n {\n \"type\": \"ManyToOne\",\n \"scope\": \"SCOPE_1\",\n \"source_list_api_name\": \"source_list_api_name\",\n \"destination_list_api_name\": \"destination_list_1_api_name\"\n },\n {\n \"type\": \"OneToMany\",\n \"scope\": \"SCOPE_2\",\n \"source_list_api_name\": \"source_list_api_name\",\n \"destination_list_api_name\": \"destination_list_2_api_name\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6be00051-8ef1-458f-8642-3e3eb8d3a3c9", "name": "Create list relations", "request": { "name": "Create list relations", "description": { "content": "Use this endpoint to create relations between 2 lists.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "relations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"relations\": [\n {\n \"type\": \"OneToMany\",\n \"scope\": \"SCOPE1\",\n \"masterlist_field_name\": \"masterlist_field_name\",\n \"slavelist_api_name\": \"slavelist_api_name\",\n \"slavelist_field_name\": \"slavelist_field_name\",\n \"constraints\": [\n {\n \"list1\": \"MASTER\",\n \"field1\": \"master_field\",\n \"operator\": \"EqualTo\",\n \"list2\": \"EXTENSION\",\n \"field2\": \"extension_field\"\n },\n {\n \"list1\": \"MASTER\",\n \"field1\": \"master_field\",\n \"operator\": \"EqualTo\",\n \"value\": \"10\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "813cfb0e-cf37-441d-ab99-38c3b802152a", "name": "Created", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "relations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"relations\": [\n {\n \"type\": \"OneToMany\",\n \"scope\": \"SCOPE1\",\n \"masterlist_field_name\": \"masterlist_field_name\",\n \"slavelist_api_name\": \"slavelist_api_name\",\n \"slavelist_field_name\": \"slavelist_field_name\",\n \"constraints\": [\n {\n \"list1\": \"MASTER\",\n \"field1\": \"master_field\",\n \"operator\": \"EqualTo\",\n \"list2\": \"EXTENSION\",\n \"field2\": \"extension_field\"\n },\n {\n \"list1\": \"MASTER\",\n \"field1\": \"master_field\",\n \"operator\": \"EqualTo\",\n \"value\": \"10\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": null,\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "18967359-3f5e-4d95-8e75-bf8f3ab5a601", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "relations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"relations\": [\n {\n \"type\": \"OneToMany\",\n \"scope\": \"SCOPE1\",\n \"masterlist_field_name\": \"masterlist_field_name\",\n \"slavelist_api_name\": \"slavelist_api_name\",\n \"slavelist_field_name\": \"slavelist_field_name\",\n \"constraints\": [\n {\n \"list1\": \"MASTER\",\n \"field1\": \"master_field\",\n \"operator\": \"EqualTo\",\n \"list2\": \"EXTENSION\",\n \"field2\": \"extension_field\"\n },\n {\n \"list1\": \"MASTER\",\n \"field1\": \"master_field\",\n \"operator\": \"EqualTo\",\n \"value\": \"10\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_VALIDATION\",\n \"description\": \"Failed to create list relation.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "246d7684-73cd-4d16-90bd-2213f7743b4d", "name": "Get list relation", "request": { "name": "Get list relation", "description": { "content": "Use this endpoint to get relation details based on API name of the list and name of the relation.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "relations", ":scope" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) Scope name of the relation.", "type": "text/plain" }, "type": "any", "value": "RELATION_1", "key": "scope" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "a116f629-a0fd-4c9c-be50-665af84e0f4b", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "relations", ":scope" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"scope_name\": \"RELATION\",\n \"relation_type\": \"OneToMany\",\n \"master_list_api_name\": \"master_list\",\n \"master_list_field_name\": \"master_field\",\n \"slave_list_api_name\": \"extension_list\",\n \"slave_list_field_name\": \"extension_field\",\n \"constraints\": [\n {\n \"source_list\": \"MASTER\",\n \"source_field\": \"master_field\",\n \"operator\": \"EqualTo\",\n \"destination_list\": \"EXTENSION\",\n \"destination_field\": \"extension_field\",\n \"field_value\": null\n },\n {\n \"source_list\": \"MASTER\",\n \"source_field\": \"master_field\",\n \"operator\": \"EqualTo\",\n \"destination_list\": null,\n \"destination_field\": null,\n \"field_value\": \"10\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "938ba93b-4020-4747-bf1f-a2ea2367faa0", "name": "Update list relation", "request": { "name": "Update list relation", "description": { "content": "Use this endpoint to update an existing relation between the given list and a linked list.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "relations", ":scope" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) Scope name of the relation.", "type": "text/plain" }, "type": "any", "value": "RELATION_1", "key": "scope" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"scope\": \"NEW_RELATION_NAME\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "c073b2a6-a48c-4b4b-bd3b-ef1ce216518e", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "relations", ":scope" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"scope\": \"NEW_RELATION_NAME\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The relation was successfully updated.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "a0dd2b8b-90cc-4902-b0ad-78b550848ab8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "relations", ":scope" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"scope\": \"NEW_RELATION_NAME\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"an error has occurred\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Error message\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "781e3e95-7800-4083-aa37-075821a911fe", "name": "Delete list relation", "request": { "name": "Delete list relation", "description": { "content": "Use this endpoint to delete a relation between this list and another.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "relations", ":scope" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) Scope name of the relation.", "type": "text/plain" }, "type": "any", "value": "RELATION_1", "key": "scope" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "016cfd56-64fd-4100-a550-7d6ad66f7f3b", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "relations", ":scope" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The relation has been deleted successfully\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "a3aad9fd-d884-4655-9dc3-d0ab1dd19e4d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "relations", ":scope" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_FAILED\",\n \"description\": \"Failed to delete list relation.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "6d9f22b7-269b-43f3-b354-51f38ba168de", "name": "List segment", "description": { "content": "All list relation endpoints", "type": "text/plain" }, "item": [ { "id": "1674cb7c-b8ef-4b0d-a6a6-9be530fcb324", "name": "Get list segments", "request": { "name": "Get list segments", "description": { "content": "Get an overview of the segments defined on the given list.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter segment by type.", "type": "text/plain" }, "key": "filter", "value": "Static,Dynamic" }, { "disabled": false, "description": { "content": "The maximum amount of items to return.", "type": "text/plain" }, "key": "take", "value": "50" }, { "disabled": false, "description": { "content": "Search with a specific name, api_name, description or tag(s).", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "0b4b4a7f-a161-43df-a019-67adcad1eeae", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter segment by type.", "type": "text/plain" }, "key": "filter", "value": "Static,Dynamic" }, { "disabled": false, "description": { "content": "The maximum amount of items to return.", "type": "text/plain" }, "key": "take", "value": "50" }, { "disabled": false, "description": { "content": "Search with a specific name, api_name, description or tag(s).", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"segments\": [\n {\n \"segment_type\": \"Dynamic\",\n \"api_name\": \"segment_1\"\n },\n {\n \"segment_type\": \"External\",\n \"api_name\": \"segment_2\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "75484cde-daf4-4860-9dbb-f8c3434a808e", "name": "Get list segment", "request": { "name": "Get list segment", "description": { "content": "Use this endpoint to get segment details based on list API name and segment API name.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", ":segment_api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) API name of the segment.", "type": "text/plain" }, "type": "any", "value": "api_name_segment", "key": "segment_api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "953a24e8-d982-4165-a0c8-f08e2d89fced", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", ":segment_api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"api_name\": \"segment_1\",\n \"type\": \"Dynamic\",\n \"name\": \"Segment 1\",\n \"description\": \"My first segment\",\n \"expression\": \"gt([MASTER.ID], toint('1'))\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "58317ecf-dec8-4ae7-99f8-cd7658e70e36", "name": "Delete list segment", "request": { "name": "Delete list segment", "description": { "content": "Use this endpoint to delete a segment by its API name in the given organization.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", ":segment_api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) API name of the segment.", "type": "text/plain" }, "type": "any", "value": "api_name_segment", "key": "segment_api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "54e5107b-ec9c-4918-92b0-a3523470b54c", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", ":segment_api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The segment has been deleted successfully\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "a9b1a020-1f30-4567-9d35-186f80f47db9", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", ":segment_api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_LIST_VALIDATION\",\n \"description\": \"Failed to delete segment.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "87fe7d2a-a3cc-4e46-9b3a-6acb28d8174f", "name": "Create dynamic segment", "request": { "name": "Create dynamic segment", "description": { "content": "Create dynamic segment for the given list API name.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", "dynamic" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"segment_1\",\n \"name\": \"Segment 1\",\n \"constraint\": \"gt([MASTER.ID], toint('1'))\",\n \"description\": \"My first segment\",\n \"folder\": \"folder_1\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "a78fda8c-1313-4d18-afc0-3d5e933acf0b", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", "dynamic" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"segment_1\",\n \"name\": \"Segment 1\",\n \"constraint\": \"gt([MASTER.ID], toint('1'))\",\n \"description\": \"My first segment\",\n \"folder\": \"folder_1\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The dynamic segment has been created successfully.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "cde0c963-7fa0-428e-8394-ef6d448f7743", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", "dynamic" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"segment_1\",\n \"name\": \"Segment 1\",\n \"constraint\": \"gt([MASTER.ID], toint('1'))\",\n \"description\": \"My first segment\",\n \"folder\": \"folder_1\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b22330d7-bb4d-492e-8602-66e20eb55823", "name": "Update dynamic segment", "request": { "name": "Update dynamic segment", "description": { "content": "Update dynamic segment based on list API name and Segment API name", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", "dynamic", ":segment_api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) API name of the segment.", "type": "text/plain" }, "type": "any", "value": "api_name_segment", "key": "segment_api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"segment_1\",\n \"name\": \"Segment 1\",\n \"description\": \"My first segment\",\n \"folder\": \"folder_1\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"constraint\": \"gt([MASTER.ID], toint('1'))\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "ee0d00aa-a62b-4899-b0f9-c45b8b69e796", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", "dynamic", ":segment_api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"segment_1\",\n \"name\": \"Segment 1\",\n \"description\": \"My first segment\",\n \"folder\": \"folder_1\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"constraint\": \"gt([MASTER.ID], toint('1'))\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The dynamic segment has been created successfully.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "e641fbb8-e804-4139-b1f8-64f9bcac07f1", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", "dynamic", ":segment_api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"segment_1\",\n \"name\": \"Segment 1\",\n \"description\": \"My first segment\",\n \"folder\": \"folder_1\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"constraint\": \"gt([MASTER.ID], toint('1'))\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1f80e133-b3eb-4699-8758-8851d48c8062", "name": "Create static segment", "request": { "name": "Create static segment", "description": { "content": "Create static segment based on list API name and provided segment info parameters.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", "static" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"segment_1\",\n \"name\": \"Segment 1\",\n \"description\": \"My first segment\",\n \"folder\": \"folder_1\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "ae2ff3c7-6bc2-4148-8d5a-24d68efe6b73", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", "static" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"segment_1\",\n \"name\": \"Segment 1\",\n \"description\": \"My first segment\",\n \"folder\": \"folder_1\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The static segment has been created successfully.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "7869a876-260d-41ff-8f7d-db554e8e1cc2", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", "static" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"segment_1\",\n \"name\": \"Segment 1\",\n \"description\": \"My first segment\",\n \"folder\": \"folder_1\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "74757e38-aaa4-412b-9d25-37817e278926", "name": "Delete data from a static segment", "request": { "name": "Delete data from a static segment", "description": { "content": "Use this endpoint to delete data in bulk from a specific static segment. Records are matched for deletion using the `keyFields` parameter.\n\n**Key-field index requirement:** The destination list table must have a **unique** index whose key columns cover all specified `keyFields`. When no compatible unique index exists:\n\n- Requests against tables with **≥ 5,000,000 rows** are rejected immediately (`400 ValidationFailed`, code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`).\n- Requests against smaller tables are allowed but aborted once **100,000 records** have been streamed.\n\nUse `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API, or create a DBA-managed unique index directly on the underlying table.\n\n**Per-list concurrency limit:** Only one bulk operation per list is permitted at a time. A second concurrent request against the same list is rejected immediately with `429 Too Many Requests`. Retry once the in-flight operation has completed.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", ":segment_api_name", "data" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma-separated list of fields used to identify records for upsert or delete matching.\n\n**Index requirement (bulk endpoints):** The destination list table must have a **unique** index whose key columns cover all specified fields. A non-unique index does not satisfy this requirement. When no compatible unique index exists, bulk operations return `400 ValidationFailed` with code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`. Use `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API.", "type": "text/plain" }, "key": "keyFields", "value": "USERID,BULK_MAIL_TYPE" }, { "disabled": false, "description": { "content": "A comma-separated list of the fields that are in the provided data records. Make sure that this list contains ALL fields (including the key fields) in the correct order. If this parameter is not provided, the first row of the provided data records will be used to determine the fields.", "type": "text/plain" }, "key": "fields", "value": "field1,field2" }, { "disabled": false, "description": { "content": "The mode of data transfer.", "type": "text/plain" }, "key": "mode", "value": "Sync" }, { "disabled": false, "description": { "content": "The de-duplication option to use.", "type": "text/plain" }, "key": "deduplication", "value": "ImportLastMatch" }, { "disabled": false, "description": { "content": "Parameter indicates error handling options whether to stop on error or continue on error.", "type": "text/plain" }, "key": "errorHandling", "value": "ContinueOnError" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) API name of the segment.", "type": "text/plain" }, "type": "any", "value": "api_name_segment", "key": "segment_api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "f5e879ae-2d36-463e-94bf-5abb1bf9e385", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", ":segment_api_name", "data" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma-separated list of fields used to identify records for upsert or delete matching.\n\n**Index requirement (bulk endpoints):** The destination list table must have a **unique** index whose key columns cover all specified fields. A non-unique index does not satisfy this requirement. When no compatible unique index exists, bulk operations return `400 ValidationFailed` with code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`. Use `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API.", "type": "text/plain" }, "key": "keyFields", "value": "USERID,BULK_MAIL_TYPE" }, { "disabled": false, "description": { "content": "A comma-separated list of the fields that are in the provided data records. Make sure that this list contains ALL fields (including the key fields) in the correct order. If this parameter is not provided, the first row of the provided data records will be used to determine the fields.", "type": "text/plain" }, "key": "fields", "value": "field1,field2" }, { "disabled": false, "description": { "content": "The mode of data transfer.", "type": "text/plain" }, "key": "mode", "value": "Sync" }, { "disabled": false, "description": { "content": "The de-duplication option to use.", "type": "text/plain" }, "key": "deduplication", "value": "ImportLastMatch" }, { "disabled": false, "description": { "content": "Parameter indicates error handling options whether to stop on error or continue on error.", "type": "text/plain" }, "key": "errorHandling", "value": "ContinueOnError" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"PartiallySucceeded\",\n \"number_of_deleted_records\": 48,\n \"number_of_duplicate_records\": 0,\n \"number_of_failed_records\": 2,\n \"number_of_records_not_found\": 0,\n \"invalid_records\": [\n {\n \"record_index\": 17,\n \"message\": \"Record contains incorrect number of fields\",\n \"validation_code\": \"InvalidFieldCount\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "8ee6ae8f-1028-4aa9-9764-102f0208283c", "name": "Invalid payload", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", ":segment_api_name", "data" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma-separated list of fields used to identify records for upsert or delete matching.\n\n**Index requirement (bulk endpoints):** The destination list table must have a **unique** index whose key columns cover all specified fields. A non-unique index does not satisfy this requirement. When no compatible unique index exists, bulk operations return `400 ValidationFailed` with code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`. Use `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API.", "type": "text/plain" }, "key": "keyFields", "value": "USERID,BULK_MAIL_TYPE" }, { "disabled": false, "description": { "content": "A comma-separated list of the fields that are in the provided data records. Make sure that this list contains ALL fields (including the key fields) in the correct order. If this parameter is not provided, the first row of the provided data records will be used to determine the fields.", "type": "text/plain" }, "key": "fields", "value": "field1,field2" }, { "disabled": false, "description": { "content": "The mode of data transfer.", "type": "text/plain" }, "key": "mode", "value": "Sync" }, { "disabled": false, "description": { "content": "The de-duplication option to use.", "type": "text/plain" }, "key": "deduplication", "value": "ImportLastMatch" }, { "disabled": false, "description": { "content": "Parameter indicates error handling options whether to stop on error or continue on error.", "type": "text/plain" }, "key": "errorHandling", "value": "ContinueOnError" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"INVALIDPAYLOAD\",\n \"description\": \"Invalid payload detected when loading.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"number_of_deleted_records\": 0,\n \"number_of_duplicate_records\": 0,\n \"number_of_failed_records\": 0,\n \"number_of_records_not_found\": 0,\n \"invalid_records\": null\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "8fbf7255-bd53-4445-a096-dde8b2f4b1b3", "name": "No unique index on key fields", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", ":segment_api_name", "data" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma-separated list of fields used to identify records for upsert or delete matching.\n\n**Index requirement (bulk endpoints):** The destination list table must have a **unique** index whose key columns cover all specified fields. A non-unique index does not satisfy this requirement. When no compatible unique index exists, bulk operations return `400 ValidationFailed` with code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`. Use `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API.", "type": "text/plain" }, "key": "keyFields", "value": "USERID,BULK_MAIL_TYPE" }, { "disabled": false, "description": { "content": "A comma-separated list of the fields that are in the provided data records. Make sure that this list contains ALL fields (including the key fields) in the correct order. If this parameter is not provided, the first row of the provided data records will be used to determine the fields.", "type": "text/plain" }, "key": "fields", "value": "field1,field2" }, { "disabled": false, "description": { "content": "The mode of data transfer.", "type": "text/plain" }, "key": "mode", "value": "Sync" }, { "disabled": false, "description": { "content": "The de-duplication option to use.", "type": "text/plain" }, "key": "deduplication", "value": "ImportLastMatch" }, { "disabled": false, "description": { "content": "Parameter indicates error handling options whether to stop on error or continue on error.", "type": "text/plain" }, "key": "errorHandling", "value": "ContinueOnError" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"LOAD_RECORDS_FAILED_BY_MISSING_INDEX\",\n \"description\": \"Table 'DATA_SUBSCRIPTIONS' has ~8000000 rows and no index on key fields [USERID, BULK_MAIL_TYPE]. Threshold: 5000000.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"number_of_deleted_records\": 0,\n \"number_of_duplicate_records\": 0,\n \"number_of_failed_records\": 0,\n \"number_of_records_not_found\": 0,\n \"invalid_records\": null\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "text" }, "id": "4901f014-0dea-4b1f-bbbf-5122ec43a374", "name": "A bulk operation is already in progress on this list. Retry once the in-flight operation has completed.", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", ":segment_api_name", "data" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma-separated list of fields used to identify records for upsert or delete matching.\n\n**Index requirement (bulk endpoints):** The destination list table must have a **unique** index whose key columns cover all specified fields. A non-unique index does not satisfy this requirement. When no compatible unique index exists, bulk operations return `400 ValidationFailed` with code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`. Use `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API.", "type": "text/plain" }, "key": "keyFields", "value": "USERID,BULK_MAIL_TYPE" }, { "disabled": false, "description": { "content": "A comma-separated list of the fields that are in the provided data records. Make sure that this list contains ALL fields (including the key fields) in the correct order. If this parameter is not provided, the first row of the provided data records will be used to determine the fields.", "type": "text/plain" }, "key": "fields", "value": "field1,field2" }, { "disabled": false, "description": { "content": "The mode of data transfer.", "type": "text/plain" }, "key": "mode", "value": "Sync" }, { "disabled": false, "description": { "content": "The de-duplication option to use.", "type": "text/plain" }, "key": "deduplication", "value": "ImportLastMatch" }, { "disabled": false, "description": { "content": "Parameter indicates error handling options whether to stop on error or continue on error.", "type": "text/plain" }, "key": "errorHandling", "value": "ContinueOnError" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "API calls quota exceeded!", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5ff0d4ec-e441-496c-9f27-dc4e4f85911f", "name": "Clear Static segment data", "request": { "name": "Clear Static segment data", "description": { "content": "Use this endpoint to clear static segment data.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", ":segment_api_name", "data", "clear" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) API name of the segment.", "type": "text/plain" }, "type": "any", "value": "api_name_segment", "key": "segment_api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "a6ea54e1-438b-4c52-a0f3-49c6cd3c1d5a", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", ":segment_api_name", "data", "clear" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The data has been cleared successfully.\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "b73eea5f-8e69-472e-9334-83d8d9d170ea", "name": "Bad Request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", ":segment_api_name", "data", "clear" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_VALIDATION\",\n \"description\": \"Failed to clear static segment data.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ab3b07ea-d201-4022-b1d6-f51c0ce1272e", "name": "Create / Update data static segment", "request": { "name": "Create / Update data static segment", "description": { "content": "Use this endpoint to load data in bulk into a specific static segment. Records are upserted using the `keyFields` parameter to match existing rows.\n\n**Key-field index requirement:** The destination list table must have a **unique** index whose key columns cover all specified `keyFields`. When no compatible unique index exists:\n\n- Requests against tables with **≥ 5,000,000 rows** are rejected immediately (`400 ValidationFailed`, code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`).\n- Requests against smaller tables are allowed but aborted once **100,000 records** have been streamed.\n\nUse `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API, or create a DBA-managed unique index directly on the underlying table.\n\n**Per-list concurrency limit:** Only one bulk operation per list is permitted at a time. A second concurrent request against the same list is rejected immediately with `429 Too Many Requests`. Retry once the in-flight operation has completed.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", ":segment_api_name", "data", "load" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma-separated list of fields used to identify records for upsert or delete matching.\n\n**Index requirement (bulk endpoints):** The destination list table must have a **unique** index whose key columns cover all specified fields. A non-unique index does not satisfy this requirement. When no compatible unique index exists, bulk operations return `400 ValidationFailed` with code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`. Use `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API.", "type": "text/plain" }, "key": "keyFields", "value": "USERID,BULK_MAIL_TYPE" }, { "disabled": false, "description": { "content": "A comma-separated list of the fields that are in the provided data records. Make sure that this list contains ALL fields (including the key fields) in the correct order. If this parameter is not provided, the first row of the provided data records will be used to determine the fields.", "type": "text/plain" }, "key": "fields", "value": "field1,field2" }, { "disabled": false, "description": { "content": "The mode of data transfer.", "type": "text/plain" }, "key": "mode", "value": "Sync" }, { "disabled": false, "description": { "content": "The de-duplication option to use.", "type": "text/plain" }, "key": "deduplication", "value": "ImportLastMatch" }, { "disabled": false, "description": { "content": "Parameter indicates error handling options whether to stop on error or continue on error.", "type": "text/plain" }, "key": "errorHandling", "value": "ContinueOnError" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) API name of the segment.", "type": "text/plain" }, "type": "any", "value": "api_name_segment", "key": "segment_api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "127ed2f4-9dd9-40db-9a39-569d696a5066", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", ":segment_api_name", "data", "load" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma-separated list of fields used to identify records for upsert or delete matching.\n\n**Index requirement (bulk endpoints):** The destination list table must have a **unique** index whose key columns cover all specified fields. A non-unique index does not satisfy this requirement. When no compatible unique index exists, bulk operations return `400 ValidationFailed` with code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`. Use `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API.", "type": "text/plain" }, "key": "keyFields", "value": "USERID,BULK_MAIL_TYPE" }, { "disabled": false, "description": { "content": "A comma-separated list of the fields that are in the provided data records. Make sure that this list contains ALL fields (including the key fields) in the correct order. If this parameter is not provided, the first row of the provided data records will be used to determine the fields.", "type": "text/plain" }, "key": "fields", "value": "field1,field2" }, { "disabled": false, "description": { "content": "The mode of data transfer.", "type": "text/plain" }, "key": "mode", "value": "Sync" }, { "disabled": false, "description": { "content": "The de-duplication option to use.", "type": "text/plain" }, "key": "deduplication", "value": "ImportLastMatch" }, { "disabled": false, "description": { "content": "Parameter indicates error handling options whether to stop on error or continue on error.", "type": "text/plain" }, "key": "errorHandling", "value": "ContinueOnError" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [],\n \"result_code\": \"PartiallySucceeded\",\n \"number_of_inserted_records\": 50,\n \"number_of_failed_records\": 2,\n \"number_of_updated_records\": 48,\n \"number_of_duplicate_records\": 0,\n \"number_of_records_not_found\": 0,\n \"invalid_records\": [\n {\n \"record_index\": 10,\n \"field_name\": \"SOMESTRING\",\n \"message\": \"Length of string (53) exceeds maximum field length (50)\",\n \"validation_code\": \"MaxStringLengthExceeded\"\n },\n {\n \"record_index\": 17,\n \"message\": \"Record contains incorrect number of fields\",\n \"validation_code\": \"InvalidFieldCount\"\n }\n ],\n \"number_of_deleted_records\": 0\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "f24e01ed-3204-45cf-89f7-c410e8808ecc", "name": "Invalid payload", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", ":segment_api_name", "data", "load" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma-separated list of fields used to identify records for upsert or delete matching.\n\n**Index requirement (bulk endpoints):** The destination list table must have a **unique** index whose key columns cover all specified fields. A non-unique index does not satisfy this requirement. When no compatible unique index exists, bulk operations return `400 ValidationFailed` with code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`. Use `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API.", "type": "text/plain" }, "key": "keyFields", "value": "USERID,BULK_MAIL_TYPE" }, { "disabled": false, "description": { "content": "A comma-separated list of the fields that are in the provided data records. Make sure that this list contains ALL fields (including the key fields) in the correct order. If this parameter is not provided, the first row of the provided data records will be used to determine the fields.", "type": "text/plain" }, "key": "fields", "value": "field1,field2" }, { "disabled": false, "description": { "content": "The mode of data transfer.", "type": "text/plain" }, "key": "mode", "value": "Sync" }, { "disabled": false, "description": { "content": "The de-duplication option to use.", "type": "text/plain" }, "key": "deduplication", "value": "ImportLastMatch" }, { "disabled": false, "description": { "content": "Parameter indicates error handling options whether to stop on error or continue on error.", "type": "text/plain" }, "key": "errorHandling", "value": "ContinueOnError" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"INVALIDPAYLOAD\",\n \"description\": \"Invalid payload detected when loading.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"number_of_inserted_records\": 0,\n \"number_of_failed_records\": 0,\n \"number_of_updated_records\": 0,\n \"number_of_duplicate_records\": 0,\n \"number_of_records_not_found\": 0,\n \"invalid_records\": null\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "725659cc-8b2d-4e41-bdb9-4ce42583e894", "name": "No unique index on key fields", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", ":segment_api_name", "data", "load" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma-separated list of fields used to identify records for upsert or delete matching.\n\n**Index requirement (bulk endpoints):** The destination list table must have a **unique** index whose key columns cover all specified fields. A non-unique index does not satisfy this requirement. When no compatible unique index exists, bulk operations return `400 ValidationFailed` with code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`. Use `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API.", "type": "text/plain" }, "key": "keyFields", "value": "USERID,BULK_MAIL_TYPE" }, { "disabled": false, "description": { "content": "A comma-separated list of the fields that are in the provided data records. Make sure that this list contains ALL fields (including the key fields) in the correct order. If this parameter is not provided, the first row of the provided data records will be used to determine the fields.", "type": "text/plain" }, "key": "fields", "value": "field1,field2" }, { "disabled": false, "description": { "content": "The mode of data transfer.", "type": "text/plain" }, "key": "mode", "value": "Sync" }, { "disabled": false, "description": { "content": "The de-duplication option to use.", "type": "text/plain" }, "key": "deduplication", "value": "ImportLastMatch" }, { "disabled": false, "description": { "content": "Parameter indicates error handling options whether to stop on error or continue on error.", "type": "text/plain" }, "key": "errorHandling", "value": "ContinueOnError" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"LOAD_RECORDS_FAILED_BY_MISSING_INDEX\",\n \"description\": \"Table 'DATA_SUBSCRIPTIONS' has ~8000000 rows and no index on key fields [USERID, BULK_MAIL_TYPE]. Threshold: 5000000.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"number_of_inserted_records\": 0,\n \"number_of_failed_records\": 0,\n \"number_of_updated_records\": 0,\n \"number_of_duplicate_records\": 0,\n \"number_of_records_not_found\": 0,\n \"invalid_records\": null\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "a2128e7e-f5b6-485f-a4a2-85799960ee9d", "name": "Conflict", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", ":segment_api_name", "data", "load" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma-separated list of fields used to identify records for upsert or delete matching.\n\n**Index requirement (bulk endpoints):** The destination list table must have a **unique** index whose key columns cover all specified fields. A non-unique index does not satisfy this requirement. When no compatible unique index exists, bulk operations return `400 ValidationFailed` with code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`. Use `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API.", "type": "text/plain" }, "key": "keyFields", "value": "USERID,BULK_MAIL_TYPE" }, { "disabled": false, "description": { "content": "A comma-separated list of the fields that are in the provided data records. Make sure that this list contains ALL fields (including the key fields) in the correct order. If this parameter is not provided, the first row of the provided data records will be used to determine the fields.", "type": "text/plain" }, "key": "fields", "value": "field1,field2" }, { "disabled": false, "description": { "content": "The mode of data transfer.", "type": "text/plain" }, "key": "mode", "value": "Sync" }, { "disabled": false, "description": { "content": "The de-duplication option to use.", "type": "text/plain" }, "key": "deduplication", "value": "ImportLastMatch" }, { "disabled": false, "description": { "content": "Parameter indicates error handling options whether to stop on error or continue on error.", "type": "text/plain" }, "key": "errorHandling", "value": "ContinueOnError" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "aute aliquip occaecat", "cookie": [] }, { "_": { "postman_previewlanguage": "text" }, "id": "f026e0ea-ef1e-42ed-b2dd-e5e8fec87a94", "name": "A bulk operation is already in progress on this list. Retry once the in-flight operation has completed.", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", ":segment_api_name", "data", "load" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) A comma-separated list of fields used to identify records for upsert or delete matching.\n\n**Index requirement (bulk endpoints):** The destination list table must have a **unique** index whose key columns cover all specified fields. A non-unique index does not satisfy this requirement. When no compatible unique index exists, bulk operations return `400 ValidationFailed` with code `LOAD_RECORDS_FAILED_BY_MISSING_INDEX`. Use `PUT /organizations/{organization}/lists/{api_name}/businesskey` to provision a unique index via the API.", "type": "text/plain" }, "key": "keyFields", "value": "USERID,BULK_MAIL_TYPE" }, { "disabled": false, "description": { "content": "A comma-separated list of the fields that are in the provided data records. Make sure that this list contains ALL fields (including the key fields) in the correct order. If this parameter is not provided, the first row of the provided data records will be used to determine the fields.", "type": "text/plain" }, "key": "fields", "value": "field1,field2" }, { "disabled": false, "description": { "content": "The mode of data transfer.", "type": "text/plain" }, "key": "mode", "value": "Sync" }, { "disabled": false, "description": { "content": "The de-duplication option to use.", "type": "text/plain" }, "key": "deduplication", "value": "ImportLastMatch" }, { "disabled": false, "description": { "content": "Parameter indicates error handling options whether to stop on error or continue on error.", "type": "text/plain" }, "key": "errorHandling", "value": "ContinueOnError" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "API calls quota exceeded!", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cdf91de1-69f0-4089-9195-6771ab6e9c74", "name": "Search List Segment records", "request": { "name": "Search List Segment records", "description": { "content": "Use this endpoint to search for data records within a segment of a specific table.\\r\\nSearching data can be done synchronous or streamed.\\r\\nThe data in the response will be in a Json format.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", ":segment_api_name", "data", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The mode of data transfer.", "type": "text/plain" }, "key": "mode", "value": "Sync" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" }, { "disabled": false, "description": { "content": "(Required) API name of the segment.", "type": "text/plain" }, "type": "any", "value": "api_name_segment", "key": "segment_api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"MASTER.FIELD1\",\n \"FIELD2\",\n \"SCOPE.FIELD_X\",\n \"SYSTEM.SELLIGENTID\"\n ],\n \"filters\": [\n {\n \"field_name\": \"MASTER.FIELD1\",\n \"operator\": \"EqualTo\",\n \"field_value\": \"VALUE\"\n }\n ],\n \"skip\": 20,\n \"take\": 20,\n \"order_by\": \"MASTER.FIELD2\",\n \"order_by_direction\": \"ASC\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "96e54ae8-32d1-4ed5-b88c-387e2c2ede9c", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "lists", ":api_name", "segments", ":segment_api_name", "data", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The mode of data transfer.", "type": "text/plain" }, "key": "mode", "value": "Sync" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"MASTER.FIELD1\",\n \"FIELD2\",\n \"SCOPE.FIELD_X\",\n \"SYSTEM.SELLIGENTID\"\n ],\n \"filters\": [\n {\n \"field_name\": \"MASTER.FIELD1\",\n \"operator\": \"EqualTo\",\n \"field_value\": \"VALUE\"\n }\n ],\n \"skip\": 20,\n \"take\": 20,\n \"order_by\": \"MASTER.FIELD2\",\n \"order_by_direction\": \"ASC\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"fields\": [\n \"MASTER.FIELD_1\",\n \"MASTER.EMAIL\",\n \"SCOPE_1.FIELD_1\",\n \"SYSTEM.SELLIGENTID\"\n ],\n \"errors\": [\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n },\n {\n \"error_code\": \"Failed\",\n \"description\": \"Message with api name 'message_1' doesn't exists\"\n }\n ],\n \"data\": [\n [\n \"eiusmod\",\n \"laboris adipisicing aliqua sed commodo\"\n ],\n [\n \"nostrud\",\n \"ad non in Duis\"\n ]\n ],\n \"result_code\": \"PartiallySucceeded\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "04c5cef0-c8fd-4d16-a3a4-42b0df191651", "name": "Tag list", "description": { "content": "All tag list endpoints", "type": "text/plain" }, "item": [ { "id": "9a8f4fc2-03c9-4151-9f7f-fb6b83ffc86d", "name": "List tag lists", "request": { "name": "List tag lists", "description": { "content": "Returns Tag lists filtered on the given criteria.", "type": "text/plain" }, "url": { "path": [ "taglists" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search with a specific name, api_name, description or tag(s).", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" }, { "disabled": false, "description": { "content": "The maximum amount of items to return.", "type": "text/plain" }, "key": "take", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "825ab832-2504-4a87-a975-10f999546fe5", "name": "OK", "originalRequest": { "url": { "path": [ "taglists" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search with a specific name, api_name, description or tag(s).", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" }, { "disabled": false, "description": { "content": "The maximum amount of items to return.", "type": "text/plain" }, "key": "take", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"taglists\": [\n {\n \"api_name\": \"tag_list_1\"\n },\n {\n \"api_name\": \"tag_list_1\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3ff4863c-df0e-4cad-a84e-b43821ce031a", "name": "Create tag list", "request": { "name": "Create tag list", "description": { "content": "Create a new tag list.", "type": "text/plain" }, "url": { "path": [ "taglists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Tag List 1\",\n \"api_name\": \"tag_list_1\",\n \"description\": \"My first tag list\",\n \"tags\": [\n {\n \"tag\": \"TAG1\",\n \"description\": \"a_great_first_tag\"\n },\n {\n \"tag\": \"TAG2\",\n \"description\": \"a_great_second_tag\"\n }\n ],\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "db4763b1-0319-4dc2-a528-8ea5d7098f75", "name": "Created", "originalRequest": { "url": { "path": [ "taglists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Tag List 1\",\n \"api_name\": \"tag_list_1\",\n \"description\": \"My first tag list\",\n \"tags\": [\n {\n \"tag\": \"TAG1\",\n \"description\": \"a_great_first_tag\"\n },\n {\n \"tag\": \"TAG2\",\n \"description\": \"a_great_second_tag\"\n }\n ],\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Tag list created successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "d1f6d35e-869e-46a6-a521-f45653f144ea", "name": "Bad request", "originalRequest": { "url": { "path": [ "taglists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Tag List 1\",\n \"api_name\": \"tag_list_1\",\n \"description\": \"My first tag list\",\n \"tags\": [\n {\n \"tag\": \"TAG1\",\n \"description\": \"a_great_first_tag\"\n },\n {\n \"tag\": \"TAG2\",\n \"description\": \"a_great_second_tag\"\n }\n ],\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_TAGLIST_VALIDATION\",\n \"description\": \"Failed to create Tag list.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ff8cc594-ee97-4ace-8398-cc0d768459b4", "name": "Get tag list", "request": { "name": "Get tag list", "description": { "content": "Use this endpoint to get details of Tag list with given API name.", "type": "text/plain" }, "url": { "path": [ "taglists", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API name of the Tag list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "0d9e4068-4dde-46ca-aedf-d763caaedd5f", "name": "OK", "originalRequest": { "url": { "path": [ "taglists", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"api_name\": \"tag_list_1\",\n \"name\": \"Tag List 1\",\n \"description\": \"My first tag list\",\n \"tags\": [\n {\n \"tag\": \"TAG1\",\n \"description\": \"a_great_first_tag\"\n },\n {\n \"tag\": \"TAG2\",\n \"description\": \"a_great_second_tag\"\n }\n ],\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ],\n \"not_accessible_organizations_count\": 1,\n \"lists\": [\n \"list_1\",\n \"list_2\"\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "text" }, "id": "f6b3e9e2-c83b-420b-9e81-291f5a57f557", "name": "Not found", "originalRequest": { "url": { "path": [ "taglists", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "335d6df6-88a1-4726-a9ad-d43c558d75de", "name": "Update tag list", "request": { "name": "Update tag list", "description": { "content": "Update an existing Tag list.", "type": "text/plain" }, "url": { "path": [ "taglists", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API name of the Tag list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"tag_list_1\",\n \"name\": \"Tag List 1\",\n \"description\": \"My first tag list\",\n \"tags\": [\n {\n \"tag\": \"TAG1\",\n \"description\": \"a_great_first_tag\"\n },\n {\n \"tag\": \"TAG2\",\n \"description\": \"a_great_second_tag\"\n }\n ],\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "3eed6207-5431-45de-af8e-99e73249bed1", "name": "Updated", "originalRequest": { "url": { "path": [ "taglists", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"tag_list_1\",\n \"name\": \"Tag List 1\",\n \"description\": \"My first tag list\",\n \"tags\": [\n {\n \"tag\": \"TAG1\",\n \"description\": \"a_great_first_tag\"\n },\n {\n \"tag\": \"TAG2\",\n \"description\": \"a_great_second_tag\"\n }\n ],\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Tag list updated successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "776fec68-5f35-4017-b00a-ba1d4ebfcb51", "name": "Bad request", "originalRequest": { "url": { "path": [ "taglists", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"tag_list_1\",\n \"name\": \"Tag List 1\",\n \"description\": \"My first tag list\",\n \"tags\": [\n {\n \"tag\": \"TAG1\",\n \"description\": \"a_great_first_tag\"\n },\n {\n \"tag\": \"TAG2\",\n \"description\": \"a_great_second_tag\"\n }\n ],\n \"organizations\": [\n \"Organization_1\",\n \"Organization_2\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_TAGLIST_VALIDATION\",\n \"description\": \"Failed to update Tag list.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8e4784bd-b627-43e6-94a8-a8a4f80e71d3", "name": "Delete tag list", "request": { "name": "Delete tag list", "description": { "content": "Delete an existing Tag list.", "type": "text/plain" }, "url": { "path": [ "taglists", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) API name of the Tag list.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "35106024-5059-485b-bb67-45d5296ffadc", "name": "Deleted", "originalRequest": { "url": { "path": [ "taglists", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The Tag list has been deleted successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "7a68d684-3d32-4259-bdcb-f8efb3776846", "name": "Bad request", "originalRequest": { "url": { "path": [ "taglists", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_TAGLIST_VALIDATION\",\n \"description\": \"Failed to delete Tag list.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ad4794b5-6847-4146-b56e-18faa72a9105", "name": "List Organization tag lists", "request": { "name": "List Organization tag lists", "description": { "content": "List Tag lists associated to an organization.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "taglists" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search with a specific name, api_name, description or tag(s).", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" }, { "disabled": false, "description": { "content": "The maximum amount of items to return.", "type": "text/plain" }, "key": "take", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "350f30ca-cf8d-4cbf-85d8-3c4817a85fd7", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "taglists" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search with a specific name, api_name, description or tag(s).", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" }, { "disabled": false, "description": { "content": "The maximum amount of items to return.", "type": "text/plain" }, "key": "take", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"taglists\": [\n {\n \"api_name\": \"tag_list_1\"\n },\n {\n \"api_name\": \"tag_list_1\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "text" }, "id": "c76ba05e-8f63-443e-8d4d-6a6631322df0", "name": "Not found", "originalRequest": { "url": { "path": [ "organizations", ":organization", "taglists" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search with a specific name, api_name, description or tag(s).", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" }, { "disabled": false, "description": { "content": "The maximum amount of items to return.", "type": "text/plain" }, "key": "take", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ac85320a-27df-473a-9f15-5e782cdd4bd5", "name": "Task", "description": { "content": "All task endpoints", "type": "text/plain" }, "item": [ { "id": "7c8b7c01-be09-411f-b180-240b1814742f", "name": "List tasks", "request": { "name": "List tasks", "description": { "content": "Get list of tasks based on the provided criteria, in the provided organization.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by task type. Leave empty to return all available task types.", "type": "text/plain" }, "key": "filter", "value": "Import,Export" }, { "disabled": false, "description": { "content": "Search with a specific name or description. Leave empty to return everything.", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" }, { "disabled": false, "description": { "content": "The maximum amount of items to return. Use a negative value to retrieve all available items. Used only if `skip` is non-negative.", "type": "text/plain" }, "key": "take", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "6fcb349e-55dc-41b1-9e51-9d7a4765d063", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by task type. Leave empty to return all available task types.", "type": "text/plain" }, "key": "filter", "value": "Import,Export" }, { "disabled": false, "description": { "content": "Search with a specific name or description. Leave empty to return everything.", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" }, { "disabled": false, "description": { "content": "The maximum amount of items to return. Use a negative value to retrieve all available items. Used only if `skip` is non-negative.", "type": "text/plain" }, "key": "take", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tasks\": [\n {\n \"type\": \"Batch\",\n \"api_name\": \"task_1\"\n },\n {\n \"type\": \"Batch\",\n \"api_name\": \"task_1\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8a15b7fa-3aa5-40af-b411-946e7b8521a2", "name": "Get task", "request": { "name": "Get task", "description": { "content": "Get details of an existing task.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "tasks", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the task.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "54653e25-ae03-45db-aee8-da9ebb0eca87", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "tasks", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"Batch\",\n \"api_name\": \"task_1\",\n \"name\": \"Task 1\",\n \"description\": \"A very nice task.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"execution_status\": \"Running\",\n \"last_execution\": \"2023-12-14T11:11:18.3086+01:00\",\n \"next_execution\": \"2023-12-16T11:11:18.3086+01:00\",\n \"schedule\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f6ec752b-7257-4072-a52a-65b14c88158b", "name": "Delete task", "request": { "name": "Delete task", "description": { "content": "Delete task with the given api name, if it exists in the given organization.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "tasks", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the task.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "0ab97b05-98d9-439e-ad60-7256a708f626", "name": "Deleted", "originalRequest": { "url": { "path": [ "organizations", ":organization", "tasks", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The task has been deleted successfully\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "137a1032-0724-427d-b3d4-937436a352a3", "name": "Bad request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "tasks", ":api_name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_VALIDATION\",\n \"description\": \"Failed to delete task.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9b7496e4-e4a0-4364-939e-c58acdebbdfa", "name": "List task actions", "request": { "name": "List task actions", "description": { "content": "Get actions of an existing task.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "tasks", ":api_name", "actions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the task.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "d7db94f0-c03b-4e47-88b1-02487fa4e45a", "name": "OK", "originalRequest": { "url": { "path": [ "organizations", ":organization", "tasks", ":api_name", "actions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"taskaction\": [\n \"Run\",\n \"Enable\"\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "214cfdf5-ac58-4b76-ae1b-be6ca6f98979", "name": "Disable task", "request": { "name": "Disable task", "description": { "content": "Disable an existing Task.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "tasks", ":api_name", "actions", "disable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the task.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "b5fa8e32-a6c5-4568-b5e9-886f96ffaea7", "name": "Disabled", "originalRequest": { "url": { "path": [ "organizations", ":organization", "tasks", ":api_name", "actions", "disable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Task disabled successfully\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "4f4205f1-a59c-4b2d-a8b5-388176503218", "name": "Not found", "originalRequest": { "url": { "path": [ "organizations", ":organization", "tasks", ":api_name", "actions", "disable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Failed\",\n \"message\": null,\n \"errors\": [\n {\n \"error_code\": \"ERR_TASKVALIDATION_TASKNOTFOUND\",\n \"description\": \"Task not found\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6086f194-b4ed-4544-b285-6dd101436569", "name": "Enable task", "request": { "name": "Enable task", "description": { "content": "Enable an existing Task.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "tasks", ":api_name", "actions", "enable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the task.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "ef936944-9e51-4416-955b-e8f6ab9ee86f", "name": "Enabled", "originalRequest": { "url": { "path": [ "organizations", ":organization", "tasks", ":api_name", "actions", "enable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Task enabled successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "8e395908-d1b5-4bea-8a06-cbbdb94c9605", "name": "Not found", "originalRequest": { "url": { "path": [ "organizations", ":organization", "tasks", ":api_name", "actions", "enable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Failed\",\n \"message\": null,\n \"errors\": [\n {\n \"error_code\": \"ERR_TASKVALIDATION_TASKNOTFOUND\",\n \"description\": \"Task not found\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "09b3382b-5376-48eb-a6e5-f164fd595b07", "name": "Run task", "request": { "name": "Run task", "description": { "content": "Run an existing Task", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "tasks", ":api_name", "actions", "run" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" }, { "disabled": false, "description": { "content": "(Required) API name of the task.", "type": "text/plain" }, "type": "string", "value": "{{apiName}}", "key": "api_name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "62a07ae0-03ab-4e48-a65f-bd7fc7c112ef", "name": "Running Task", "originalRequest": { "url": { "path": [ "organizations", ":organization", "tasks", ":api_name", "actions", "run" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Task has run successfully\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "d2f0274c-968c-4472-a55c-6ca7e328a18e", "name": "Failed to run the task.", "originalRequest": { "url": { "path": [ "organizations", ":organization", "tasks", ":api_name", "actions", "run" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_TASKVALIDATION_RUNTASKFAILED\",\n \"description\": \"Failed to run the task\"\n }\n ],\n \"result_code\": \"Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "673eaa3f-19c6-4f84-8203-a4fab9cc7861", "name": "Create batch task", "request": { "name": "Create batch task", "description": { "content": "Create a new task of type batch.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "tasks", "batch" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Define if the task should be enabled after its creation.", "type": "text/plain" }, "key": "enable_after_creation", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"task_1\",\n \"name\": \"Task 1\",\n \"notifications\": [\n {\n \"type\": \"Complete\",\n \"groups\": [\n \"group_1\",\n \"group_2\"\n ],\n \"emails\": [\n \"john.doe@zetaglobal.com\",\n \"john.deer@zetaglobal.com\"\n ],\n \"include_process_details\": false\n },\n {\n \"type\": \"Complete\",\n \"groups\": [\n \"group_1\",\n \"group_2\"\n ],\n \"emails\": [\n \"john.doe@zetaglobal.com\",\n \"john.deer@zetaglobal.com\"\n ],\n \"include_process_details\": false\n }\n ],\n \"tasks\": [\n {\n \"api_name\": \"task_1\",\n \"id\": 1,\n \"on_fail\": 3,\n \"on_success\": 2,\n \"type\": \"Export\"\n },\n {\n \"api_name\": \"task_1\",\n \"id\": 1,\n \"on_fail\": 3,\n \"on_success\": 2,\n \"type\": \"Export\"\n }\n ],\n \"description\": \"A very nice task.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"scheduler\": 0,\n \"schedule\": null,\n \"folder\": \"106\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "1129f869-ec80-47f0-88e1-26ff3f7f7e8f", "name": "Created", "originalRequest": { "url": { "path": [ "organizations", ":organization", "tasks", "batch" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Define if the task should be enabled after its creation.", "type": "text/plain" }, "key": "enable_after_creation", "value": "true" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"task_1\",\n \"name\": \"Task 1\",\n \"notifications\": [\n {\n \"type\": \"Complete\",\n \"groups\": [\n \"group_1\",\n \"group_2\"\n ],\n \"emails\": [\n \"john.doe@zetaglobal.com\",\n \"john.deer@zetaglobal.com\"\n ],\n \"include_process_details\": false\n },\n {\n \"type\": \"Complete\",\n \"groups\": [\n \"group_1\",\n \"group_2\"\n ],\n \"emails\": [\n \"john.doe@zetaglobal.com\",\n \"john.deer@zetaglobal.com\"\n ],\n \"include_process_details\": false\n }\n ],\n \"tasks\": [\n {\n \"api_name\": \"task_1\",\n \"id\": 1,\n \"on_fail\": 3,\n \"on_success\": 2,\n \"type\": \"Export\"\n },\n {\n \"api_name\": \"task_1\",\n \"id\": 1,\n \"on_fail\": 3,\n \"on_success\": 2,\n \"type\": \"Export\"\n }\n ],\n \"description\": \"A very nice task.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"scheduler\": 0,\n \"schedule\": null,\n \"folder\": \"106\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Task task_name created successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "6530c251-f7f4-455c-a8b9-065d2b01f0ca", "name": "Bad request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "tasks", "batch" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Define if the task should be enabled after its creation.", "type": "text/plain" }, "key": "enable_after_creation", "value": "true" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"task_1\",\n \"name\": \"Task 1\",\n \"notifications\": [\n {\n \"type\": \"Complete\",\n \"groups\": [\n \"group_1\",\n \"group_2\"\n ],\n \"emails\": [\n \"john.doe@zetaglobal.com\",\n \"john.deer@zetaglobal.com\"\n ],\n \"include_process_details\": false\n },\n {\n \"type\": \"Complete\",\n \"groups\": [\n \"group_1\",\n \"group_2\"\n ],\n \"emails\": [\n \"john.doe@zetaglobal.com\",\n \"john.deer@zetaglobal.com\"\n ],\n \"include_process_details\": false\n }\n ],\n \"tasks\": [\n {\n \"api_name\": \"task_1\",\n \"id\": 1,\n \"on_fail\": 3,\n \"on_success\": 2,\n \"type\": \"Export\"\n },\n {\n \"api_name\": \"task_1\",\n \"id\": 1,\n \"on_fail\": 3,\n \"on_success\": 2,\n \"type\": \"Export\"\n }\n ],\n \"description\": \"A very nice task.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"scheduler\": 0,\n \"schedule\": null,\n \"folder\": \"106\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "37b83ce7-069b-4617-aa5d-46c7beb3d5c2", "name": "Create export task", "request": { "name": "Create export task", "description": { "content": "Create a new task of type export.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "tasks", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Define if the task should be enabled after its creation.", "type": "text/plain" }, "key": "enable_after_creation", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"task_1\",\n \"destination\": \"medium_1\",\n \"name\": \"Task 1\",\n \"notifications\": [\n {\n \"type\": \"Complete\",\n \"groups\": [\n \"group_1\",\n \"group_2\"\n ],\n \"emails\": [\n \"john.doe@zetaglobal.com\",\n \"john.deer@zetaglobal.com\"\n ],\n \"include_process_details\": false\n },\n {\n \"type\": \"Complete\",\n \"groups\": [\n \"group_1\",\n \"group_2\"\n ],\n \"emails\": [\n \"john.doe@zetaglobal.com\",\n \"john.deer@zetaglobal.com\"\n ],\n \"include_process_details\": false\n }\n ],\n \"output\": {\n \"file_name\": \"file_1\",\n \"file_options\": {\n \"encoding\": \"X_MAC_CE\",\n \"delimiter\": \";\",\n \"use_text_quotes\": true,\n \"first_line_has_column_names\": true,\n \"max_file_size\": 100,\n \"line_break\": \"Windows\",\n \"skip_bom\": false\n }\n },\n \"description\": \"A very nice task.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"scheduler\": 0,\n \"schedule\": null,\n \"folder\": \"106\",\n \"data_source\": {\n \"sp_name\": \"ST_1.\",\n \"include_selligent_id_column\": true,\n \"selligent_id_column\": \"column_1\",\n \"fail_constraint\": {\n \"operator\": \"EqualTo\",\n \"value\": 5\n },\n \"parameter_values\": [\n {\n \"name\": \"PARAM1\",\n \"value\": \"VAL1\"\n },\n {\n \"name\": \"PARAM1\",\n \"value\": \"VAL1\"\n }\n ]\n },\n \"options\": {\n \"include_sequence_number\": true,\n \"sequence_number\": 5,\n \"overwrite_existing_file\": false,\n \"no_data_handling\": \"Skip\"\n },\n \"trigger_file\": null,\n \"zip_and_encrypt\": {\n \"mode\": \"Zip\",\n \"zip_archive\": {\n \"generate_file_name\": false,\n \"file_name\": \"file.zip\"\n },\n \"pgp_encryption\": {\n \"recipient\": \"sec@zetaglobal.com\"\n }\n },\n \"subfolder\": \"exports\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "db317c15-35e3-440b-ae40-dc31ec76956d", "name": "Created", "originalRequest": { "url": { "path": [ "organizations", ":organization", "tasks", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Define if the task should be enabled after its creation.", "type": "text/plain" }, "key": "enable_after_creation", "value": "true" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"task_1\",\n \"destination\": \"medium_1\",\n \"name\": \"Task 1\",\n \"notifications\": [\n {\n \"type\": \"Complete\",\n \"groups\": [\n \"group_1\",\n \"group_2\"\n ],\n \"emails\": [\n \"john.doe@zetaglobal.com\",\n \"john.deer@zetaglobal.com\"\n ],\n \"include_process_details\": false\n },\n {\n \"type\": \"Complete\",\n \"groups\": [\n \"group_1\",\n \"group_2\"\n ],\n \"emails\": [\n \"john.doe@zetaglobal.com\",\n \"john.deer@zetaglobal.com\"\n ],\n \"include_process_details\": false\n }\n ],\n \"output\": {\n \"file_name\": \"file_1\",\n \"file_options\": {\n \"encoding\": \"X_MAC_CE\",\n \"delimiter\": \";\",\n \"use_text_quotes\": true,\n \"first_line_has_column_names\": true,\n \"max_file_size\": 100,\n \"line_break\": \"Windows\",\n \"skip_bom\": false\n }\n },\n \"description\": \"A very nice task.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"scheduler\": 0,\n \"schedule\": null,\n \"folder\": \"106\",\n \"data_source\": {\n \"sp_name\": \"ST_1.\",\n \"include_selligent_id_column\": true,\n \"selligent_id_column\": \"column_1\",\n \"fail_constraint\": {\n \"operator\": \"EqualTo\",\n \"value\": 5\n },\n \"parameter_values\": [\n {\n \"name\": \"PARAM1\",\n \"value\": \"VAL1\"\n },\n {\n \"name\": \"PARAM1\",\n \"value\": \"VAL1\"\n }\n ]\n },\n \"options\": {\n \"include_sequence_number\": true,\n \"sequence_number\": 5,\n \"overwrite_existing_file\": false,\n \"no_data_handling\": \"Skip\"\n },\n \"trigger_file\": null,\n \"zip_and_encrypt\": {\n \"mode\": \"Zip\",\n \"zip_archive\": {\n \"generate_file_name\": false,\n \"file_name\": \"file.zip\"\n },\n \"pgp_encryption\": {\n \"recipient\": \"sec@zetaglobal.com\"\n }\n },\n \"subfolder\": \"exports\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Task task_name created successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "8594873c-3596-4a4c-b095-5def96dce9d3", "name": "Bad request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "tasks", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Define if the task should be enabled after its creation.", "type": "text/plain" }, "key": "enable_after_creation", "value": "true" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"task_1\",\n \"destination\": \"medium_1\",\n \"name\": \"Task 1\",\n \"notifications\": [\n {\n \"type\": \"Complete\",\n \"groups\": [\n \"group_1\",\n \"group_2\"\n ],\n \"emails\": [\n \"john.doe@zetaglobal.com\",\n \"john.deer@zetaglobal.com\"\n ],\n \"include_process_details\": false\n },\n {\n \"type\": \"Complete\",\n \"groups\": [\n \"group_1\",\n \"group_2\"\n ],\n \"emails\": [\n \"john.doe@zetaglobal.com\",\n \"john.deer@zetaglobal.com\"\n ],\n \"include_process_details\": false\n }\n ],\n \"output\": {\n \"file_name\": \"file_1\",\n \"file_options\": {\n \"encoding\": \"X_MAC_CE\",\n \"delimiter\": \";\",\n \"use_text_quotes\": true,\n \"first_line_has_column_names\": true,\n \"max_file_size\": 100,\n \"line_break\": \"Windows\",\n \"skip_bom\": false\n }\n },\n \"description\": \"A very nice task.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"scheduler\": 0,\n \"schedule\": null,\n \"folder\": \"106\",\n \"data_source\": {\n \"sp_name\": \"ST_1.\",\n \"include_selligent_id_column\": true,\n \"selligent_id_column\": \"column_1\",\n \"fail_constraint\": {\n \"operator\": \"EqualTo\",\n \"value\": 5\n },\n \"parameter_values\": [\n {\n \"name\": \"PARAM1\",\n \"value\": \"VAL1\"\n },\n {\n \"name\": \"PARAM1\",\n \"value\": \"VAL1\"\n }\n ]\n },\n \"options\": {\n \"include_sequence_number\": true,\n \"sequence_number\": 5,\n \"overwrite_existing_file\": false,\n \"no_data_handling\": \"Skip\"\n },\n \"trigger_file\": null,\n \"zip_and_encrypt\": {\n \"mode\": \"Zip\",\n \"zip_archive\": {\n \"generate_file_name\": false,\n \"file_name\": \"file.zip\"\n },\n \"pgp_encryption\": {\n \"recipient\": \"sec@zetaglobal.com\"\n }\n },\n \"subfolder\": \"exports\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5bdb594f-7e3a-41d8-b9f9-23021c26f18b", "name": "Create import task", "request": { "name": "Create import task", "description": { "content": "Create a new task of type import.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "tasks", "import" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Define if the task should be enabled after its creation.", "type": "text/plain" }, "key": "enable_after_creation", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"task_1\",\n \"destination\": {\n \"table_name\": \"DATA_IMPORT\",\n \"include_user_identified_column\": false\n },\n \"name\": \"Task 1\",\n \"notifications\": [\n {\n \"type\": \"Complete\",\n \"groups\": [\n \"group_1\",\n \"group_2\"\n ],\n \"emails\": [\n \"john.doe@zetaglobal.com\",\n \"john.deer@zetaglobal.com\"\n ],\n \"include_process_details\": false\n },\n {\n \"type\": \"Complete\",\n \"groups\": [\n \"group_1\",\n \"group_2\"\n ],\n \"emails\": [\n \"john.doe@zetaglobal.com\",\n \"john.deer@zetaglobal.com\"\n ],\n \"include_process_details\": false\n }\n ],\n \"source\": \"medium_1\",\n \"file_type\": \"Excel\",\n \"column_mapping\": [\n {\n \"name\": \"column_1\",\n \"type\": \"Text\"\n },\n {\n \"name\": \"column_1\",\n \"type\": \"Text\"\n }\n ],\n \"description\": \"A very nice task.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"scheduler\": 0,\n \"schedule\": null,\n \"folder\": \"106\",\n \"trigger_journey_after_execution\": \"journey_1\",\n \"trigger_custom_event_after_execution\": {\n \"custom_event\": \"custom_event_1\",\n \"list\": \"list_1\"\n },\n \"processing_folders\": {\n \"completed\": \"Completion Folder\",\n \"failed\": \"Failed Folder\",\n \"processing\": \"Processing Folder\"\n },\n \"data_processing\": {\n \"sp_name\": \"ST_1.\",\n \"fail_constraint\": {\n \"operator\": \"EqualTo\",\n \"value\": 5\n },\n \"parameter_values\": [\n {\n \"name\": \"PARAM1\",\n \"value\": \"VAL1\"\n },\n {\n \"name\": \"PARAM1\",\n \"value\": \"VAL1\"\n }\n ]\n },\n \"reject_management\": {\n \"destination\": \"medium_1\",\n \"subfolder\": \"SUBFOLDER_1\",\n \"file_options\": {\n \"encoding\": \"X_MAC_CE\",\n \"delimiter\": \";\",\n \"use_text_quotes\": true,\n \"first_line_has_column_names\": true,\n \"max_file_size\": 100,\n \"line_break\": \"Windows\",\n \"check_md5\": false,\n \"max_column_count\": 10\n },\n \"create_when_no_records_rejected\": false\n },\n \"options\": {\n \"file_filter\": \"*.dat\",\n \"trigger_file\": \"trg\",\n \"allow_multiple_imports\": false,\n \"fail_if_no_file\": false,\n \"fail_if_empty_file\": false,\n \"delete_after_processing\": false,\n \"process_files_one_by_one\": false,\n \"invalid_data_handling\": \"Stop\"\n },\n \"unzip_and_decrypt\": {\n \"mode\": \"Unzip\",\n \"unzip_filter\": \"*.dat\",\n \"pgp_decryption\": {\n \"recipient\": \"sec@zetaglobal.com\",\n \"passphrase\": \"encryptionpassword\"\n }\n },\n \"subfolder\": \"exports\",\n \"file_options\": {\n \"encoding\": \"X_MAC_CE\",\n \"delimiter\": \";\",\n \"use_text_quotes\": true,\n \"first_line_has_column_names\": true,\n \"max_file_size\": 100,\n \"line_break\": \"Windows\",\n \"check_md5\": false,\n \"max_column_count\": 10\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "73b7dd7b-9c52-485d-b86d-b5445389c544", "name": "Created", "originalRequest": { "url": { "path": [ "organizations", ":organization", "tasks", "import" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Define if the task should be enabled after its creation.", "type": "text/plain" }, "key": "enable_after_creation", "value": "true" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"task_1\",\n \"destination\": {\n \"table_name\": \"DATA_IMPORT\",\n \"include_user_identified_column\": false\n },\n \"name\": \"Task 1\",\n \"notifications\": [\n {\n \"type\": \"Complete\",\n \"groups\": [\n \"group_1\",\n \"group_2\"\n ],\n \"emails\": [\n \"john.doe@zetaglobal.com\",\n \"john.deer@zetaglobal.com\"\n ],\n \"include_process_details\": false\n },\n {\n \"type\": \"Complete\",\n \"groups\": [\n \"group_1\",\n \"group_2\"\n ],\n \"emails\": [\n \"john.doe@zetaglobal.com\",\n \"john.deer@zetaglobal.com\"\n ],\n \"include_process_details\": false\n }\n ],\n \"source\": \"medium_1\",\n \"file_type\": \"Excel\",\n \"column_mapping\": [\n {\n \"name\": \"column_1\",\n \"type\": \"Text\"\n },\n {\n \"name\": \"column_1\",\n \"type\": \"Text\"\n }\n ],\n \"description\": \"A very nice task.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"scheduler\": 0,\n \"schedule\": null,\n \"folder\": \"106\",\n \"trigger_journey_after_execution\": \"journey_1\",\n \"trigger_custom_event_after_execution\": {\n \"custom_event\": \"custom_event_1\",\n \"list\": \"list_1\"\n },\n \"processing_folders\": {\n \"completed\": \"Completion Folder\",\n \"failed\": \"Failed Folder\",\n \"processing\": \"Processing Folder\"\n },\n \"data_processing\": {\n \"sp_name\": \"ST_1.\",\n \"fail_constraint\": {\n \"operator\": \"EqualTo\",\n \"value\": 5\n },\n \"parameter_values\": [\n {\n \"name\": \"PARAM1\",\n \"value\": \"VAL1\"\n },\n {\n \"name\": \"PARAM1\",\n \"value\": \"VAL1\"\n }\n ]\n },\n \"reject_management\": {\n \"destination\": \"medium_1\",\n \"subfolder\": \"SUBFOLDER_1\",\n \"file_options\": {\n \"encoding\": \"X_MAC_CE\",\n \"delimiter\": \";\",\n \"use_text_quotes\": true,\n \"first_line_has_column_names\": true,\n \"max_file_size\": 100,\n \"line_break\": \"Windows\",\n \"check_md5\": false,\n \"max_column_count\": 10\n },\n \"create_when_no_records_rejected\": false\n },\n \"options\": {\n \"file_filter\": \"*.dat\",\n \"trigger_file\": \"trg\",\n \"allow_multiple_imports\": false,\n \"fail_if_no_file\": false,\n \"fail_if_empty_file\": false,\n \"delete_after_processing\": false,\n \"process_files_one_by_one\": false,\n \"invalid_data_handling\": \"Stop\"\n },\n \"unzip_and_decrypt\": {\n \"mode\": \"Unzip\",\n \"unzip_filter\": \"*.dat\",\n \"pgp_decryption\": {\n \"recipient\": \"sec@zetaglobal.com\",\n \"passphrase\": \"encryptionpassword\"\n }\n },\n \"subfolder\": \"exports\",\n \"file_options\": {\n \"encoding\": \"X_MAC_CE\",\n \"delimiter\": \";\",\n \"use_text_quotes\": true,\n \"first_line_has_column_names\": true,\n \"max_file_size\": 100,\n \"line_break\": \"Windows\",\n \"check_md5\": false,\n \"max_column_count\": 10\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Task task_name created successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "23458547-5668-4dc9-8cdf-d4b40b4daffa", "name": "Bad request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "tasks", "import" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Define if the task should be enabled after its creation.", "type": "text/plain" }, "key": "enable_after_creation", "value": "true" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_name\": \"task_1\",\n \"destination\": {\n \"table_name\": \"DATA_IMPORT\",\n \"include_user_identified_column\": false\n },\n \"name\": \"Task 1\",\n \"notifications\": [\n {\n \"type\": \"Complete\",\n \"groups\": [\n \"group_1\",\n \"group_2\"\n ],\n \"emails\": [\n \"john.doe@zetaglobal.com\",\n \"john.deer@zetaglobal.com\"\n ],\n \"include_process_details\": false\n },\n {\n \"type\": \"Complete\",\n \"groups\": [\n \"group_1\",\n \"group_2\"\n ],\n \"emails\": [\n \"john.doe@zetaglobal.com\",\n \"john.deer@zetaglobal.com\"\n ],\n \"include_process_details\": false\n }\n ],\n \"source\": \"medium_1\",\n \"file_type\": \"Excel\",\n \"column_mapping\": [\n {\n \"name\": \"column_1\",\n \"type\": \"Text\"\n },\n {\n \"name\": \"column_1\",\n \"type\": \"Text\"\n }\n ],\n \"description\": \"A very nice task.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"scheduler\": 0,\n \"schedule\": null,\n \"folder\": \"106\",\n \"trigger_journey_after_execution\": \"journey_1\",\n \"trigger_custom_event_after_execution\": {\n \"custom_event\": \"custom_event_1\",\n \"list\": \"list_1\"\n },\n \"processing_folders\": {\n \"completed\": \"Completion Folder\",\n \"failed\": \"Failed Folder\",\n \"processing\": \"Processing Folder\"\n },\n \"data_processing\": {\n \"sp_name\": \"ST_1.\",\n \"fail_constraint\": {\n \"operator\": \"EqualTo\",\n \"value\": 5\n },\n \"parameter_values\": [\n {\n \"name\": \"PARAM1\",\n \"value\": \"VAL1\"\n },\n {\n \"name\": \"PARAM1\",\n \"value\": \"VAL1\"\n }\n ]\n },\n \"reject_management\": {\n \"destination\": \"medium_1\",\n \"subfolder\": \"SUBFOLDER_1\",\n \"file_options\": {\n \"encoding\": \"X_MAC_CE\",\n \"delimiter\": \";\",\n \"use_text_quotes\": true,\n \"first_line_has_column_names\": true,\n \"max_file_size\": 100,\n \"line_break\": \"Windows\",\n \"check_md5\": false,\n \"max_column_count\": 10\n },\n \"create_when_no_records_rejected\": false\n },\n \"options\": {\n \"file_filter\": \"*.dat\",\n \"trigger_file\": \"trg\",\n \"allow_multiple_imports\": false,\n \"fail_if_no_file\": false,\n \"fail_if_empty_file\": false,\n \"delete_after_processing\": false,\n \"process_files_one_by_one\": false,\n \"invalid_data_handling\": \"Stop\"\n },\n \"unzip_and_decrypt\": {\n \"mode\": \"Unzip\",\n \"unzip_filter\": \"*.dat\",\n \"pgp_decryption\": {\n \"recipient\": \"sec@zetaglobal.com\",\n \"passphrase\": \"encryptionpassword\"\n }\n },\n \"subfolder\": \"exports\",\n \"file_options\": {\n \"encoding\": \"X_MAC_CE\",\n \"delimiter\": \";\",\n \"use_text_quotes\": true,\n \"first_line_has_column_names\": true,\n \"max_file_size\": 100,\n \"line_break\": \"Windows\",\n \"check_md5\": false,\n \"max_column_count\": 10\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8354117e-b543-4f52-a266-7e027fb153d7", "name": "Create SQL task", "request": { "name": "Create SQL task", "description": { "content": "Create a new task of type SQL.", "type": "text/plain" }, "url": { "path": [ "organizations", ":organization", "tasks", "sql" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Define if the task should be enabled after its creation.", "type": "text/plain" }, "key": "enable_after_creation", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the organization to work in.", "type": "text/plain" }, "type": "string", "value": "{{organization}}", "key": "organization" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"procedures\": [\n {\n \"id\": 1,\n \"sp_name\": \"ST_1.\",\n \"on_success\": 2,\n \"on_fail\": -1,\n \"fail_constraint\": {\n \"operator\": \"EqualTo\",\n \"value\": 5\n },\n \"parameter_values\": [\n {\n \"name\": \"PARAM1\",\n \"value\": \"VAL1\"\n },\n {\n \"name\": \"PARAM1\",\n \"value\": \"VAL1\"\n }\n ]\n },\n {\n \"id\": 1,\n \"sp_name\": \"ST_1.\",\n \"on_success\": 2,\n \"on_fail\": -1,\n \"fail_constraint\": {\n \"operator\": \"EqualTo\",\n \"value\": 5\n },\n \"parameter_values\": [\n {\n \"name\": \"PARAM1\",\n \"value\": \"VAL1\"\n },\n {\n \"name\": \"PARAM1\",\n \"value\": \"VAL1\"\n }\n ]\n }\n ],\n \"name\": \"Task 1\",\n \"api_name\": \"task_1\",\n \"notifications\": [\n {\n \"type\": \"Complete\",\n \"groups\": [\n \"group_1\",\n \"group_2\"\n ],\n \"emails\": [\n \"john.doe@zetaglobal.com\",\n \"john.deer@zetaglobal.com\"\n ],\n \"include_process_details\": false\n },\n {\n \"type\": \"Complete\",\n \"groups\": [\n \"group_1\",\n \"group_2\"\n ],\n \"emails\": [\n \"john.doe@zetaglobal.com\",\n \"john.deer@zetaglobal.com\"\n ],\n \"include_process_details\": false\n }\n ],\n \"description\": \"A very nice task.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"scheduler\": 0,\n \"schedule\": null,\n \"folder\": \"106\",\n \"trigger_journey_after_execution\": \"journey_1\",\n \"trigger_custom_event_after_execution\": {\n \"custom_event\": \"custom_event_1\",\n \"list\": \"list_1\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "b2d1d1ea-8817-4431-bc06-f44cbd87068c", "name": "Created", "originalRequest": { "url": { "path": [ "organizations", ":organization", "tasks", "sql" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Define if the task should be enabled after its creation.", "type": "text/plain" }, "key": "enable_after_creation", "value": "true" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"procedures\": [\n {\n \"id\": 1,\n \"sp_name\": \"ST_1.\",\n \"on_success\": 2,\n \"on_fail\": -1,\n \"fail_constraint\": {\n \"operator\": \"EqualTo\",\n \"value\": 5\n },\n \"parameter_values\": [\n {\n \"name\": \"PARAM1\",\n \"value\": \"VAL1\"\n },\n {\n \"name\": \"PARAM1\",\n \"value\": \"VAL1\"\n }\n ]\n },\n {\n \"id\": 1,\n \"sp_name\": \"ST_1.\",\n \"on_success\": 2,\n \"on_fail\": -1,\n \"fail_constraint\": {\n \"operator\": \"EqualTo\",\n \"value\": 5\n },\n \"parameter_values\": [\n {\n \"name\": \"PARAM1\",\n \"value\": \"VAL1\"\n },\n {\n \"name\": \"PARAM1\",\n \"value\": \"VAL1\"\n }\n ]\n }\n ],\n \"name\": \"Task 1\",\n \"api_name\": \"task_1\",\n \"notifications\": [\n {\n \"type\": \"Complete\",\n \"groups\": [\n \"group_1\",\n \"group_2\"\n ],\n \"emails\": [\n \"john.doe@zetaglobal.com\",\n \"john.deer@zetaglobal.com\"\n ],\n \"include_process_details\": false\n },\n {\n \"type\": \"Complete\",\n \"groups\": [\n \"group_1\",\n \"group_2\"\n ],\n \"emails\": [\n \"john.doe@zetaglobal.com\",\n \"john.deer@zetaglobal.com\"\n ],\n \"include_process_details\": false\n }\n ],\n \"description\": \"A very nice task.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"scheduler\": 0,\n \"schedule\": null,\n \"folder\": \"106\",\n \"trigger_journey_after_execution\": \"journey_1\",\n \"trigger_custom_event_after_execution\": {\n \"custom_event\": \"custom_event_1\",\n \"list\": \"list_1\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Task task_name created successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "c8eb2f73-2da0-432c-bc26-77557c5222e8", "name": "Bad request", "originalRequest": { "url": { "path": [ "organizations", ":organization", "tasks", "sql" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Define if the task should be enabled after its creation.", "type": "text/plain" }, "key": "enable_after_creation", "value": "true" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"procedures\": [\n {\n \"id\": 1,\n \"sp_name\": \"ST_1.\",\n \"on_success\": 2,\n \"on_fail\": -1,\n \"fail_constraint\": {\n \"operator\": \"EqualTo\",\n \"value\": 5\n },\n \"parameter_values\": [\n {\n \"name\": \"PARAM1\",\n \"value\": \"VAL1\"\n },\n {\n \"name\": \"PARAM1\",\n \"value\": \"VAL1\"\n }\n ]\n },\n {\n \"id\": 1,\n \"sp_name\": \"ST_1.\",\n \"on_success\": 2,\n \"on_fail\": -1,\n \"fail_constraint\": {\n \"operator\": \"EqualTo\",\n \"value\": 5\n },\n \"parameter_values\": [\n {\n \"name\": \"PARAM1\",\n \"value\": \"VAL1\"\n },\n {\n \"name\": \"PARAM1\",\n \"value\": \"VAL1\"\n }\n ]\n }\n ],\n \"name\": \"Task 1\",\n \"api_name\": \"task_1\",\n \"notifications\": [\n {\n \"type\": \"Complete\",\n \"groups\": [\n \"group_1\",\n \"group_2\"\n ],\n \"emails\": [\n \"john.doe@zetaglobal.com\",\n \"john.deer@zetaglobal.com\"\n ],\n \"include_process_details\": false\n },\n {\n \"type\": \"Complete\",\n \"groups\": [\n \"group_1\",\n \"group_2\"\n ],\n \"emails\": [\n \"john.doe@zetaglobal.com\",\n \"john.deer@zetaglobal.com\"\n ],\n \"include_process_details\": false\n }\n ],\n \"description\": \"A very nice task.\",\n \"tags\": [\n \"addresses\",\n \"footer\",\n \"email\",\n \"holiday\"\n ],\n \"scheduler\": 0,\n \"schedule\": null,\n \"folder\": \"106\",\n \"trigger_journey_after_execution\": \"journey_1\",\n \"trigger_custom_event_after_execution\": {\n \"custom_event\": \"custom_event_1\",\n \"list\": \"list_1\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": \"Request Failed\"\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "131fad3c-fdd5-450e-a3ab-eff8a0cc7173", "name": "Status", "description": { "content": "All status endpoints", "type": "text/plain" }, "item": [ { "id": "744a5a75-64fe-4e03-8c02-9e27511930ec", "name": "Get API status", "request": { "name": "Get API status", "description": { "content": "This endpoint will only return an http-status-code. If this is 200 the API is up and running.", "type": "text/plain" }, "url": { "path": [ "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "2826b822-c0ff-42ad-8d8f-13c4ab3be8aa", "name": "OK", "originalRequest": { "url": { "path": [ "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "98eaeb76-a1b7-48c1-b101-a8d6c38612b1", "name": "Stored Procedure", "description": { "content": "All stored procedures endpoints", "type": "text/plain" }, "item": [ { "id": "a9982fe1-63da-405d-b484-de6df361da14", "name": "List stored procedures", "request": { "name": "List stored procedures", "description": { "content": "List stored procedures satisfying the provided criteria, under the provided organization.", "type": "text/plain" }, "url": { "path": [ "storedprocedures" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter stored procedures by type.", "type": "text/plain" }, "key": "filter", "value": "General" }, { "disabled": false, "description": { "content": "Search with a specific name, api_name, description or tag(s).", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" }, { "disabled": false, "description": { "content": "The maximum amount of items to return.", "type": "text/plain" }, "key": "take", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "3c635906-4955-4693-a390-4f1b64fc3bb7", "name": "ok", "originalRequest": { "url": { "path": [ "storedprocedures" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter stored procedures by type.", "type": "text/plain" }, "key": "filter", "value": "General" }, { "disabled": false, "description": { "content": "Search with a specific name, api_name, description or tag(s).", "type": "text/plain" }, "key": "search", "value": "marigold_1" }, { "disabled": false, "description": { "content": "The index to start from, skipping all the previous results.", "type": "text/plain" }, "key": "skip", "value": "100" }, { "disabled": false, "description": { "content": "The maximum amount of items to return.", "type": "text/plain" }, "key": "take", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"stored_procedures\": [\n {\n \"type\": \"Bounce\",\n \"name\": \"ST_1\"\n },\n {\n \"type\": \"Bounce\",\n \"name\": \"ST_1\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2a4c4afa-0bc7-40c2-81d0-95a2ef7d0750", "name": "Create stored procedure", "request": { "name": "Create stored procedure", "description": { "content": "Create a new stored procedure in the organization.", "type": "text/plain" }, "url": { "path": [ "storedprocedures" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"ST_1\",\n \"body\": \"SELECT 'some result' as RESULT;\",\n \"type\": \"Bounce\",\n \"description\": \"General Stored Procedure\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "b6fcfa8e-d1f7-4c06-8b83-ae6ec19a5760", "name": "ok", "originalRequest": { "url": { "path": [ "storedprocedures" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"ST_1\",\n \"body\": \"SELECT 'some result' as RESULT;\",\n \"type\": \"Bounce\",\n \"description\": \"General Stored Procedure\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Stored procedure created successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "dfa31a25-b7b3-4de5-8c05-367b59203446", "name": "Bad Request", "originalRequest": { "url": { "path": [ "storedprocedures" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"ST_1\",\n \"body\": \"SELECT 'some result' as RESULT;\",\n \"type\": \"Bounce\",\n \"description\": \"General Stored Procedure\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "021cb3e5-bc72-43a0-aa7a-f801b9837c5f", "name": "Get stored procedure", "request": { "name": "Get stored procedure", "description": { "content": "Get details of stored procedure by the specified name.", "type": "text/plain" }, "url": { "path": [ "storedprocedures", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the stored procedure.", "type": "text/plain" }, "type": "any", "value": "storedprocedure_1", "key": "name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "02b26f73-1375-475e-bfac-a6131068ff90", "name": "ok", "originalRequest": { "url": { "path": [ "storedprocedures", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"Bounce\",\n \"name\": \"ST_1\",\n \"description\": \"General Stored Procedure\",\n \"body\": \"SELECT 'some result' as RESULT;\"\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "text" }, "id": "0e4e222a-838d-4a61-9027-c5c8ba191f86", "name": "Not found", "originalRequest": { "url": { "path": [ "storedprocedures", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2e0286c5-3364-432d-9994-acabe982eb45", "name": "Update stored procedure", "request": { "name": "Update stored procedure", "description": { "content": "Update an existing stored procedure.", "type": "text/plain" }, "url": { "path": [ "storedprocedures", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the stored procedure.", "type": "text/plain" }, "type": "any", "value": "storedprocedure_1", "key": "name" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"General Stored Procedure\",\n \"body\": \"SELECT 'some result' as RESULT;\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "7e60eda8-8f61-43e0-a455-4ac80ff67353", "name": "ok", "originalRequest": { "url": { "path": [ "storedprocedures", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"General Stored Procedure\",\n \"body\": \"SELECT 'some result' as RESULT;\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"Stored procedure updated successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "66ce5760-fde2-42f6-8882-509fc61f0542", "name": "Bad Request", "originalRequest": { "url": { "path": [ "storedprocedures", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"General Stored Procedure\",\n \"body\": \"SELECT 'some result' as RESULT;\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR\",\n \"description\": \"Incorrect data provided.\"\n }\n ],\n \"result_code\": \"Failed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3bf6ea1-ac51-4a8b-809a-8eab0b8923a1", "name": "Delete stored procedure", "request": { "name": "Delete stored procedure", "description": { "content": "Delete a existing stored procedure.", "type": "text/plain" }, "url": { "path": [ "storedprocedures", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Name of the stored procedure.", "type": "text/plain" }, "type": "any", "value": "storedprocedure_1", "key": "name" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "05fea3ab-ebf4-4579-94e7-0d85de41a482", "name": "ok", "originalRequest": { "url": { "path": [ "storedprocedures", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result_code\": \"Succeeded\",\n \"message\": \"The stored procedure has been deleted successfully.\",\n \"errors\": []\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "a05b4f9e-28e0-40dc-9347-d7f95d8e21cb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "storedprocedures", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-ApiKey", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"ERR_STOREDPROCEDURE_VALIDATION\",\n \"description\": \"Failed to delete stored procedure.\"\n }\n ],\n \"result_code\": \"ValidationFailed\",\n \"message\": null\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "X-ApiKey", "key": "key" }, { "type": "any", "value": "{{apiKey}}:{{apiKeySecret}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] }, "event": [], "variable": [ { "type": "any", "value": "https://customername.slgnt.eu/Portal/Api", "key": "baseUrl" }, { "type": "string", "value": "", "key": "apiKey" }, { "type": "string", "value": "", "key": "apiKeySecret" }, { "type": "string", "value": "", "key": "organization" }, { "type": "string", "value": "", "key": "apiName" } ], "info": { "_postman_id": "c1b92fc4-90f0-4a23-a6b0-25a0d3f1255d", "name": "Selligent API", "version": { "raw": "1.0.0", "major": 1, "minor": 0, "patch": 0, "prerelease": [], "build": [], "string": "1.0.0" }, "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "# Selligent API Reference\n\nBy providing a fully documented API reference, we want to enable everyone to maximize the usage of the Selligent Marketing Platform for automating & exchange data.\n\n# REST API\n\n\n\n## Authentication\n\nThe Selligent V1 API's use the basic authentication protocol, through key/secter key authentication with the `X-ApiKey` Header, and value `{key}:{secret}`.\nIf you have a Selligent account with admin configuration rights, then you can create a Service Account under Admin Configuration --> Access Management --> Service Accounts.\nMake sure to select type `custom` for credentials for this api.\nthat will generate these credentials. \n\n![](assets/img/service-account.png)\n\nOnce this service account is generated, your `Key` and `Secret` will be made available. You can rotate this pair at any time.\nYou can further specify an expiry date for your keys.\nunder \"endpoints\" you can specify which actions on the API can be performed by this service account.\nIf the service account does an action it is not configured for, a 401 unauthorized will be returned by the API.\n\n![](assets/img/endpoints-config.png)\n\n\n## Errors\n\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# 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 - smc-api-rest-v1.openapi.json\n- OpenAPI 3.0 - YAML format - smc-api-rest-v1.openapi.yaml\n\nThe older Swagger/OpenAPI 2.0 can currently still be accessed from the Api explorer in engage. We will not support it explicitly here.\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 SMC API V2.\n\n\"Open\n\n\nImport the Postman collection through any of the methods specified below.\n\n\n- Use the link: https://developers.meetmarigold.com/engage/api/smc-v1/postman/smc-api-rest-v1.postman.json via \"Import\" > \"Link\"\n- Download the file smc-api-rest-v1.postman.json and import the file via \"Import\" > \"File\"\n- Download the file smc-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 API key and base URL.\n\n- **baseUrl** - Your personalised Selligent base URL\n- **X-ApiKey** - Your Selligent secret API key.\n\nThese variables can be found by navigating to \"Admin Config\" > \"Access Management\" > \"Service Accounts\" on the left-hand side of the administration section.\nMake sure your Selligent Environment is active, and your variable definitions match those listed above.\n\n\n \n\n\nContact Support:\n Name: Team Selligent\n Email: info@zetaglobal.com", "type": "text/plain" } } }