{ "info": { "_postman_id": "6c0abb59-0cda-48a2-bfa8-1061f343c093", "name": "Emarsys APIs", "description": "

Main endpoint groups:

Contacts: A contact is an end customer, such as a potential recipient of marketing campaigns. Contacts can be grouped into either contact lists or segments. While contact lists are static, segments include contacts dynamically if they meet a certain filtering criteria.
Fields: A field stores contact-related data as key-value pair properties.
Contact lists: A contact list is static group of contacts. Once you define a contact list, it does not change based on contextual critera, as segments do. You can modify existing contact lists in the application or via the API.
Email campaign lifecycle: Campaign launch endpoints allow you to manage an existing email campaign.
Segments: A segment is a group of contacts generated dynamically based on custom-defined criteria, called a filter. Each time a segment is used, the filter runs and the group of contacts in the segment is updated. You can save segments as contact lists to make them static.
Contact sources: A contact source is used to import contacts into the Emarsys database as well as to track the origin of contact data changes. Updating existing contact sources is not supported currently.
Forms: A form is useful to collect data from contacts, such as registration form on a web page. Creating, updating, and deleting existing forms is not supported at the moment.", "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json", "_exporter_id": "16191677" }, "item": [ { "name": "/v2/ ( Suite )", "item": [ { "name": "Administrator", "item": [ { "name": "{administrator Id}", "item": [ { "name": "Get Administrator Details", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/administrator/:administratorId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "administrator", ":administratorId" ], "variable": [ { "key": "administratorId", "value": "81739474", "description": "(Required) The identifier of the administrator." } ] }, "description": "Returns the details of an admininstrator user of the customer's account.\n\n**Important:** Access to administrative endpoints is restricted. If you need access, contact Emarsys support." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/administrator/:administratorId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "administrator", ":administratorId" ], "variable": [ { "key": "administratorId", "value": "81739474", "description": "(Required) The identifier of the administrator." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 38153743,\n \"replyText\": \"dolor quis\",\n \"data\": {\n \"id\": -91065276,\n \"username\": \"sit ad Ut\",\n \"email\": \"laboris\",\n \"first_name\": \"elit veniam in\",\n \"last_name\": \"eiusmod\",\n \"interface_language\": \"do enim ea aliquip\",\n \"default_upages_lang\": \"reprehenderit amet\",\n \"access_level\": -90757291,\n \"position\": \"pariatur\",\n \"title\": \"adipisicing id elit tempor nulla\",\n \"tz\": \"exercitation do enim Duis ut\",\n \"mobile_phone\": \"ea irure\",\n \"pwd_update_interval\": -71250455\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/administrator/:administratorId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "administrator", ":administratorId" ], "variable": [ { "key": "administratorId", "value": "81739474", "description": "(Required) The identifier of the administrator." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Update an Administrator Account", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"administratorId\": \"111111111\",\n \"username\": \"b_panther\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/administrator/:administratorId/patch", "host": [ "{{baseUrl}}" ], "path": [ "v2", "administrator", ":administratorId", "patch" ], "variable": [ { "key": "administratorId", "value": "81739474", "description": "(Required) The identifier of the adminstrator." } ] }, "description": "Modifies the properties of an administrator account.\n\n**Important:** Access to administrative endpoints is restricted. If you need access, contact Emarsys support." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"administratorId\": \"111111111\",\n \"username\": \"b_panther\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/administrator/:administratorId/patch", "host": [ "{{baseUrl}}" ], "path": [ "v2", "administrator", ":administratorId", "patch" ], "variable": [ { "key": "administratorId", "value": "81739474", "description": "(Required) The identifier of the adminstrator." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 38153743,\n \"replyText\": \"dolor quis\",\n \"data\": {\n \"id\": -91065276,\n \"username\": \"sit ad Ut\",\n \"email\": \"laboris\",\n \"first_name\": \"elit veniam in\",\n \"last_name\": \"eiusmod\",\n \"interface_language\": \"do enim ea aliquip\",\n \"default_upages_lang\": \"reprehenderit amet\",\n \"access_level\": -90757291,\n \"position\": \"pariatur\",\n \"title\": \"adipisicing id elit tempor nulla\",\n \"tz\": \"exercitation do enim Duis ut\",\n \"mobile_phone\": \"ea irure\",\n \"pwd_update_interval\": -71250455\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"administratorId\": \"111111111\",\n \"username\": \"b_panther\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/administrator/:administratorId/patch", "host": [ "{{baseUrl}}" ], "path": [ "v2", "administrator", ":administratorId", "patch" ], "variable": [ { "key": "administratorId", "value": "81739474", "description": "(Required) The identifier of the adminstrator." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Delete an Administrator Account", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/administrator/:administratorId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "administrator", ":administratorId", "delete" ], "variable": [ { "key": "administratorId", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) " } ] }, "description": "Deletes an administrator account and transfers its rights to another administrator account." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/administrator/:administratorId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "administrator", ":administratorId", "delete" ], "variable": [ { "key": "administratorId", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/administrator/:administratorId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "administrator", ":administratorId", "delete" ], "variable": [ { "key": "administratorId", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) " } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Create a Session for an Administrator Account", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"target\": \"contact_lists/details\",\n \"target_params\": {\n \"contact_list_id\": \"577064194\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/administrator/:administratorId/session", "host": [ "{{baseUrl}}" ], "path": [ "v2", "administrator", ":administratorId", "session" ], "variable": [ { "key": "administratorId", "value": "81739474", "description": "(Required) The identifier of the administrator.\n\n**Note:** Get available administrators at the [List Administrator Accounts](/reference/openapi.json/paths/~1v2~1administrator/get) endpoint." } ] }, "description": "Creates a session for administrators for logging in users from outside the Emarsys application, such as implementing Single Sign-On (SSO).\n\n**Note:** This feature is in the pilot phase and currently available for a limited number of clients only. If you are interested in participating, contact Emarsys support.\n\n**Important:** This feature is in the pilot phase and currently available for a limited number of clients only. If you are interested in participating, contact Emarsys support." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"target\": \"contact_lists/details\",\n \"target_params\": {\n \"contact_list_id\": \"577064194\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/administrator/:administratorId/session", "host": [ "{{baseUrl}}" ], "path": [ "v2", "administrator", ":administratorId", "session" ], "variable": [ { "key": "administratorId", "value": "81739474", "description": "(Required) The identifier of the administrator.\n\n**Note:** Get available administrators at the [List Administrator Accounts](/reference/openapi.json/paths/~1v2~1administrator/get) endpoint." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 83309673,\n \"replyText\": \"Duis magna Ut\",\n \"data\": {\n \"url\": \"cupidatat labore ut\"\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"target\": \"contact_lists/details\",\n \"target_params\": {\n \"contact_list_id\": \"577064194\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/administrator/:administratorId/session", "host": [ "{{baseUrl}}" ], "path": [ "v2", "administrator", ":administratorId", "session" ], "variable": [ { "key": "administratorId", "value": "81739474", "description": "(Required) The identifier of the administrator.\n\n**Note:** Get available administrators at the [List Administrator Accounts](/reference/openapi.json/paths/~1v2~1administrator/get) endpoint." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"target\": \"contact_lists/details\",\n \"target_params\": {\n \"contact_list_id\": \"577064194\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/administrator/:administratorId/session", "host": [ "{{baseUrl}}" ], "path": [ "v2", "administrator", ":administratorId", "session" ], "variable": [ { "key": "administratorId", "value": "81739474", "description": "(Required) The identifier of the administrator.\n\n**Note:** Get available administrators at the [List Administrator Accounts](/reference/openapi.json/paths/~1v2~1administrator/get) endpoint." } ] } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "Create an Administrator Account", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"black_panther\",\n \"password\": \"Black891+Panther\",\n \"pwd_update_interval\": 30,\n \"email\": \"black.panther@emarsys.com\",\n \"access_level\": 1,\n \"interface_language\": \"en\",\n \"default_upages_lang\": \"en\",\n \"first_name\": \"Black\",\n \"last_name\": \"Panther\",\n \"mobile_phone\": \"36-304445555\",\n \"position\": \"superhero\",\n \"last_verification_action_date\": \"2015-05-14 11:24:09\",\n \"actual_login\": \"2015-06-10 09:45:54\",\n \"disabled\": 0,\n \"superadmin\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/administrator", "description": "Creates a new administrator account.\n\n**Important:** Access to administrative endpoints is restricted. If you need access, contact Emarsys support." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"black_panther\",\n \"password\": \"Black891+Panther\",\n \"pwd_update_interval\": 30,\n \"email\": \"black.panther@emarsys.com\",\n \"access_level\": 1,\n \"interface_language\": \"en\",\n \"default_upages_lang\": \"en\",\n \"first_name\": \"Black\",\n \"last_name\": \"Panther\",\n \"mobile_phone\": \"36-304445555\",\n \"position\": \"superhero\",\n \"last_verification_action_date\": \"2015-05-14 11:24:09\",\n \"actual_login\": \"2015-06-10 09:45:54\",\n \"disabled\": 0,\n \"superadmin\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/administrator" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 38153743,\n \"replyText\": \"dolor quis\",\n \"data\": {\n \"id\": -91065276,\n \"username\": \"sit ad Ut\",\n \"email\": \"laboris\",\n \"first_name\": \"elit veniam in\",\n \"last_name\": \"eiusmod\",\n \"interface_language\": \"do enim ea aliquip\",\n \"default_upages_lang\": \"reprehenderit amet\",\n \"access_level\": -90757291,\n \"position\": \"pariatur\",\n \"title\": \"adipisicing id elit tempor nulla\",\n \"tz\": \"exercitation do enim Duis ut\",\n \"mobile_phone\": \"ea irure\",\n \"pwd_update_interval\": -71250455\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"black_panther\",\n \"password\": \"Black891+Panther\",\n \"pwd_update_interval\": 30,\n \"email\": \"black.panther@emarsys.com\",\n \"access_level\": 1,\n \"interface_language\": \"en\",\n \"default_upages_lang\": \"en\",\n \"first_name\": \"Black\",\n \"last_name\": \"Panther\",\n \"mobile_phone\": \"36-304445555\",\n \"position\": \"superhero\",\n \"last_verification_action_date\": \"2015-05-14 11:24:09\",\n \"actual_login\": \"2015-06-10 09:45:54\",\n \"disabled\": 0,\n \"superadmin\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/administrator" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "List Administrator Accounts", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/v2/administrator", "description": "Returns a list of administrator users of the customer's account.\n\n**Important:** Access to administrative endpoints is restricted. If you need access, contact Emarsys support." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/administrator" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -3582156,\n \"replyText\": \"incididunt\",\n \"data\": {}\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/administrator" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "List Access Levels", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/v2/administrator/getaccesslevels", "description": "Returns the list of available access levels for the customer's account.\n\n**Important:** Access to administrative endpoints is restricted. If you need access, contact Emarsys support." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/administrator/getaccesslevels" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 46684835,\n \"replyText\": \"Excepteur nost\",\n \"data\": [\n {\n \"id\": -87050351,\n \"name\": \"sed enim nisi velit qui\",\n \"type\": \"custom\"\n },\n {\n \"id\": 35533601,\n \"name\": \"qui aute voluptate\",\n \"type\": \"default\"\n }\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/administrator/getaccesslevels" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Get User Interface Languages", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/v2/administrator/getinterfacelanguages", "description": "Returns the list of available user interface languages of the Emarsys application.\n\n**Important:** Access to administrative endpoints is restricted. If you need access, contact Emarsys support." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/administrator/getinterfacelanguages" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -41133890,\n \"replyText\": \"qui in in adipisicing esse\",\n \"data\": [\n \"kc\",\n \"cb\"\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/administrator/getinterfacelanguages" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "List Administrator Start Pages", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/v2/administrator/getstartpages", "description": "Lists the start pages where administrators are redirected to on login.\n\n**Important:** Access to administrative endpoints is restricted. If you need access, contact Emarsys support." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/administrator/getstartpages" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 82245957,\n \"replyText\": \"adipisici\",\n \"data\": [\n \"Ut irure\",\n \"in ad minim nisi\"\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/administrator/getstartpages" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "Autoimport", "item": [ { "name": "{ profileId }", "item": [ { "name": "Query an Auto-import Profile", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/settings/autoimports/:profileId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "settings", "autoimports", ":profileId" ], "variable": [ { "key": "profileId", "value": "-24187902.757311657", "description": "(Required) The identifier of the auto-import profile. Use the [List Auto-import Profiles](/reference/openapi.json/paths/~1v2~1settings~1autoimports/get) endpoint to query available profiles and their identifiers." } ] }, "description": "Returns the details of the specified auto-import profile." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/settings/autoimports/:profileId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "settings", "autoimports", ":profileId" ], "variable": [ { "key": "profileId", "value": "-24187902.757311657", "description": "(Required) The identifier of the auto-import profile. Use the [List Auto-import Profiles](/reference/openapi.json/paths/~1v2~1settings~1autoimports/get) endpoint to query available profiles and their identifiers." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/settings/autoimports/:profileId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "settings", "autoimports", ":profileId" ], "variable": [ { "key": "profileId", "value": "-24187902.757311657", "description": "(Required) The identifier of the auto-import profile. Use the [List Auto-import Profiles](/reference/openapi.json/paths/~1v2~1settings~1autoimports/get) endpoint to query available profiles and their identifiers." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Delete an Auto-import Profile", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/settings/autoimports/:profileId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "settings", "autoimports", ":profileId", "delete" ], "variable": [ { "key": "profileId", "value": "-24187902.757311657", "description": "(Required) The identifier of the auto-import profile. Use the [List Auto-import Profiles](/reference/openapi.json/paths/~1v2~1settings~1autoimports/get) endpoint to query available profiles and their identifiers." } ] }, "description": "Deletes the specified auto-import profile." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/settings/autoimports/:profileId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "settings", "autoimports", ":profileId", "delete" ], "variable": [ { "key": "profileId", "value": "-24187902.757311657", "description": "(Required) The identifier of the auto-import profile. Use the [List Auto-import Profiles](/reference/openapi.json/paths/~1v2~1settings~1autoimports/get) endpoint to query available profiles and their identifiers." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/settings/autoimports/:profileId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "settings", "autoimports", ":profileId", "delete" ], "variable": [ { "key": "profileId", "value": "-24187902.757311657", "description": "(Required) The identifier of the auto-import profile. Use the [List Auto-import Profiles](/reference/openapi.json/paths/~1v2~1settings~1autoimports/get) endpoint to query available profiles and their identifiers." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "Create an Auto-import Profile", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"fields\": {},\n \"separator\": \",\",\n \"language\": \"en\",\n \"date_format\": \"DD.MM.YYYY\",\n \"optin\": \"\",\n \"userlist_name\": \"\",\n \"text_separator\": \"\",\n \"file_pattern\": \"*.csv\",\n \"source\": \"\",\n \"fieldnames\": false,\n \"as_list\": false,\n \"newsletter\": false,\n \"skip_empty\": false,\n \"update_only\": false,\n \"enabled\": false\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/settings/autoimports/", "description": "Creates a new Auto-import Profile with the parameters you specify in the request body.\n\nNo need to provide a name, the system names the new profile and it can be read in the reply." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"fields\": {},\n \"separator\": \",\",\n \"language\": \"en\",\n \"date_format\": \"DD.MM.YYYY\",\n \"optin\": \"\",\n \"userlist_name\": \"\",\n \"text_separator\": \"\",\n \"file_pattern\": \"*.csv\",\n \"source\": \"\",\n \"fieldnames\": false,\n \"as_list\": false,\n \"newsletter\": false,\n \"skip_empty\": false,\n \"update_only\": false,\n \"enabled\": false\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/settings/autoimports/" }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "List Auto-import Profiles", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/v2/settings/autoimports", "description": "Lists all auto-import profiles." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/settings/autoimports" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/settings/autoimports" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "Automation / Programs", "item": [ { "name": "{program id}", "item": [ { "name": "Abort a Program", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Accept", "value": "text/html" } ], "url": { "raw": "{{baseUrl}}/v2/ac/programs/:program_id/abort", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ac", "programs", ":program_id", "abort" ], "variable": [ { "key": "program_id", "value": "81739474", "description": "(Required) " } ] }, "description": "\n> #### Watch Out!\n>\n> This endpoint is getting deprecated in July 2022 and calls from then on will result in an error `9103` reply. We recommend freezing, finishing programs or using the [Delete a Program](/reference/openapi.json/paths/~1v2~1ac~1programs~1{program_id}~1delete/post) endpoint instead.\n\nAborts the selected Automation Center program." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/ac/programs/:program_id/abort", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ac", "programs", ":program_id", "abort" ], "variable": [ { "key": "program_id", "value": "81739474", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/html" } ], "cookie": [], "body": "" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/ac/programs/:program_id/abort", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ac", "programs", ":program_id", "abort" ], "variable": [ { "key": "program_id", "value": "81739474", "description": "(Required) " } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/html" } ], "cookie": [], "body": "" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/ac/programs/:program_id/abort", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ac", "programs", ":program_id", "abort" ], "variable": [ { "key": "program_id", "value": "81739474", "description": "(Required) " } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/html" } ], "cookie": [], "body": "" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/ac/programs/:program_id/abort", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ac", "programs", ":program_id", "abort" ], "variable": [ { "key": "program_id", "value": "81739474", "description": "(Required) " } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/html" } ], "cookie": [], "body": "" } ] }, { "name": "Delete a Program", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Accept", "value": "text/html" } ], "url": { "raw": "{{baseUrl}}/v2/ac/programs/:program_id/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ac", "programs", ":program_id", "delete" ], "variable": [ { "key": "program_id", "value": "81739474", "description": "(Required) " } ] }, "description": "Deletes a specified Automation Center program." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/ac/programs/:program_id/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ac", "programs", ":program_id", "delete" ], "variable": [ { "key": "program_id", "value": "81739474", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/html" } ], "cookie": [], "body": "" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/ac/programs/:program_id/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ac", "programs", ":program_id", "delete" ], "variable": [ { "key": "program_id", "value": "81739474", "description": "(Required) " } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/html" } ], "cookie": [], "body": "" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/ac/programs/:program_id/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ac", "programs", ":program_id", "delete" ], "variable": [ { "key": "program_id", "value": "81739474", "description": "(Required) " } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/html" } ], "cookie": [], "body": "" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/ac/programs/:program_id/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ac", "programs", ":program_id", "delete" ], "variable": [ { "key": "program_id", "value": "81739474", "description": "(Required) " } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/html" } ], "cookie": [], "body": "" } ] } ] }, { "name": "List Programs", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "text/html" } ], "url": "{{baseUrl}}/v2/ac/programs", "description": "Returns a list of all available (not deleted) Automation Center programs for a customer." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/ac/programs" }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/html" } ], "cookie": [], "body": "" } ] }, { "name": "Start a Program", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"contact_list_id\": 123456789\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/ac/programs/entrypoints/:nodeType/resources/:resourceId/runs", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ac", "programs", "entrypoints", ":nodeType", "resources", ":resourceId", "runs" ], "variable": [ { "key": "nodeType", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) The identifier of the integration’s node.\n\n**Note:** Emarsys support can provide node identifiers." }, { "key": "resourceId", "value": "81739474", "description": "(Required) The identifier of the integration specified in the integration’s API node." } ] }, "description": "Starts the progress of contacts through Automation Center programs at the specified entry point of the selected resource." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"contact_list_id\": 123456789\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/ac/programs/entrypoints/:nodeType/resources/:resourceId/runs", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ac", "programs", "entrypoints", ":nodeType", "resources", ":resourceId", "runs" ], "variable": [ { "key": "nodeType", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) The identifier of the integration’s node.\n\n**Note:** Emarsys support can provide node identifiers." }, { "key": "resourceId", "value": "81739474", "description": "(Required) The identifier of the integration specified in the integration’s API node." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"contact_list_id\": 123456789\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/ac/programs/entrypoints/:nodeType/resources/:resourceId/runs", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ac", "programs", "entrypoints", ":nodeType", "resources", ":resourceId", "runs" ], "variable": [ { "key": "nodeType", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) The identifier of the integration’s node.\n\n**Note:** Emarsys support can provide node identifiers." }, { "key": "resourceId", "value": "81739474", "description": "(Required) The identifier of the integration specified in the integration’s API node." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "Contact", "item": [ { "name": "Query", "item": [ { "name": "List Contact Data", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/contact/query/?{fieldId}=Ut pariatur adipisicing irure ut&return=81739474&excludeempty=false&limit=10000&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contact", "query", "" ], "query": [ { "key": "{fieldId}", "value": "Ut pariatur adipisicing irure ut", "description": "The field identifier and it's value to filter the result.\n\n**Note:** Send an empty string as the field value to return fields with `null` value." }, { "key": "return", "value": "81739474", "description": "(Required) Specifies the field identifier to filter contacts." }, { "key": "excludeempty", "value": "false", "description": "If `true`, contacts with a null or empty value in the specified field are not returned.\n\n**Note:** Any value except for `true` is interpreted as false." }, { "key": "limit", "value": "10000", "description": "Specifies the maximum number of records to return." }, { "key": "offset", "value": "0", "description": "Specifies an offset for pagination. The offset of the first record is *0*." } ] }, "description": "Returns a list of the values of the specified field as well as the related contact identifiers (`id`). See [Concepts](docs/before-you-start/concepts.md) for details.\n\n**Example:** The field identifier *1* returns the first names of all contacts.\n\n>***Tip:** You can use the [Postman Collection](https://raw.githubusercontent.com/emartech/developer-hub-public-assets/master/resources/EmarsysV2PostmanCollection.json) to test the endpoint." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/contact/query/?{fieldId}=Ut pariatur adipisicing irure ut&return=81739474&excludeempty=false&limit=10000&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contact", "query", "" ], "query": [ { "key": "{fieldId}", "value": "Ut pariatur adipisicing irure ut" }, { "key": "return", "value": "81739474" }, { "key": "excludeempty", "value": "false" }, { "key": "limit", "value": "10000" }, { "key": "offset", "value": "0" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -50558341,\n \"replyText\": \"enim consectetur\",\n \"data\": {\n \"result\": [\n {\n \"65\": \"Excepteur magna ullamco minim\",\n \"id\": 95258801\n },\n {\n \"3519368\": \"et laborum aute\",\n \"id\": -16536495\n }\n ]\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/contact/query/?{fieldId}=Ut pariatur adipisicing irure ut&return=81739474&excludeempty=true&limit=10000&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contact", "query", "" ], "query": [ { "key": "{fieldId}", "value": "Ut pariatur adipisicing irure ut" }, { "key": "return", "value": "81739474" }, { "key": "excludeempty", "value": "true" }, { "key": "limit", "value": "10000" }, { "key": "offset", "value": "0" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Get Internal Contact Identifiers", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/contact/query/?{{keyId}}={{keyValue}}&return=81739474&limit=1000000&offset=0&excludeempty=true", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contact", "query", "" ], "query": [ { "key": "{{keyId}}", "value": "{{keyValue}}" }, { "key": "return", "value": "81739474", "description": "(Required) The identifier pf the field to return along with the contact identifier. If not provided, only the contact identifier is returned." }, { "key": "limit", "value": "1000000", "description": "Specifies the maximum number of records to return." }, { "key": "offset", "value": "0", "description": "Specifies an offset for pagination. The offset of the first record is *0*." }, { "key": "excludeempty", "value": "true", "description": "If `true`, contacts with a null or empty value in the specified field are not returned.\n\n**Note:** Any value except for `true` is interpreted as false." } ] }, "description": "Returns the internal identifier of a contact by the specified field and its value. For details about contact identifiers, see [Concepts](docs/before-you-start/concepts.md).\n\n**Important:** This endpoint requires indexed fields. When you select a `keyId`, it needs to have an index.\n\n**Note:** As with [List Contact Data](reference/openapi.json/paths/~1v2~1contact~1query~1/get), the interactive demo page (Try it out) is not functional for this eddpoint. We are working on this issue." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/contact/query/?return=81739474&limit=1000000&offset=0&excludeempty=true", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contact", "query", "" ], "query": [ { "key": "return", "value": "81739474" }, { "key": "limit", "value": "1000000" }, { "key": "offset", "value": "0" }, { "key": "excludeempty", "value": "true" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 55036584,\n \"replyText\": \"qui proident aliquip\",\n \"data\": {\n \"id\": -85273284\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/contact/query/?return=81739474&limit=1000000&offset=0&excludeempty=true", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contact", "query", "" ], "query": [ { "key": "return", "value": "81739474" }, { "key": "limit", "value": "1000000" }, { "key": "offset", "value": "0" }, { "key": "excludeempty", "value": "true" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "Create Contacts", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"contact_list_id\": -39176876,\n \"key_id\": \"consectetur non\",\n \"contacts\": [\n {\n \"2\": \"Ut occaecat sit minim\",\n \"3\": \"esse enim veniam est\"\n },\n {\n \"2\": \"culpa consectetur ea in\",\n \"3\": \"cillum sed\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact", "description": "Creates new contacts, returns their automatically generated unique identifier (`id`), and maps their data to the relevant fields using the respective field identifiers. For details, see [Concepts](docs/before-you-start/concepts.md).\n\n**Note:**\n\nThe example below in the Request Body section shows the scenario when multiple contacts are created. However, when only a single contact is to be added, the following JSON structure must be used:\n ```\n {\n \"key_id\" : \"3\",\n \"3\" : \"johndoe@example.com\",\n \"1\" : \"John\",\n \"2\" : \"Doe\"\n}\n```\n\n**To consider:**\n- The maximum payload size is 10 MB, therefore the maximum number of new contacts per call depends on the amount of data per contact.\n- The maximum batch size is 1000 contacts per call.\n\n**Note:** Due to limitations of API specification languages, dynamic keys are indicated by curly brackets or by a regex pattern.\n\n**Important:** When [Exporting updated contacts](/reference/openapi.json/paths/~1v2~1contact~1getchanges/post), contacts that were updated through this endpoint will only be exported if their email address or opt-in status were updated." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"contact_list_id\": -17278587,\n \"key_id\": \"cillum minim esse am\",\n \"contacts\": [\n {\n \"2\": \"ipsum\",\n \"3\": \"ex sint\"\n },\n {\n \"2\": \"quis Ut culpa\",\n \"3\": \"tempor\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -20296731,\n \"replyText\": \"proident sed in\",\n \"data\": {\n \"ids\": [\n -30516251,\n 92315407\n ],\n \"errors\": {\n \"c\": {\n \"2009\": \"veniam\"\n }\n }\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"contact_list_id\": -17278587,\n \"key_id\": \"cillum minim esse am\",\n \"contacts\": [\n {\n \"2\": \"ipsum\",\n \"3\": \"ex sint\"\n },\n {\n \"2\": \"quis Ut culpa\",\n \"3\": \"tempor\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"contact_list_id\": -17278587,\n \"key_id\": \"cillum minim esse am\",\n \"contacts\": [\n {\n \"2\": \"ipsum\",\n \"3\": \"ex sint\"\n },\n {\n \"2\": \"quis Ut culpa\",\n \"3\": \"tempor\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact" }, "code": 2020, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 33430804,\n \"replyText\": \"adipisicing sunt eiusmod\",\n \"data\": \"voluptate enim\"\n}" } ] }, { "name": "Update Contacts", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"contact_list_id\": -28031749,\n \"key_id\": 78179,\n \"contacts\": [\n {\n \"2\": \"eiusmod minim consectetur\",\n \"3\": \"enim esse pariatur\"\n },\n {\n \"2\": \"veniam sint in consectetur\",\n \"3\": \"anim ut do\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/contact/?create_if_not_exists=0", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contact", "" ], "query": [ { "key": "create_if_not_exists", "value": "0", "description": "If set to *1*, creates a new contact if it does not exist yet.\n\nIf not set, defaults to *0*." } ] }, "description": "Updates multiple contacts, or creates them if they do not exist.\n\nIt is recommended to use the `id` or `uid` fields to identify contacts in order to avoid conflicts when using a non-unique field, such as `email`.\n\nFor details, see [Concepts](docs/before-you-start/concepts.md).\n\n**Notes:**\n- The maximum payload size is 8 MB, therefore the maximum number of contacts per call depends on the amount of data per contact.\n- The maximum batch size is 1000 contacts per call.\n- Only use the values *1*, *2*, or *null* to update opt-in status. Boolean string literals are not supported. For details, see [Automated double opt-in program](https://help.emarsys.com/hc/en-us/articles/360006090693-Automated-double-opt-in-program) and the #docTextSection:LJhx4uCejc6xpXXFq use case.\n- Updating a contact is an idempotent method, meaning that it can be called multiple times with the same outcome. Note that as a `PUT` request, it replaces all contact information for the contact fields included in the request body (only for the contacts specified in the request), so please make sure that you either: a) include **only** the fields you want to update, or b) populate **all the current field values** and then **add a new value** to the fields that need to be updated.\n- In case you are using the `setEmail` Web Extend command to identify your customers, whenever an update is done by your customers in their email addresses, please make sure to set the `predictUserID` and the `predictSecret` fields to `\"\"` (empty) in the payload. This is done to make sure that a new Predict user ID is created for them as soon as the web behavior field updates take place, usually within 2 hours. Only in this 2-hour period are personalized recommendations not available to view.\n- When using this endpoint to unsubscribe contacts from an email campaign, also do register the unsubscribe with the [/v2/email/unsubscribe](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4NDU) call. \n- Updating **multi-choice fields** is also possible. The following is a simple verification example for this scenario:\n\n``\nPUT https://api.emarsys.net/api/v2/contact/?create_if_not_exists=1\n``\n```json\n{\n \"3\": \"myemail@gmail.com\",\n \"8765\": [\n \"foo\",\n \"bar\",\n \"baz\",\n \"qux\"\n ],\n \"key_id\": \"3\"\n}\n```\n\nSee [Create Contacts](paths/~1v2~1contact/post) for more information on contact details.\n\n> *Important:** Due to limitations of API specification languages, dynamic keys are not yet supported in query strings on the interactive demo page (**Try it out**). We are working on this issue.

**Tip:** You can use the [Postman Collection](https://raw.githubusercontent.com/emartech/developer-hub-public-assets/master/resources/EmarsysV2PostmanCollection.json) to test the endpoint.\n\n**Important:** When [Exporting updated contacts]([Export Updated Contacts](/reference/openapi.json/paths/~1v2~1contact~1getchanges/post)), contacts that were updated through this endpoint will only be exported if their email address or opt-in status were updated." }, "response": [ { "name": "Returns the `id` of the updated or created contacts.", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"contact_list_id\": 53193191,\n \"key_id\": -11445387,\n \"contacts\": [\n {\n \"2\": \"laboris mollit\",\n \"3\": \"aliquip fugiat aliqua adipisicing\"\n },\n {\n \"2\": \"do\",\n \"3\": \"mollit minim\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/contact/?create_if_not_exists=0", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contact", "" ], "query": [ { "key": "create_if_not_exists", "value": "0" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -56524339,\n \"replyText\": \"ad sunt\",\n \"data\": {\n \"ids\": [\n \"labore pariatur\",\n \"aliquip\"\n ],\n \"errors\": {}\n }\n}" }, { "name": "| Reply Code | Message | Description |\n|--|--|--|\n| 2010 | More contacts found with the external ID: `field_id` – `value` | More than one contact with the provided key field value exists in the database. A unique external key must be provided. Please note", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"contact_list_id\": 53193191,\n \"key_id\": -11445387,\n \"contacts\": [\n {\n \"2\": \"laboris mollit\",\n \"3\": \"aliquip fugiat aliqua adipisicing\"\n },\n {\n \"2\": \"do\",\n \"3\": \"mollit minim\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/contact/?create_if_not_exists=0", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contact", "" ], "query": [ { "key": "create_if_not_exists", "value": "0" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"contact_list_id\": 53193191,\n \"key_id\": -11445387,\n \"contacts\": [\n {\n \"2\": \"laboris mollit\",\n \"3\": \"aliquip fugiat aliqua adipisicing\"\n },\n {\n \"2\": \"do\",\n \"3\": \"mollit minim\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/contact/?create_if_not_exists=0", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contact", "" ], "query": [ { "key": "create_if_not_exists", "value": "0" } ] } }, "code": 2020, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 33430804,\n \"replyText\": \"adipisicing sunt eiusmod\",\n \"data\": \"voluptate enim\"\n}" } ] }, { "name": "Get Contact Data", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"contact_list_id\": 49809834,\n \"keyId\": 94011517,\n \"keyValues\": [\n \"sunt cillu\",\n \"aliqua ad sint eu\"\n ],\n \"fields\": [\n \"cupidatat consequat\",\n \"Ut qui dolor in\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/getdata", "description": "Returns the field values of the contacts specified by either their internal identifiers or by a custom property.\n\nIt is recommended to use the `id` or `uid` fields to identify contacts in order to avoid conflicts when using a non-unique field, such as `email`.\n\nFor details about customer identifiers and properties, see [Concepts](docs/before-you-start/concepts.md).\n\n**Note:** The maximum number of objects per request is 1000.\n\n>When a contact is not found, the reply code is still `200`. The reply text makes this clear by the message: **No contact found**.\n>\n>If all contact identifiers given in a call fail to parse, the result will be ``false`` and **not** an array. Possible reasons for the ``false`` result:\n>- incorrect contact ``id`` or ``key`` format \n>- typo\n>- contact ``id`` does not exist in the database\n\n\n" }, "response": [ { "name": "This is an OK response.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"contact_list_id\": 9102226,\n \"keyId\": -9859689,\n \"keyValues\": [\n \"velit ipsum consequat\",\n \"culpa velit\"\n ],\n \"fields\": [\n \"ex eu\",\n \"ut quis Excepteur\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/getdata" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -1860305,\n \"replyText\": \"nulla amet\",\n \"data\": {\n \"result\": [\n {\n \"id\": 62790628,\n \"uid\": \"tempor mollit\",\n \"032394\": \"magna quis\"\n },\n {\n \"id\": 30183035,\n \"uid\": \"cupidatat consectetur dolor s\",\n \"42978991816\": \"proident esse cillum exercitation\"\n }\n ]\n }\n}" } ] }, { "name": "Merge Contacts", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"contact_list_id\": 78,\n \"key_id\": \"3\",\n \"source_key_value\": \"source@email.com\",\n \"target_key_value\": \"target@email.com\",\n \"merge_rules\": {\n \"1\": \"overwrite\",\n \"2\": \"overwrite\"\n },\n \"delete_source\": false\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/merge", "description": "Merges two existing contacts specified by any contact field. For details on contact identifiers and fields, see [Concepts](docs/before-you-start/concepts.md).\n\n**Note:** Due to limitations of API specification languages, dynamic keys are indicated by curly brackets or by a regex pattern." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"contact_list_id\": 78,\n \"key_id\": \"3\",\n \"source_key_value\": \"source@email.com\",\n \"target_key_value\": \"target@email.com\",\n \"merge_rules\": {\n \"1\": \"overwrite\",\n \"2\": \"overwrite\"\n },\n \"delete_source\": false\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/merge" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"contact_list_id\": 78,\n \"key_id\": \"3\",\n \"source_key_value\": \"source@email.com\",\n \"target_key_value\": \"target@email.com\",\n \"merge_rules\": {\n \"1\": \"overwrite\",\n \"2\": \"overwrite\"\n },\n \"delete_source\": false\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/merge" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"contact_list_id\": 78,\n \"key_id\": \"3\",\n \"source_key_value\": \"source@email.com\",\n \"target_key_value\": \"target@email.com\",\n \"merge_rules\": {\n \"1\": \"overwrite\",\n \"2\": \"overwrite\"\n },\n \"delete_source\": false\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/merge" }, "code": 2020, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 33430804,\n \"replyText\": \"adipisicing sunt eiusmod\",\n \"data\": \"voluptate enim\"\n}" } ] }, { "name": "Delete Contacts", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"{keyFieldIdentifier}\": [\n \"in nulla\",\n \"veniam non\"\n ],\n \"contact_list_id\": 85347089,\n \"key_id\": -56482251\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/delete", "description": "Deletes a single or multiple contacts. If the provided identifier is not unique (such as email or custom field value), duplicate contacts are not deleted.\n\nThe maximum **batch** size is 1000 contacts per call.\n\n**Important:** This action cannot be reverted, and removes all existing data associated with the contact. To *unsubscribe* contacts, set their opt-in status to *false* instead.\n\n**Note:** Due to limitations of API specification languages, dynamic keys are indicated by curly brackets or by a regex pattern." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"{keyFieldIdentifier}\": [\n \"tempor ipsum\",\n \"laboris aute aliquip\"\n ],\n \"contact_list_id\": 76672679,\n \"key_id\": 39341700\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/delete" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"ea proident elit\",\n \"data\": {\n \"errors\": {}\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"{keyFieldIdentifier}\": [\n \"tempor ipsum\",\n \"laboris aute aliquip\"\n ],\n \"contact_list_id\": 76672679,\n \"key_id\": 39341700\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/delete" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"{keyFieldIdentifier}\": [\n \"tempor ipsum\",\n \"laboris aute aliquip\"\n ],\n \"contact_list_id\": 76672679,\n \"key_id\": 39341700\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/delete" }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"{keyFieldIdentifier}\": [\n \"tempor ipsum\",\n \"laboris aute aliquip\"\n ],\n \"contact_list_id\": 76672679,\n \"key_id\": 39341700\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/delete" }, "code": 2020, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 33430804,\n \"replyText\": \"adipisicing sunt eiusmod\",\n \"data\": \"voluptate enim\"\n}" } ] }, { "name": "Verify Internal Contact Identifiers", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"exercitation\",\n \"external_ids\": [],\n \"contact_list_id\": -30989885,\n \"get_multiple_ids\": false\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/checkids", "description": "Generates a list of existing contacts and errors indexed by the specified key identifier.\n\nFor details about contact identifiers, see [Concepts](docs/before-you-start/concepts.md).\n\nErrors are collected in the following cases:\n- The provided key identifier is invalid\n- No contact is found\n- More than one contact is found with the same key value" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"nisi\",\n \"external_ids\": [],\n \"contact_list_id\": 19588762,\n \"get_multiple_ids\": false\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/checkids" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -65412171,\n \"replyText\": \"elit mollit\",\n \"data\": {\n \"ids\": {},\n \"errors\": {}\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"nisi\",\n \"external_ids\": [],\n \"contact_list_id\": 19588762,\n \"get_multiple_ids\": false\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/checkids" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"nisi\",\n \"external_ids\": [],\n \"contact_list_id\": 19588762,\n \"get_multiple_ids\": false\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/checkids" }, "code": 2020, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 33430804,\n \"replyText\": \"adipisicing sunt eiusmod\",\n \"data\": \"voluptate enim\"\n}" } ] }, { "name": "Get Contact Email History", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"contact_list_id\": 46714,\n \"startDate\": \"2014-11-05\",\n \"endDate\": \"2014-11-05\",\n \"contacts\": [\n 176415518,\n 749678081\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/getcontacthistory", "description": "Returns a list of email campaign launch data for the specified contacts in the specified timeframe (optional).\n\n**Note**: The email campaigns whose launch list details have already been archived (after approx. 30 days), will not be part of the result. For these campaigns, the launch list has to be manually generated in the platform UI by clicking any of the blue lines on the reporting screen. The data are restored for one day, during which they are available to query with the API." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"contact_list_id\": 46714,\n \"startDate\": \"2014-11-05\",\n \"endDate\": \"2014-11-05\",\n \"contacts\": [\n 176415518,\n 749678081\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/getcontacthistory" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -10123120,\n \"replyText\": \"minim cillum Ut et enim\",\n \"data\": [\n {\n \"emailId\": -48036654,\n \"contactId\": -40424316,\n \"launch_date\": \"magna quis\",\n \"delivery_status\": \"canceled\",\n \"bounce_status\": \"nulla exercitation dolore irure\"\n },\n {\n \"emailId\": 32457710,\n \"contactId\": -5917557,\n \"launch_date\": \"quis ut\",\n \"delivery_status\": \"canceled\",\n \"bounce_status\": \"id sit i\"\n }\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"contact_list_id\": 46714,\n \"startDate\": \"2014-11-05\",\n \"endDate\": \"2014-11-05\",\n \"contacts\": [\n 176415518,\n 749678081\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/getcontacthistory" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"contact_list_id\": 46714,\n \"startDate\": \"2014-11-05\",\n \"endDate\": \"2014-11-05\",\n \"contacts\": [\n 176415518,\n 749678081\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/getcontacthistory" }, "code": 2020, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 33430804,\n \"replyText\": \"adipisicing sunt eiusmod\",\n \"data\": \"voluptate enim\"\n}" } ] }, { "name": "Query Field Changes", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": 38019978,\n \"keyValues\": [\n \"nostrud fugiat\",\n \"elit eiusmod occaecat\"\n ],\n \"fieldId\": -99582809\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/last_change", "description": "Returns information about the latest change of the specified fields, inclucing the change timestamp, as well as the old and the current values." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": 52874921,\n \"keyValues\": [\n \"consequat\",\n \"sit elit amet\"\n ],\n \"fieldId\": -46253818\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/last_change" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 19649770,\n \"replyText\": \"ut sit l\",\n \"data\": {\n \"result\": {\n \"Cu5\": {\n \"old_value\": 38840293,\n \"current_value\": 11869481,\n \"time\": \"sit d\"\n }\n }\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"keyId\": 52874921,\n \"keyValues\": [\n \"consequat\",\n \"sit elit amet\"\n ],\n \"fieldId\": -46253818\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/last_change" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Export Updated Contacts", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"distribution_method\": \"local\",\n \"origin\": \"api\",\n \"origin_id\": 0,\n \"time_range\": [\n \"esse nostrud dolor officia\",\n \"ad officia dolor irure dolore\"\n ],\n \"contact_fields\": [\n 95643797\n ],\n \"delimiter\": \",\",\n \"add_field_names_header\": 1,\n \"language\": \"gi\",\n \"ftp_settings\": {\n \"host\": \"http://MiMMYzMIw.ckGiBNw7j27pt\",\n \"port\": \"adipisicing dolor\",\n \"username\": \"laboru\",\n \"password\": \"quis deserunt\",\n \"folder\": \"minim laboris aliqua quis\"\n },\n \"notification_url\": \"http://sQjizuCHKUTBFywwdcOT.ysvP3bXlVTSy06qlCRrwgRX8IasM5RQC-wprJ5.mpJg0fxj\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/getchanges", "description": "Exports the specified fields of contacts that have been modified within a certain time period. The changes must come from the specified form or API source to be included.\n\n**Important:** Contacts that were updated through contact imports or via the [Create contacts](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4MDc-create-contacts) or [Update contacts](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4MTE-update-contacts) endpoint get exported only if their email address or opt-in status were updated.\n\n| SOURCE | |UPDATED FIELDS | | \n| --- | --- | --- | --- |\n| | **Email address** | **Opt-in status** | **Other** | \n| **Forms (`register.php`)** | contact exported | contact exported | contact exported |\n| **API: [Contact update](reference/openapi.json/paths/~1v2~1contact~1/put)** | contact exported | contact exported | contact exported |\n| **[Data import](https://help.emarsys.com/hc/en-us/articles/360013356254-Overview-Data-Import-Overview)** | contact **not** exported | contact **not** exported | contact **not** exported |\n\n**Important:** \n\nThe results are saved as a CSV file that you can access in multiple ways.\n- Exports flagged as `local` are stored on the Emarsys server that you can download via WebDAV or an API call.\n- Exports flagged as `ftp` can be accessed via FTP.\n\n**Implementation**\n\n You can implement this method as follows:\n -Poll the [Check Export Status](reference/openapi.json/paths/~1v2~1export~1{exportId}/get) endpoint to track the export status. When done, access the file at the [Download Export Data](reference/openapi.json/paths/~1v2~1export~1{exportId}~1data/get) endpoint.\n- Set the `notification_url` parameter to implement a callback mechanism. When the export is ready, a request is sent to the provided URL with the same payload as the [Check Export Status](reference/openapi.json/paths/~1v2~1export~1{exportId}/get) response. Failures are retried 5 times, with a one-minute wait between each try.\n\n\n**Notes**\n- As we are using a proxy for FTP traffic, it is not necessary to whitelist any IPs on our side.\n- WebDAV access must be enabled first, and requires authentication to use. For a WebDAV account or (S)FTP access, contact Emarsys support.\n\n**Example**\n```csv\nuser_id;First Name;Last Name;E-Mail;Company\n8019189;user3;test_import;test1@emarsys.com;\n49036141;user3;test_import;test1@emarsys.com;\n50123406;user3;test_import;test1@emarsys.com;\n85600590;user3;test_import;test1@emarsys.com;\n```" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"distribution_method\": \"ftp\",\n \"origin\": \"all\",\n \"origin_id\": 0,\n \"time_range\": [\n \"sit ut\",\n \"eu cillum\"\n ],\n \"contact_fields\": [\n -51391267\n ],\n \"delimiter\": \",\",\n \"add_field_names_header\": 1,\n \"language\": \"jt\",\n \"ftp_settings\": {\n \"host\": \"https://yzroHNbLLGJVPJgxmYWviKdAEZtSjXiw.aftrxZWONyeNwjVRr+9AOVrHSI-tr7u5\",\n \"port\": \"enim voluptate\",\n \"username\": \"voluptate mollit culpa cupidatat est\",\n \"password\": \"laborum ipsum id ea mollit\",\n \"folder\": \"sint pariatur nisi\"\n },\n \"notification_url\": \"http://NsuglXNaaqHNPUdsvuWJhInsmqsyrHsE.txiEfL1TQrBaZocTxJqkC+tYfCb,5iJJNOQgrcfKML3XBqcni\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/getchanges" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -76482165,\n \"replyText\": \"nostrud enim proident adipisicing\",\n \"data\": {\n \"id\": 98938000\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"distribution_method\": \"ftp\",\n \"origin\": \"all\",\n \"origin_id\": 0,\n \"time_range\": [\n \"sit ut\",\n \"eu cillum\"\n ],\n \"contact_fields\": [\n -51391267\n ],\n \"delimiter\": \",\",\n \"add_field_names_header\": 1,\n \"language\": \"jt\",\n \"ftp_settings\": {\n \"host\": \"https://yzroHNbLLGJVPJgxmYWviKdAEZtSjXiw.aftrxZWONyeNwjVRr+9AOVrHSI-tr7u5\",\n \"port\": \"enim voluptate\",\n \"username\": \"voluptate mollit culpa cupidatat est\",\n \"password\": \"laborum ipsum id ea mollit\",\n \"folder\": \"sint pariatur nisi\"\n },\n \"notification_url\": \"http://NsuglXNaaqHNPUdsvuWJhInsmqsyrHsE.txiEfL1TQrBaZocTxJqkC+tYfCb,5iJJNOQgrcfKML3XBqcni\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/getchanges" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Export Contact Registrations", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"distribution_method\": \"local\",\n \"time_range\": [\n \"2889-66-32\",\n \"9777-07-98\"\n ],\n \"contact_fields\": [\n 72768622\n ],\n \"contactlist\": -74171490,\n \"with_timestamp\": 1,\n \"delimiter\": \",\",\n \"add_field_names_header\": 1,\n \"language\": \"kt\",\n \"ftp_settings\": {\n \"host\": \"consectetur tempor aliqua magna\",\n \"port\": \"in reprehenderit commodo exercitation fugiat\",\n \"username\": \"eiusmod ad in dolore sed\",\n \"password\": \"eu pariatur do sunt\",\n \"folder\": \"sint nostrud\"\n },\n \"notification_url\": \"culpa ipsum id esse\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/getregistrations", "description": "Exports the specified fields of contacts registered through an Emarsys form within the specified time period as a CSV file.\n\n**Tip:** If you want to export registrations from other sources, use the [Export Updated Contacts](/reference/openapi.json/paths/~1v2~1contact~1getchanges/post) endpoint.\n\n\n**Important:** \n\nThe results are saved as a CSV file that you can access in multiple ways.\n- Exports flagged as `local` are stored on the Emarsys server that you can download via WebDAV or an API call.\n- Exports flagged as `ftp` can be accessed via FTP.\n\n**Implementation**\n\nou can implement this method as follows:\n- Poll the [Check Export Status](/reference/openapi.json/paths/~1v2~1export~1{exportId}/get) endpoint to track the export status. When done, access the file at the [Download Export Data](/reference/openapi.json/paths/~1v2~1export~1{exportId}~1data/get) endpoint.\n- Set the `notification_url` parameter to implement a callback mechanism. When the export is ready, a request is sent to the provided URL with the same payload as the [Check Export Status](/reference/openapi.json/paths/~1v2~1export~1{exportId}/get) response. Failures are retried 5 times, with a one-minute wait between each try.\n\n**Notes**\n- As we are using a proxy for FTP traffic, it is not necessary to whitelist any IPs on our side.\n- WebDAV access must be enabled first, and requires authentication to use. For a WebDAV account or (S)FTP access, contact Emarsys support.\n\n**Example**\n```csv\nuser_id;First Name;Last Name;E-Mail;Company;last update\n135369573;user3;test_import;test1@emarsys.com;;\n171879718;user3;test_import;test1@emarsys.com;;\n183453150;user3;test_import;test1@emarsys.com;;\n188925627;user3;test_import;test1@emarsys.com;;\n```" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"distribution_method\": \"local\",\n \"time_range\": [\n \"2889-66-32\",\n \"9777-07-98\"\n ],\n \"contact_fields\": [\n 72768622\n ],\n \"contactlist\": -74171490,\n \"with_timestamp\": 1,\n \"delimiter\": \",\",\n \"add_field_names_header\": 1,\n \"language\": \"kt\",\n \"ftp_settings\": {\n \"host\": \"consectetur tempor aliqua magna\",\n \"port\": \"in reprehenderit commodo exercitation fugiat\",\n \"username\": \"eiusmod ad in dolore sed\",\n \"password\": \"eu pariatur do sunt\",\n \"folder\": \"sint nostrud\"\n },\n \"notification_url\": \"culpa ipsum id esse\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/getregistrations" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -76482165,\n \"replyText\": \"nostrud enim proident adipisicing\",\n \"data\": {\n \"id\": 98938000\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"distribution_method\": \"local\",\n \"time_range\": [\n \"2889-66-32\",\n \"9777-07-98\"\n ],\n \"contact_fields\": [\n 72768622\n ],\n \"contactlist\": -74171490,\n \"with_timestamp\": 1,\n \"delimiter\": \",\",\n \"add_field_names_header\": 1,\n \"language\": \"kt\",\n \"ftp_settings\": {\n \"host\": \"consectetur tempor aliqua magna\",\n \"port\": \"in reprehenderit commodo exercitation fugiat\",\n \"username\": \"eiusmod ad in dolore sed\",\n \"password\": \"eu pariatur do sunt\",\n \"folder\": \"sint nostrud\"\n },\n \"notification_url\": \"culpa ipsum id esse\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contact/getregistrations" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "Contact list", "item": [ { "name": "{list Id}", "item": [ { "name": "contacts", "item": [ { "name": "Look Up Contacts in a Contact List", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"sunt labore\",\n \"nostrud\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/contacts/", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "contacts", "" ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] }, "description": "Looks up contacts in the specified contact list." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/contacts/", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "contacts", "" ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -76204122,\n \"replyText\": \"pariatur eu\",\n \"data\": [\n false,\n true\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/contacts/", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "contacts", "" ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Get Contact Data in a Contact List", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/contacts/data?fields=laborum amet&limit=1000000&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "contacts", "data" ], "query": [ { "key": "fields", "value": "laborum amet", "description": "(Required) Specifies the fields by identifier or name to include in the returned result.\n\nMultiple fields must be separated by a comma. For example `1,2,3` or `email,first_name`." }, { "key": "limit", "value": "1000000", "description": "Specifies the maximum number of records to return." }, { "key": "offset", "value": "0", "description": "Specifies an offset for pagination. The offset of the first record is *0*." } ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] }, "description": "Returns the data of the specified contacts in a contact list." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/contacts/data?fields=laborum amet&limit=1000000&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "contacts", "data" ], "query": [ { "key": "fields", "value": "laborum amet" }, { "key": "limit", "value": "1000000" }, { "key": "offset", "value": "0" } ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 30130453,\n \"replyText\": \"commodo\",\n \"data\": {\n \"3473\": {\n \"fields\": {\n \"4\": \"Lorem dolor\",\n \"id\": \"dolore velit ali\",\n \"uid\": \"culpa mollit\"\n }\n }\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/contacts/data?fields=laborum amet&limit=1000000&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "contacts", "data" ], "query": [ { "key": "fields", "value": "laborum amet" }, { "key": "limit", "value": "1000000" }, { "key": "offset", "value": "0" } ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/contacts/data?fields=laborum amet&limit=1000000&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "contacts", "data" ], "query": [ { "key": "fields", "value": "laborum amet" }, { "key": "limit", "value": "1000000" }, { "key": "offset", "value": "0" } ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "List Contacts in a Contact List", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/?offset=0&limit=1000000", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "" ], "query": [ { "key": "offset", "value": "0", "description": "Specifies an offset for pagination. The offset of the first record is *0*." }, { "key": "limit", "value": "1000000", "description": "Specifies the maximum number of records to return." } ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] }, "description": "Returns a list of contacts and their identifiers (`id`) in a contact list.\n\n**Example**\n\nhttps://api.emarsys.net/api/v2/contactlist/123456789/?limit=100000&offset=0" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/?offset=0&limit=1000000", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "" ], "query": [ { "key": "offset", "value": "0" }, { "key": "limit", "value": "1000000" } ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 94944175,\n \"replyText\": \"ipsum aliquip veni\",\n \"data\": [\n \"et mini\",\n \"consequat elit commodo labore in\"\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/?offset=0&limit=1000000", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "" ], "query": [ { "key": "offset", "value": "0" }, { "key": "limit", "value": "1000000" } ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Rename a Contact List", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"blade\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/rename", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "rename" ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] }, "description": "Renames an existing contact list." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"blade\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/rename", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "rename" ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -18352588,\n \"replyText\": \"velit dolor sed sint qui\",\n \"data\": {\n \"id\": 79541000,\n \"name\": \"\"\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"blade\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/rename", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "rename" ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"blade\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/rename", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "rename" ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Replace a Contact List", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"in d\",\n \"external_ids\": 16604934\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/replace", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "replace" ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] }, "description": "Overwrites an existing contact list." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"in d\",\n \"external_ids\": 16604934\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/replace", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "replace" ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 73203898,\n \"replyText\": \"consequat et\",\n \"data\": {\n \"inserted_contacts\": -58062770,\n \"errors\": {\n \"loki@example.com\": {\n \"2008\": \"ut dolore adipisicing\"\n }\n }\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"in d\",\n \"external_ids\": 16604934\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/replace", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "replace" ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Delete a Contact List", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/deletelist", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "deletelist" ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] }, "description": "Deletes a contact list.\n\n**Note:** Contacts in the list are not affected.\n\n**Warning:** If a contact list is used in a combined segment, you cannot delete it (error ``400``, reply ``3008``)." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/deletelist", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "deletelist" ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/deletelist", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "deletelist" ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/deletelist", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "deletelist" ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Add Contacts to a Contact List", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"laborum quis velit\",\n \"external_ids\": 18781864\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/add", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "add" ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] }, "description": "Adds new contacts to an existing contact list." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"laborum quis velit\",\n \"external_ids\": 18781864\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/add", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "add" ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -51267031,\n \"replyText\": \"voluptate occaecat commodo\",\n \"data\": {\n \"inserted_contacts\": -43294655,\n \"errors\": {}\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"laborum quis velit\",\n \"external_ids\": 18781864\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/add", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "add" ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Count Contacts in a Contact List", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/count", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "count" ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] }, "description": "Returns the number of contacts in a contact list." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/count", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "count" ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -27484401,\n \"replyText\": \"mollit magna\",\n \"data\": -52615894\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/count", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "count" ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Remove Contacts from a Contact List", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"amet reprehenderit culpa et\",\n \"external_ids\": 59184216\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "delete" ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] }, "description": "Removes contacts from an existing contact list.\n\n**Note:** At most 10,000 contacts can be deleted with each request." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"amet reprehenderit culpa et\",\n \"external_ids\": 59184216\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "delete" ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -22239740,\n \"replyText\": \"ut cupidatat\",\n \"data\": {\n \"deleted_contacts\": 49866206,\n \"errors\": {}\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"amet reprehenderit culpa et\",\n \"external_ids\": 59184216\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/contactlist/:listId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "contactlist", ":listId", "delete" ], "variable": [ { "key": "listId", "value": "81739474", "description": "(Required) The contact list identifier." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "Create a Contact List", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"sint\",\n \"name\": \"deserunt velit aliqua mollit\",\n \"external_ids\": -33489977,\n \"description\": \"irure\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contactlist", "description": "The optional parameter `contactlist_id` is for **creating** or **updating** contact lists. It is usable in both single and batch calls. Each user in the batch is added to the same contact list. Otherwise the batch behaviour is identical with a single call.\n\nBatch call example:\n\n```\n{\n\"contact_list_id\":\"12345678\",\n\"key_id\":\"....\",\n\"contacts\":\n[\n { ... },\n { ... }\n]\n}\n\n```" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"sint\",\n \"name\": \"deserunt velit aliqua mollit\",\n \"external_ids\": -33489977,\n \"description\": \"irure\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contactlist" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -91853340,\n \"replyText\": \"tempor aliquip\",\n \"data\": {\n \"id\": -20187448,\n \"errors\": {}\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"sint\",\n \"name\": \"deserunt velit aliqua mollit\",\n \"external_ids\": -33489977,\n \"description\": \"irure\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/contactlist" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "List Contact Lists", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/v2/contactlist", "description": "Returns a list of the available contact lists." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/contactlist" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 3248970,\n \"replyText\": \"nisi\",\n \"data\": [\n {\n \"id\": \"reprehenderit culpa proident consectetur\",\n \"name\": \"quis nostrud minim ut aute\"\n },\n {\n \"id\": \"consequat dolore quis sed\",\n \"name\": \"ea consectetur in\"\n }\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/contactlist" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "Email", "item": [ { "name": "{email Id}", "item": [ { "name": "trackedlinks", "item": [ { "name": "Create a Tracked Link in an Email Campaign", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"section_id\": 1,\n \"url\": \"http://example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/trackedlinks", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "trackedlinks" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] }, "description": "Creates a tracked link in the specified section of an email campaign.\n\n**Note:** Only template-based email campaigns have sections. The section identifier (`section_id`)of batch email campaigns is *1*." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"section_id\": 1,\n \"url\": \"http://example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/trackedlinks", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "trackedlinks" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 98416694,\n \"replyText\": \"culpa ullamco\",\n \"data\": {\n \"id\": -47212410,\n \"section_id\": 76834618,\n \"url\": \"https://g.ecjEVY4WacEH7HgObzovmNe+tVlCX-b\"\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"section_id\": 1,\n \"url\": \"http://example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/trackedlinks", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "trackedlinks" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "List Tracked Links in an Email Campaign", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/trackedlinks/:relativeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "trackedlinks", ":relativeId" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." }, { "key": "relativeId", "value": "81739474", "description": "(Required) If provided, returns the data of a specific tracked link." } ] }, "description": "Returns a list of all tracked links of an email campaign." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/trackedlinks/:relativeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "trackedlinks", ":relativeId" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." }, { "key": "relativeId", "value": "81739474", "description": "(Required) If provided, returns the data of a specific tracked link." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -84519799,\n \"replyText\": \"culpa voluptate pariatur sit proident\",\n \"data\": [\n {\n \"id\": 98473828,\n \"section_id\": 46902806,\n \"url\": \"http://JksufnkNDzhQJSEuFqA.ptaz,Ua6r3iJUvioLuA59bK,0lOlCJmXEVTuZYZ3mi1yBOAvXiJf2v6xXwsDOb8h7,vfzw\"\n },\n {\n \"id\": -42233589,\n \"section_id\": -36464253,\n \"url\": \"https://YWxaVfZYNwfvPbYRjU.tngShYB4sOnxWXXcJkkqGc.lpUVKGST6hl\"\n }\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/trackedlinks/:relativeId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "trackedlinks", ":relativeId" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." }, { "key": "relativeId", "value": "81739474", "description": "(Required) If provided, returns the data of a specific tracked link." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Update a Tracked Link in an Email Campaign", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"http://example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/trackedlinks/:linkId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "trackedlinks", ":linkId" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." }, { "key": "linkId", "value": "81739474", "description": "(Required) The tracked link identifier." } ] }, "description": "Updates the URL parameter of a tracked link in an email campaign.\n\n**Note:** Template-based campaigns require that you update the section as well as the tracked link, as the link is also stored in the section." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"http://example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/trackedlinks/:linkId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "trackedlinks", ":linkId" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." }, { "key": "linkId", "value": "81739474", "description": "(Required) The tracked link identifier." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 69412134,\n \"replyText\": \"id incididunt e\",\n \"data\": {\n \"id\": 10370317,\n \"section_id\": 83333195,\n \"url\": \"https://FfEbUXmSHrQgLZ.kcPt6CKZ7N\"\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"http://example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/trackedlinks/:linkId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "trackedlinks", ":linkId" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." }, { "key": "linkId", "value": "81739474", "description": "(Required) The tracked link identifier." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "sections", "item": [ { "name": "{section Id}", "item": [ { "name": "Get a Section of a Template-based Email Campaign", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/sections/:sectionId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "sections", ":sectionId" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." }, { "key": "sectionId", "value": "81739474", "description": "(Required) The identifier of the section." } ] }, "description": "Returns the details of a section of a template-based email campaign." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/sections/:sectionId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "sections", ":sectionId" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." }, { "key": "sectionId", "value": "81739474", "description": "(Required) The identifier of the section." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 12329569,\n \"replyText\": \"consequat in eu magna\",\n \"data\": {\n \"id\": -67385717,\n \"order\": 1,\n \"group_id\": 87103347,\n \"hide_on_mobile\": true,\n \"header_source\": \"nostrud aliquip incididunt cupidatat ut\",\n \"header_align\": \"center\",\n \"body_source\": \"Duis mollit qui\",\n \"image_url\": \"http://GTLzzWsJsjp.cxI6OA4dz,XL8-I6VZdwkF0mOU,o\",\n \"image_title\": \"dolor eu nostrud\",\n \"image_link\": \"http://eQxnqGSOdHAIDpMXBSbkDICfOytKQgFu.twmgoAsrRcNors.IYnbV\",\n \"image_align\": \"right\",\n \"image_width\": 76795723,\n \"image_height\": -59499541,\n \"image_hide_on_mobile\": false,\n \"image_mobile\": \"esse qui ex veniam\",\n \"image_mobile_name\": \"officia culpa\",\n \"link_url\": \"http://AJTljvwVI.gbzYp7kKG2A4lp2l7yWMvFtXImm5OtPWysyNNmcWrfgVDAm2sgHppcTHZgi8TxS0tDelZqWj2\",\n \"link_title\": \"cupidatat in ex velit\",\n \"is_image_linked\": true,\n \"is_header_linked\": true,\n \"link_description\": \"anim aliqua\",\n \"form_id\": 33096809,\n \"form_title\": \"sit deserunt ut incididunt\",\n \"target_audience\": \"all\",\n \"use_social_network\": 12616911,\n \"enable_network_sharing\": true,\n \"advanced_html_source\": \"qui Duis\",\n \"advanced_text_source\": \"nisi officia in\",\n \"target_audience_segment_id\": -51404591\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/sections/:sectionId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "sections", ":sectionId" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." }, { "key": "sectionId", "value": "81739474", "description": "(Required) The identifier of the section." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Update a Section of a Template-based Email Campaign", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"replyCode\": 0,\n \"replyText\": \"OK\",\n \"data\": {\n \"id\": 4,\n \"order\": 2,\n \"group_id\": 111111111,\n \"hide_on_mobile\": true,\n \"header_source\": \"example\",\n \"header_align\": \"left\",\n \"body_source\": \"example\",\n \"image_url\": \"https://example.com/image_placeholder.php?a\",\n \"image_title\": \"\",\n \"image_link\": \"https://example.com/image.png\",\n \"image_align\": \"right\",\n \"image_width\": null,\n \"image_height\": null,\n \"image_hide_on_mobile\": false,\n \"image_mobile\": \"\",\n \"image_mobile_name\": \"\",\n \"link_url\": \"https://example.com/redirect\",\n \"link_title\": \"Link to more\",\n \"is_image_linked\": true,\n \"is_header_linked\": true,\n \"link_description\": \"\",\n \"form_id\": 0,\n \"form_title\": \"\",\n \"target_audience\": \"segment\",\n \"use_social_network\": \"0\",\n \"enable_network_sharing\": false,\n \"advanced_html_source\": \"\",\n \"advanced_text_source\": \"\",\n \"target_audience_segment_id\": 111111111\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/sections/:sectionId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "sections", ":sectionId" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." }, { "key": "sectionId", "value": "81739474", "description": "(Required) The identifier of the section." } ] }, "description": "Updates a content section of a template-based email campaign using the specified parameters." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"replyCode\": 0,\n \"replyText\": \"OK\",\n \"data\": {\n \"id\": 4,\n \"order\": 2,\n \"group_id\": 111111111,\n \"hide_on_mobile\": true,\n \"header_source\": \"example\",\n \"header_align\": \"left\",\n \"body_source\": \"example\",\n \"image_url\": \"https://example.com/image_placeholder.php?a\",\n \"image_title\": \"\",\n \"image_link\": \"https://example.com/image.png\",\n \"image_align\": \"right\",\n \"image_width\": null,\n \"image_height\": null,\n \"image_hide_on_mobile\": false,\n \"image_mobile\": \"\",\n \"image_mobile_name\": \"\",\n \"link_url\": \"https://example.com/redirect\",\n \"link_title\": \"Link to more\",\n \"is_image_linked\": true,\n \"is_header_linked\": true,\n \"link_description\": \"\",\n \"form_id\": 0,\n \"form_title\": \"\",\n \"target_audience\": \"segment\",\n \"use_social_network\": \"0\",\n \"enable_network_sharing\": false,\n \"advanced_html_source\": \"\",\n \"advanced_text_source\": \"\",\n \"target_audience_segment_id\": 111111111\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/sections/:sectionId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "sections", ":sectionId" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." }, { "key": "sectionId", "value": "81739474", "description": "(Required) The identifier of the section." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"replyCode\": 0,\n \"replyText\": \"OK\",\n \"data\": {\n \"id\": 4,\n \"order\": 2,\n \"group_id\": 111111111,\n \"hide_on_mobile\": true,\n \"header_source\": \"example\",\n \"header_align\": \"left\",\n \"body_source\": \"example\",\n \"image_url\": \"https://example.com/image_placeholder.php?a\",\n \"image_title\": \"\",\n \"image_link\": \"https://example.com/image.png\",\n \"image_align\": \"right\",\n \"image_width\": null,\n \"image_height\": null,\n \"image_hide_on_mobile\": false,\n \"image_mobile\": \"\",\n \"image_mobile_name\": \"\",\n \"link_url\": \"https://example.com/redirect\",\n \"link_title\": \"Link to more\",\n \"is_image_linked\": true,\n \"is_header_linked\": true,\n \"link_description\": \"\",\n \"form_id\": 0,\n \"form_title\": \"\",\n \"target_audience\": \"segment\",\n \"use_social_network\": \"0\",\n \"enable_network_sharing\": false,\n \"advanced_html_source\": \"\",\n \"advanced_text_source\": \"\",\n \"target_audience_segment_id\": 111111111\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/sections/:sectionId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "sections", ":sectionId" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." }, { "key": "sectionId", "value": "81739474", "description": "(Required) The identifier of the section." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Delete a Section from a Template-based Email Campaign", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/sections/:sectionId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "sections", ":sectionId", "delete" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." }, { "key": "sectionId", "value": "81739474", "description": "(Required) The section identifier." } ] }, "description": "Deletes a section from a template-based email campaign." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/sections/:sectionId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "sections", ":sectionId", "delete" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." }, { "key": "sectionId", "value": "81739474", "description": "(Required) The section identifier." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/sections/:sectionId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "sections", ":sectionId", "delete" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." }, { "key": "sectionId", "value": "81739474", "description": "(Required) The section identifier." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "Create a Section in a Template-based Email Campaign", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"replyCode\": 0,\n \"replyText\": \"OK\",\n \"data\": {\n \"id\": 6,\n \"order\": 1,\n \"group_id\": 111111111,\n \"hide_on_mobile\": true,\n \"header_source\": \"example\",\n \"header_align\": \"left\",\n \"body_source\": \"example\",\n \"image_url\": \"https://example.com/image_placeholder.php?a\",\n \"image_title\": \"\",\n \"image_link\": \"http://example.com/image.png\",\n \"image_align\": \"right\",\n \"image_width\": null,\n \"image_height\": null,\n \"image_hide_on_mobile\": false,\n \"image_mobile\": \"\",\n \"image_mobile_name\": \"\",\n \"link_url\": \"http://example.com\",\n \"link_title\": \"example_title\",\n \"is_image_linked\": true,\n \"is_header_linked\": true,\n \"link_description\": \"link\",\n \"form_id\": 0,\n \"form_title\": \"\",\n \"target_audience\": \"segment\",\n \"use_social_network\": \"0\",\n \"enable_network_sharing\": false,\n \"advanced_html_source\": \"\",\n \"advanced_text_source\": \"\",\n \"target_audience_segment_id\": 111111111\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/sections", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "sections" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] }, "description": "Adds a new section to a template-based email campaign with the specified parameters." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"replyCode\": 0,\n \"replyText\": \"OK\",\n \"data\": {\n \"id\": 6,\n \"order\": 1,\n \"group_id\": 111111111,\n \"hide_on_mobile\": true,\n \"header_source\": \"example\",\n \"header_align\": \"left\",\n \"body_source\": \"example\",\n \"image_url\": \"https://example.com/image_placeholder.php?a\",\n \"image_title\": \"\",\n \"image_link\": \"http://example.com/image.png\",\n \"image_align\": \"right\",\n \"image_width\": null,\n \"image_height\": null,\n \"image_hide_on_mobile\": false,\n \"image_mobile\": \"\",\n \"image_mobile_name\": \"\",\n \"link_url\": \"http://example.com\",\n \"link_title\": \"example_title\",\n \"is_image_linked\": true,\n \"is_header_linked\": true,\n \"link_description\": \"link\",\n \"form_id\": 0,\n \"form_title\": \"\",\n \"target_audience\": \"segment\",\n \"use_social_network\": \"0\",\n \"enable_network_sharing\": false,\n \"advanced_html_source\": \"\",\n \"advanced_text_source\": \"\",\n \"target_audience_segment_id\": 111111111\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/sections", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "sections" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"replyCode\": 0,\n \"replyText\": \"OK\",\n \"data\": {\n \"id\": 6,\n \"order\": 1,\n \"group_id\": 111111111,\n \"hide_on_mobile\": true,\n \"header_source\": \"example\",\n \"header_align\": \"left\",\n \"body_source\": \"example\",\n \"image_url\": \"https://example.com/image_placeholder.php?a\",\n \"image_title\": \"\",\n \"image_link\": \"http://example.com/image.png\",\n \"image_align\": \"right\",\n \"image_width\": null,\n \"image_height\": null,\n \"image_hide_on_mobile\": false,\n \"image_mobile\": \"\",\n \"image_mobile_name\": \"\",\n \"link_url\": \"http://example.com\",\n \"link_title\": \"example_title\",\n \"is_image_linked\": true,\n \"is_header_linked\": true,\n \"link_description\": \"link\",\n \"form_id\": 0,\n \"form_title\": \"\",\n \"target_audience\": \"segment\",\n \"use_social_network\": \"0\",\n \"enable_network_sharing\": false,\n \"advanced_html_source\": \"\",\n \"advanced_text_source\": \"\",\n \"target_audience_segment_id\": 111111111\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/sections", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "sections" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "List Sections in a Template-based Email Campaign", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/sections", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "sections" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] }, "description": "Returns a list of sections used in the specified template-based email campaign." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/sections", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "sections" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -86106193,\n \"replyText\": \"consectetur deserunt sed\",\n \"data\": [\n {\n \"id\": 41474765,\n \"group_id\": -55695189\n },\n {\n \"id\": -27146075,\n \"group_id\": 20326582\n }\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/sections", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "sections" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "Get Email Campaign Data", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/?raw_text=0&raw_html=0", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "" ], "query": [ { "key": "raw_text", "value": "0", "description": "Returns the actual links of the email content with the original URLs instead of the tracking URLs.\n\n**Note:** Using this parameter also affects the `html_source` and `text_source` fields in the response." }, { "key": "raw_html", "value": "0" } ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the campaign." } ] }, "description": "Returns the details of an email campaign, such as content and attributes, including personalized text and HTML source." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/?raw_text=0&raw_html=0", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "" ], "query": [ { "key": "raw_text", "value": "0" }, { "key": "raw_html", "value": "0" } ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the campaign." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 22325293,\n \"replyText\": \"ea anim\",\n \"data\": {\n \"id\": \"do officia sint labore\",\n \"language\": \"Excepteur eiusmod in\",\n \"created\": \"in sed voluptate nulla\",\n \"deleted\": \"amet exercitation\",\n \"fromemail_host\": \"external\",\n \"name\": \"irure\",\n \"status\": \"culpa anim mollit Lorem\",\n \"api_status\": \"si\",\n \"api_error\": \"cillum tempor irure eiusmod\",\n \"fromemail\": \"in consequat\",\n \"fromname\": \"eu\",\n \"subject\": \"aliqua\",\n \"email_category\": \"commodo laborum adipisicing sunt quis\",\n \"filter\": \"Excepteur exercitation ipsum\",\n \"contactlist\": \"elit proident esse\",\n \"template\": \"velit\",\n \"cc_list\": -99030208,\n \"source\": \"api\",\n \"html_source\": \"laboris anim a\",\n \"text_source\": \"Ut\",\n \"content_type\": \"ipsu\",\n \"root_campaign_id\": \"dolor deserunt in amet adipisicing\",\n \"version_name\": \"veniam laborum nostrud sit magna\",\n \"exclude_filter\": 48018151,\n \"exclude_contactlist\": -55886181,\n \"additional_linktracking_parameters\": \"dolore sunt\",\n \"unsubscribe\": 36889841,\n \"browse\": \"qui amet\",\n \"external_event_id\": -99760397,\n \"text_only\": \"dolor veniam Lorem\",\n \"features\": [\n \"incentive-recommendation\",\n \"incentive-recommendation\"\n ],\n \"campaign_types\": null,\n \"force_attachment\": true,\n \"rti_trigger\": false\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/?raw_text=0&raw_html=0", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "" ], "query": [ { "key": "raw_text", "value": "0" }, { "key": "raw_html", "value": "0" } ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the campaign." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Preview Email Campaign Contents", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"version\": \"html\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/preview", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "preview" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] }, "description": "Returns the HTML, plain text or mobile version of the email." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"version\": \"html\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/preview", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "preview" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"version\": \"html\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/preview", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "preview" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Send a Test Email", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"subject\": \"superhero_party_invitation\",\n \"recipientlist\": \"tony.stark@example.com; pepper.potts@example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/sendtestmail", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "sendtestmail" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] }, "description": "Sends a test email to the specified recipient list, segment, or contact list. Recipient list types cannot be combined.\n\n**Note:** The number of recipients must be less than 50. Additional recipients are ignored." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"subject\": \"superhero_party_invitation\",\n \"recipientlist\": \"tony.stark@example.com; pepper.potts@example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/sendtestmail", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "sendtestmail" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"subject\": \"superhero_party_invitation\",\n \"recipientlist\": \"tony.stark@example.com; pepper.potts@example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/sendtestmail", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "sendtestmail" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Launch an Email Campaign", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"emailID\": \"1234567890\",\n \"schedule\": \"2011-08-12 08:35\",\n \"timezone\": \"America/New_York\",\n \"features\": [\n \"sto\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/launch", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "launch" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] }, "description": "Initiates the launch of an existing email campaign. The actual launch takes place once the request is processed.\n\nThis endpoint launches a campaign to receipients already in the Emarsys contact database. If the contacts are not imported yet (virtual contacts), use the Launch an Email Campaign to Virtual Contacts (Broadcast) endpoint instead.\n\n**Important:** This is an asynchronous operation, and may take a couple of minutes to complete. The request initiates a background job and returns an identifier. Poll the Get Email Campaign Data endpoint to track the launch progress. Check the `api_status` and `api_error` parameters for the current status.\n\n**Tip:** Configure the recipient segment or contact list using the Create an Email Campaign endpoint.\n\n**Note:** A successful launch request may result in a failed launch, if the campaign is not properly configured. For example, a missing email subject or unspecified recipient list prevents a launch." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"schedule\": \"9318-02-86 71:93\",\n \"timezone\": \"nisi cupidatat\",\n \"features\": [\n \"sto\",\n \"sto\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/launch", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "launch" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"schedule\": \"9318-02-86 71:93\",\n \"timezone\": \"nisi cupidatat\",\n \"features\": [\n \"sto\",\n \"sto\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/launch", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "launch" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"schedule\": \"9318-02-86 71:93\",\n \"timezone\": \"nisi cupidatat\",\n \"features\": [\n \"sto\",\n \"sto\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/launch", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "launch" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Launch an Email Campaign to Virtual Contacts (Broadcast)", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"virtual@contact.com\",\n \"data\": {\n \"global\": {\n \"orderId\": \"123456789\",\n \"orderDate\": \"2019-08-07\",\n \"subject\": \"Test payload\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/broadcast", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "broadcast" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the campaign." } ] }, "description": "Launches an email campaign to contacts who are not in the Emarsys contact database (virtual contacts).\n\n**Important:** Because no personalization data is available for virtual contacts, the email address and all personalization data must be provided in the payload of the request.\n\n**Note:** You can launch a campaign to a single contact on this endpoint at a time." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"virtual@contact.com\",\n \"data\": {\n \"global\": {\n \"orderId\": \"123456789\",\n \"orderDate\": \"2019-08-07\",\n \"subject\": \"Test payload\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/broadcast", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "broadcast" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the campaign." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -53028643,\n \"replyText\": \"dolore esse non cupidatat\",\n \"data\": \"elit pariatur Excepteur ullamco\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"virtual@contact.com\",\n \"data\": {\n \"global\": {\n \"orderId\": \"123456789\",\n \"orderDate\": \"2019-08-07\",\n \"subject\": \"Test payload\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/broadcast", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "broadcast" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the campaign." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Stop an Email Campaign", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/stop", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "stop" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign.\n" } ] }, "description": "Stops an exiting email campaign, depending on its type.\n- Deactivates **triggered email campaigns**. Until the campaign is reactivated, any associated events are ignored and the campaign is not launched. For details and on-event mail stream statuses, see [Triggered Email User Guide](https://help.emarsys.com/hc/en-us/articles/115004461489-Triggered-Email-end-user-guide#the-mail-streams-list).\n- Aborts or unschedules **transactional campaigns**. Aborted campaigns cannot be rescheduled, while unscheduled ones revert to *In Design* status.\n\n**Note:** Already launched campaigns used in an Automation Center program cannot be stopped." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/stop", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "stop" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign.\n" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/stop", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "stop" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign.\n" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Get a Response Summary", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/responsesummary?launch_id=81739474&start_date=Ut pariatur adipisicing irure ut&end_date=Ut pariatur adipisicing irure ut", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "responsesummary" ], "query": [ { "key": "launch_id", "value": "81739474", "description": "The identifier of the campaign launch." }, { "key": "start_date", "value": "Ut pariatur adipisicing irure ut", "description": "Returns results from the specified date.\n\n**Accepted formats:** YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD" }, { "key": "end_date", "value": "Ut pariatur adipisicing irure ut", "description": "Returns results until the specified date.\n\n**Accepted formats:** YYYY-MM-DD HH:MM:SS, YYYY-MM-DD HH:MM, YYYY-MM-DD" } ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] }, "description": "Returns the summary of the responses of a launched, paused, activated or deactivated email campaign.\n\nAcquire the necessary contact identifiers on the [Get Email Response Metrics and Deliverability Results](/reference/openapi.json/paths/~1v2~1email~1{queryId}~1responses/get) endpoint.\n\n> **Important:** Due to limitations of API specification languages, dynamic keys are not yet supported in query strings on the interactive demo page (**Try it out**). We are working on this issue.

**Tip:** You can use the [Postman Collection](https://raw.githubusercontent.com/emartech/developer-hub-public-assets/master/resources/EmarsysV2PostmanCollection.json) to test the endpoint." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/responsesummary?launch_id=81739474&start_date=Ut pariatur adipisicing irure ut&end_date=Ut pariatur adipisicing irure ut", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "responsesummary" ], "query": [ { "key": "launch_id", "value": "81739474" }, { "key": "start_date", "value": "Ut pariatur adipisicing irure ut" }, { "key": "end_date", "value": "Ut pariatur adipisicing irure ut" } ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 72186392,\n \"replyText\": \"nisi proident et anim quis\",\n \"data\": {\n \"sent\": -72156154,\n \"planned\": -60087456,\n \"soft_bounces\": -42425714,\n \"hard_bounces\": -15584184,\n \"block_bounces\": 24573471,\n \"opened\": 60999309,\n \"unsubscribe\": 16061028,\n \"total_clicks\": 62682913,\n \"unique_clicks\": 26813409,\n \"complained\": 80000664,\n \"launches\": 60710198\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/responsesummary?launch_id=81739474&start_date=Ut pariatur adipisicing irure ut&end_date=Ut pariatur adipisicing irure ut", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "responsesummary" ], "query": [ { "key": "launch_id", "value": "81739474" }, { "key": "start_date", "value": "Ut pariatur adipisicing irure ut" }, { "key": "end_date", "value": "Ut pariatur adipisicing irure ut" } ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "List Personalization Alternate Texts", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/personalization", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "personalization" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] }, "description": "Returns the list of email personalization fields with alternative values, and shows if personalization is omitted." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/personalization", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "personalization" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -17848631,\n \"replyText\": \"do Lorem nulla nostrud\",\n \"data\": [\n {\n \"element\": -66028855,\n \"omitUser\": \"y\",\n \"defaultValue\": \"ut cupidatat magna anim Lorem\"\n },\n {\n \"element\": -13995709,\n \"omitUser\": \"n\",\n \"defaultValue\": \"aute est\"\n }\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/personalization", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "personalization" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/personalization", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "personalization" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Get the URL of a Launched Email Campaign Content", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"3\",\n \"key_value\": \"clint.barton@example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/url", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "url" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] }, "description": "Returns the URL of a launched email campaign’s content for the specified contact." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"3\",\n \"key_value\": \"clint.barton@example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/url", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "url" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -55041255,\n \"replyText\": \"laboris eiusmod dolore ex\",\n \"data\": {\n \"url\": \"ut occaecat ex\"\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"3\",\n \"key_value\": \"clint.barton@example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/url", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "url" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Update an Email Campaign Recipient Source", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"emailId\": 12345,\n \"filterId\": 0,\n \"contactlistId\": 12345678,\n \"excludeFilterId\": 0,\n \"excludeContactlistId\": 87654321\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/updatesource", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "updatesource" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] }, "description": "You must set the **Recipient source** setting to **Using the API** in the Emarsys application to assign a segment or a contact list to an email campaign using the API.\n\nThe recipient source is filtered by the specified segment or contact list. To narrow the recipient list further, provide exclusion filters.\n\n**Important:** If you do not explicitly set any exclusion filters, all existing exclusions are removed from the campaign.\n\n**Warning:** The recipient source parameter can only be changed once if the previous value was set to **Using the API**." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"emailId\": 12345,\n \"filterId\": 0,\n \"contactlistId\": 12345678,\n \"excludeFilterId\": 0,\n \"excludeContactlistId\": 87654321\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/updatesource", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "updatesource" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 18803718,\n \"replyText\": \"amet exercitation tempor\",\n \"data\": true\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"emailId\": 12345,\n \"filterId\": 0,\n \"contactlistId\": 12345678,\n \"excludeFilterId\": 0,\n \"excludeContactlistId\": 87654321\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/updatesource", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "updatesource" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Update an Email Campaign", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"emailId\": 100018233,\n \"name\": \"asgardian_email\",\n \"additional_linktracking_parameters\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/patch", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "patch" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the campaign." } ] }, "description": "Updates an email campaign with the specified parameters.\n\nEmail campaigns are locked during updates to prevent overlapping concurrent updates that may cause problems. A new update process can be started **only** after the one in progress has finished. You cannot make an update request while there is an on-going update. \n\n**Note:** Already launched campaigns cannot be modified.\n\n**Important:** This endpoint **does not** work with VCE campaigns. Updating VCE campaigns must be done through the UI." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"emailId\": 100018233,\n \"name\": \"asgardian_email\",\n \"additional_linktracking_parameters\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/patch", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "patch" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the campaign." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -17514301,\n \"replyText\": \"ipsum s\",\n \"data\": {\n \"id\": -93234612,\n \"root_email\": \"ad exercitation dolore sunt sed\",\n \"language\": \"laboris cillum\",\n \"name\": \"enim\",\n \"created\": \"ex consequat\",\n \"deleted\": \"quis consequat\",\n \"fromemail\": \"mollit i\",\n \"fromname\": \"in ipsum voluptate\",\n \"subject\": \"sit officia\",\n \"email_category\": \"Excepteur volupta\",\n \"filter\": \"exercitation aliqua\",\n \"contactlist\": \"qui ut voluptate\",\n \"additional_linktracking_parameters\": \"ipsum in\",\n \"cc_list\": -87834658,\n \"html_source\": \"cillum dolor\",\n \"text_source\": \"exercitation\",\n \"unsubscribe\": -76252651,\n \"browse\": \"sint\",\n \"status\": \"aliqua enim\",\n \"api_status\": \"irure sunt consectetur dolor\",\n \"api_error\": 34245153,\n \"text_only\": \"deserunt labore sint\",\n \"source\": \"profile\"\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"emailId\": 100018233,\n \"name\": \"asgardian_email\",\n \"additional_linktracking_parameters\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/patch", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "patch" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the campaign." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"emailId\": 100018233,\n \"name\": \"asgardian_email\",\n \"additional_linktracking_parameters\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/patch", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "patch" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the campaign." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"emailId\": 100018233,\n \"name\": \"asgardian_email\",\n \"additional_linktracking_parameters\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/patch", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "patch" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the campaign." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Version an Email Campaign", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"original_name\": \"Version A\",\n \"new_name\": \"Version B\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/version", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "version" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] }, "description": "Creates a new child version of the specified email campaign.\n\nVersioned campaigns are optimal for A/B testing, and can be manipulated as a separate email campaign through the API.\n\n**Tip:** List all versions of an email campaign with `root_campaign_id` filter on the [List email campaigns](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4Njg) endpoint." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"original_name\": \"Version A\",\n \"new_name\": \"Version B\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/version", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "version" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 43995539,\n \"replyText\": \"fugiat nulla an\",\n \"data\": -83148898\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"original_name\": \"Version A\",\n \"new_name\": \"Version B\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/version", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "version" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Finalize a Multi-language Email Campaign", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/finalize", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "finalize" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] }, "description": "During A/B testing of multi-language campaigns, two versions are sent to contacts with the same mother tongue living in the same country. Once the A/B testing is completed, finalize the email campaign using this endpoint. Contacts in the specified countries will then receive the successful version in their own languages.\n\n**Note:** This endpoint is only available if the *Multi-language Email Campaigns* feature is enabled for your account. Contact Emarsys Support for details." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/finalize", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "finalize" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -21248454,\n \"replyText\": \"eu exercitation\",\n \"data\": {}\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/finalize", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "finalize" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Copy an Email Campaign", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"test\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/copy", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "copy" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] }, "description": "Makes a copy of an email campaign, optionally with a new name." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"test\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/copy", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "copy" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -52225190,\n \"replyText\": \"esse eu consequat aliquip\",\n \"data\": {\n \"campaignId\": -73924676\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"test\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/email/:emailId/copy", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "copy" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Delete a Tracked Link in an Email Campaign", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/deletetrackedlinks/:linkId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "deletetrackedlinks", ":linkId" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." }, { "key": "linkId", "value": "81739474", "description": "(Required) The identifier of the tracked link.\n\n**Note:** If not provided, all links are deleted in the email campaign." } ] }, "description": "**Note: This endpoint is deprecated and will be shut down in the near future. Please avoid using this endpoint in production.**\n\nDeletes a specific or all tracked links in an email campaign.\n\n**Note:** Provide the `linkId` path parameter to stop tracking a specific link.\n\n**Important**: This call only deletes the resources from the database, but no other modification is done in the campaign source. Further modifications must be done by the caller." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/deletetrackedlinks/:linkId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "deletetrackedlinks", ":linkId" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." }, { "key": "linkId", "value": "81739474", "description": "(Required) The identifier of the tracked link.\n\n**Note:** If not provided, all links are deleted in the email campaign." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/:emailId/deletetrackedlinks/:linkId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":emailId", "deletetrackedlinks", ":linkId" ], "variable": [ { "key": "emailId", "value": "81739474", "description": "(Required) The identifier of the email campaign." }, { "key": "linkId", "value": "81739474", "description": "(Required) The identifier of the tracked link.\n\n**Note:** If not provided, all links are deleted in the email campaign." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "Templates", "item": [ { "name": "List Email Templates", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/v2/email/templates", "description": "Returns a list of all templates, including their names and identifiers.\n\n**Note**: This endpoint is not compatible with VCE (block-based) e-mail templates." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/email/templates" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 73438105,\n \"replyText\": \"proident occaecat non dolore dolore\",\n \"data\": [\n {\n \"id\": -23351727,\n \"name\": \"occaecat aliqua nisi p\"\n },\n {\n \"id\": -41398268,\n \"name\": \"Lorem exercitation ullamco qui esse\"\n }\n ]\n}" } ] }, { "name": "Get an Email Template", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/email/templates/:templateId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", "templates", ":templateId" ], "variable": [ { "key": "templateId", "value": "81739474", "description": "(Required) The template identifier." } ] }, "description": "Returns the data of an email template.\n\n**Note**: This endpoint is not compatible with VCE (block-based) e-mail templates." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/templates/:templateId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", "templates", ":templateId" ], "variable": [ { "key": "templateId", "value": "81739474", "description": "(Required) The template identifier." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 89210443,\n \"replyText\": \"in do dolore incid\",\n \"data\": {\n \"id\": -72591272,\n \"name\": \"dolore ad voluptate aliqua\",\n \"groups\": [\n {\n \"id\": 22302168,\n \"name\": \"reprehenderit consectetur\"\n },\n {\n \"id\": -62780452,\n \"name\": \"exercitati\"\n }\n ]\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/templates/:templateId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", "templates", ":templateId" ], "variable": [ { "key": "templateId", "value": "81739474", "description": "(Required) The template identifier." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "Create an Email Campaign", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"be_afraid_email\",\n \"administrator\": 112233,\n \"language\": \"en\",\n \"subject\": \"convergence\",\n \"fromname\": \"Malekith\",\n \"fromemail\": \"malekith@example.com\",\n \"email_category\": \"111111111\",\n \"html_source\": \"Hello $First Name$...\",\n \"text_source\": \"Hello $First Name$...\",\n \"browse\": 0,\n \"text_only\": 0,\n \"unsubscribe\": 1,\n \"filter\": 222222222\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email", "description": "Creates an email campaign with the specified parameters.\n\n**Note:** For further information about creating emails with transaction-specific content, see Using the API to Create Triggered Messages and Capturing Transactional Content. For the list of possible campaign related placeholders, see [Email personalization placeholders](docs/personalization/email-personalization-placeholders-legacy.md).\n\n To disable the automatic link-tracking temporarily when creating an email campaign use `keep_raw_html` and `keep_raw_text` with the value of `1` in the call:\n ```\n \"keep_raw_html\": 1,\n \"keep_raw_text\": 1 \n ``` \n" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"be_afraid_email\",\n \"administrator\": 112233,\n \"language\": \"en\",\n \"subject\": \"convergence\",\n \"fromname\": \"Malekith\",\n \"fromemail\": \"malekith@example.com\",\n \"email_category\": \"111111111\",\n \"html_source\": \"Hello $First Name$...\",\n \"text_source\": \"Hello $First Name$...\",\n \"browse\": 0,\n \"text_only\": 0,\n \"unsubscribe\": 1,\n \"filter\": 222222222\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 77781206,\n \"replyText\": \"pariatur sed Duis dolor\",\n \"data\": {\n \"id\": 15067791,\n \"event_id\": 0\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"be_afraid_email\",\n \"administrator\": 112233,\n \"language\": \"en\",\n \"subject\": \"convergence\",\n \"fromname\": \"Malekith\",\n \"fromemail\": \"malekith@example.com\",\n \"email_category\": \"111111111\",\n \"html_source\": \"Hello $First Name$...\",\n \"text_source\": \"Hello $First Name$...\",\n \"browse\": 0,\n \"text_only\": 0,\n \"unsubscribe\": 1,\n \"filter\": 222222222\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "List Email Campaigns", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/email/?status=81739474&launched=0&contactlist=81739474&showdeleted=0&fromdate=8775-73-04&todate=8775-73-04&root_campaign_id=81739474&template=81739474&content_type=html&campaign_type=adhoc&parent_campaign_id=81739474&behavior_channel=transactional_email&email_category=81739474&is_rti=true", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", "" ], "query": [ { "key": "status", "value": "81739474", "description": "The status of the campaign. See [Email status and error codes]([Email status and error codes](docs/personalization/email-status-and-error-codes.md)) for details." }, { "key": "launched", "value": "0", "description": "Filters campaigns by their launch status.\n\nSupported values:\n- *0*: Not launched\n- *1*: Launched" }, { "key": "contactlist", "value": "81739474", "description": "The identifier of the contact list. Set to *0* if no contact list is defined." }, { "key": "showdeleted", "value": "0", "description": "Filters deleted campaigns.\n\nSupported values:\n- *0*: Deleted campaigns are ignored\n- *1*: Lists deleted campaigns as well" }, { "key": "fromdate", "value": "8775-73-04", "description": "Lists campaigns created after the specified date. Date format: YYYY-MM-DD." }, { "key": "todate", "value": "8775-73-04", "description": "Lists campaigns created before the specified date. Date format: YYYY-MM-DD." }, { "key": "root_campaign_id", "value": "81739474", "description": "The identifier of the root campaign ID. Set to *0* if the campaign is not versioned." }, { "key": "template", "value": "81739474", "description": "The identifier of the template. Set to *0* if there is no template." }, { "key": "content_type", "value": "html", "description": "The type of the content.\n\n**Note:** Multiple values are allowed, separated by a comma without whitespace." }, { "key": "campaign_type", "value": "adhoc", "description": "The type of the campaign.\n\n**Note:** Multiple values are allowed, separated by a comma without whitespace." }, { "key": "parent_campaign_id", "value": "81739474", "description": "The identifier of the parent campaign. Set to *0* if the email campaign is not a recurring child campaign." }, { "key": "behavior_channel", "value": "transactional_email", "description": "The channel type." }, { "key": "email_category", "value": "81739474", "description": "The identifier of the campaign.\n\n**Note:** Multiple values are allowed, separated by a comma without whitespace." }, { "key": "is_rti", "value": "true", "description": "Specifies whether the campaign supports Interactions.\n\n**Accepted values:** `true`, `false`" } ] }, "description": "Returns a list of existing email campaigns. Filter the results by specifying a campaign by its identifier, set a date range, or use other query parameters.\n\n**Note:** It is recommended to list campaigns in shorter date ranges when requesting a large amount of data." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/?status=81739474&launched=0&contactlist=81739474&showdeleted=0&fromdate=8775-73-04&todate=8775-73-04&root_campaign_id=81739474&template=81739474&content_type=html&campaign_type=adhoc&parent_campaign_id=81739474&behavior_channel=transactional_email&email_category=81739474&is_rti=true", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", "" ], "query": [ { "key": "status", "value": "81739474" }, { "key": "launched", "value": "0" }, { "key": "contactlist", "value": "81739474" }, { "key": "showdeleted", "value": "0" }, { "key": "fromdate", "value": "8775-73-04" }, { "key": "todate", "value": "8775-73-04" }, { "key": "root_campaign_id", "value": "81739474" }, { "key": "template", "value": "81739474" }, { "key": "content_type", "value": "html" }, { "key": "campaign_type", "value": "adhoc" }, { "key": "parent_campaign_id", "value": "81739474" }, { "key": "behavior_channel", "value": "transactional_email" }, { "key": "email_category", "value": "81739474" }, { "key": "is_rti", "value": "true" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 16394821,\n \"replyText\": \"Ut dolor consequat\",\n \"data\": [\n {\n \"id\": \"sed velit id\",\n \"language\": \"al\",\n \"created\": \"in do\",\n \"deleted\": \"labore\",\n \"fromemail_host\": \"emarsys\",\n \"name\": \"ex fugiat anim aliquip nisi\",\n \"status\": \"culpa esse commodo magna\",\n \"api_status\": \"eu ex labore\",\n \"api_error\": \"officia nisi esse\",\n \"fromemail\": \"esse amet deserunt\",\n \"fromname\": \"consequat et in\",\n \"subject\": \"consequat voluptate es\",\n \"email_category\": \"dolor sint elit\",\n \"filter\": \"irure deserunt in cupidatat\",\n \"contactlist\": \"proident est\",\n \"template\": \"amet voluptate ipsum proiden\",\n \"cc_list\": 96399015,\n \"source\": \"userlist\",\n \"content_type\": \"voluptate \",\n \"root_campaign_id\": \"dolor mollit\",\n \"version_name\": \"sit\",\n \"features\": [\n \"incentive-recommendation\",\n \"incentive-recommendation\"\n ]\n },\n {\n \"id\": \"sed o\",\n \"language\": \"veniam Duis occaecat Excepteur in\",\n \"created\": \"sunt laboris inc\",\n \"deleted\": \"est proident laborum\",\n \"fromemail_host\": \"external\",\n \"name\": \"in Lorem do\",\n \"status\": \"eu non consequat dolor aliqua\",\n \"api_status\": \"dolor aliquip\",\n \"api_error\": \"ea voluptate minim quis\",\n \"fromemail\": \"quis adipisicing non\",\n \"fromname\": \"nisi sint ut\",\n \"subject\": \"dolore voluptate consectetur\",\n \"email_category\": \"esse\",\n \"filter\": \"eiusmod\",\n \"contactlist\": \"do \",\n \"template\": \"ex cupidatat\",\n \"cc_list\": -81372118,\n \"source\": \"api\",\n \"content_type\": \"proident cillum\",\n \"root_campaign_id\": \"deserunt\",\n \"version_name\": \"elit Lorem\",\n \"features\": [\n \"incentive-recommendation\",\n \"incentive-recommendation\"\n ]\n }\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/?status=81739474&launched=0&contactlist=81739474&showdeleted=0&fromdate=8775-73-04&todate=8775-73-04&root_campaign_id=81739474&template=81739474&content_type=html&campaign_type=adhoc&parent_campaign_id=81739474&behavior_channel=transactional_email&email_category=81739474&is_rti=true", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", "" ], "query": [ { "key": "status", "value": "81739474" }, { "key": "launched", "value": "0" }, { "key": "contactlist", "value": "81739474" }, { "key": "showdeleted", "value": "0" }, { "key": "fromdate", "value": "8775-73-04" }, { "key": "todate", "value": "8775-73-04" }, { "key": "root_campaign_id", "value": "81739474" }, { "key": "template", "value": "81739474" }, { "key": "content_type", "value": "html" }, { "key": "campaign_type", "value": "adhoc" }, { "key": "parent_campaign_id", "value": "81739474" }, { "key": "behavior_channel", "value": "transactional_email" }, { "key": "email_category", "value": "81739474" }, { "key": "is_rti", "value": "true" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Query Delivery Status", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"emailId\": 1234,\n \"launchId\": 5678,\n \"lastId\": 999,\n \"allowNotFinished\": true\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email/getdeliverystatus", "description": "Returns the delivery status of an email campaign." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"emailId\": 1234,\n \"launchId\": 5678,\n \"lastId\": 999,\n \"allowNotFinished\": true\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email/getdeliverystatus" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -55815800,\n \"replyText\": \"nulla\",\n \"data\": {\n \"resultSet\": [\n {\n \"id\": -30727835,\n \"user_id\": 63590567,\n \"bounce_reason\": \"id non sint in volup\",\n \"status\": \"sed veniam sint\",\n \"mail_type\": \"html\"\n },\n {\n \"id\": 9943809,\n \"user_id\": -82289779,\n \"bounce_reason\": \"pariatur sint eiusmod\",\n \"status\": \"\",\n \"mail_type\": \"html\"\n }\n ],\n \"lastId\": -3222626\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"emailId\": 1234,\n \"launchId\": 5678,\n \"lastId\": 999,\n \"allowNotFinished\": true\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email/getdeliverystatus" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Query Email Response Metrics and Deliverability", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"clicked\",\n \"start_date\": \"2017-12-01 00:00\",\n \"end_date\": \"2018-04-01 00:00\",\n \"campaign_id\": 5243\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email/responses", "description": "Returns a list of contacts based on the requested response metrics or deliverability status. For example, it queries all contacts in the specified campaign who opened emails in the specified timeframe.\n\nFor more information about response metrics and deliverability, see [Email Response Metrics Explained](https://help.emarsys.com/hc/en-us/articles/115005132729).\n\n**Important:** This is an asynchronous operation, and may take a couple of minutes to complete. The request initiates a background job and returns an identifier. Start polling the [Get email response metric and deliverability results](reference/openapi.json/paths/~1v2~1email~1{queryId}~1responses/get) endpoint **within two minutes** using the returned query identifier for metrics and deliverability data.\n\n**Note:** This endpoint is rate limited and accepts only one request per minute.\n\n**Note:** The start and end date values added to the query respect the accounts' timezone. This means that account timezone is taken into account in the response data. \n\n**Important:** When specifying a period of certain days, use the zero hour of the day after the last one as an end date. One calendar day is the following:\n\n` \"start_date\": \"2021-06-19 00:00\" \n\"end_date\": \"2021-06-20 00:00\" `" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"clicked\",\n \"start_date\": \"2017-12-01 00:00\",\n \"end_date\": \"2018-04-01 00:00\",\n \"campaign_id\": 5243\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email/responses" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -16574483,\n \"replyText\": \"ipsum irure\",\n \"data\": {\n \"id\": -42151785\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"clicked\",\n \"start_date\": \"2017-12-01 00:00\",\n \"end_date\": \"2018-04-01 00:00\",\n \"campaign_id\": 5243\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email/responses" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"clicked\",\n \"start_date\": \"2017-12-01 00:00\",\n \"end_date\": \"2018-04-01 00:00\",\n \"campaign_id\": 5243\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email/responses" }, "status": "Locked (WebDAV) (RFC 4918)", "code": 423, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Get Email Response Metrics and Deliverability Results", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/email/:queryId/responses", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":queryId", "responses" ], "variable": [ { "key": "queryId", "value": "81739474", "description": "(Required) The query identifier initated on the [Query email response metrics and deliverability](reference/openapi.json/paths/~1v2~1email~1responses/post) endpoint." } ] }, "description": "Returns a list of contacts requested on the [Query email response metrics and deliverability](reference/openapi.json/paths/~1v2~1email~1responses/post) endpoint.\n\nFor more information about response metrics and deliverability, see [Email Response Metrics Explained](https://help.emarsys.com/hc/en-us/articles/115005132729).\n\n**Note:** You must start polling this endpoint **within two minutes** from the initial request on the [Query email response metrics and deliverability](reference/openapi.json/paths/~1v2~1email~1responses/post) endpoint. The results are available for two hours after the initial query." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/:queryId/responses", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":queryId", "responses" ], "variable": [ { "key": "queryId", "value": "81739474", "description": "(Required) The query identifier initated on the [Query email response metrics and deliverability](reference/openapi.json/paths/~1v2~1email~1responses/post) endpoint." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/email/:queryId/responses", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":queryId", "responses" ], "variable": [ { "key": "queryId", "value": "81739474", "description": "(Required) The query identifier initated on the [Query email response metrics and deliverability](reference/openapi.json/paths/~1v2~1email~1responses/post) endpoint." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "List Email Campaign Launches", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"emailId\": 1234\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email/getlaunchesofemail", "description": "Lists all launches of an email campaign, including the launch identifier, date, and status of each individual launch." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"emailId\": 1234\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email/getlaunchesofemail" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 40830075,\n \"replyText\": \"consequat elit aliquip\",\n \"data\": [\n {\n \"id\": \"commodo ut esse\",\n \"done\": \"y\",\n \"launch_date\": \"cupidatat amet dolore laboris eu\"\n },\n {\n \"id\": \"dolore in\",\n \"done\": \"y\",\n \"launch_date\": \"amet sint consequat ex aliqua\"\n }\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"emailId\": 1234\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email/getlaunchesofemail" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Unsubscribe a Contact from an Email Campaign", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"launch_list_id\": 111111111,\n \"email_id\": 222222222,\n \"contact_uid\": \"0815abcd\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email/unsubscribe", "description": "Registers an unsubscribe event to remove the specified contact from an email campaign. Think of this as merely registering a request, no other acion is taken, the removal is not done yet. Use the [Update contacts](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4MTE) endpoint to perform the actual unsubscibe." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"launch_list_id\": 111111111,\n \"email_id\": 222222222,\n \"contact_uid\": \"0815abcd\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email/unsubscribe" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"launch_list_id\": 111111111,\n \"email_id\": 222222222,\n \"contact_uid\": \"0815abcd\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email/unsubscribe" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Delete an Email Campaign", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"emailId\": 3456\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email/delete", "description": "Deletes an email campaign." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"emailId\": 3456\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email/delete" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"emailId\": 3456\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email/delete" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "List AC Programs That Use an Email Campaign", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/email/:campaign_id/programs", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":campaign_id", "programs" ], "variable": [ { "key": "campaign_id", "value": "81739474", "description": "(Required) The id of the campaign used by the AC programs you want to get." } ] }, "description": "Returns a list of AC programs that use the specified email campaign." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/email/:campaign_id/programs", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":campaign_id", "programs" ], "variable": [ { "key": "campaign_id", "value": "81739474", "description": "(Required) The id of the campaign used by the AC programs you want to get." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 90221754,\n \"replyText\": \"proident\",\n \"data\": [\n {\n \"id\": 25172457,\n \"name\": \"eiusmod in sint fugiat anim\"\n },\n {\n \"id\": -9363766,\n \"name\": \"in ea\"\n }\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/email/:campaign_id/programs", "host": [ "{{baseUrl}}" ], "path": [ "v2", "email", ":campaign_id", "programs" ], "variable": [ { "key": "campaign_id", "value": "81739474", "description": "(Required) The id of the campaign used by the AC programs you want to get." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -53028643,\n \"replyText\": \"dolore esse non cupidatat\",\n \"data\": \"elit pariatur Excepteur ullamco\"\n}" } ] }, { "name": "Export a Contact List", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"distribution_method\": \"ftp\",\n \"contactlist\": -4537883,\n \"contact_fields\": [\n 89690223\n ],\n \"delimiter\": \",\",\n \"add_field_names_header\": 1,\n \"language\": \"tj\",\n \"ftp_settings\": {\n \"host\": \"Excepteur ut in dolor\",\n \"port\": \"sint consectetur laborum\",\n \"username\": \"eu labore cillum\",\n \"password\": \"commodo incididunt\",\n \"folder\": \"ex officia dolore\"\n },\n \"distribution_email_address\": \"I62Vc68n18ha3xu@fFYWiNGZpTcvEPmkjdAvfbMdcGlpV.zy\",\n \"notification_url\": \"dolore eiusmod\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email/getcontacts", "description": "Exports the specified fields of contacts from a contact list as a CSV file.\n\n**Important:** \n\nThe results are saved as a CSV file that you can access in multiple ways.\n- Exports flagged as `local` are stored on the Emarsys server that you can download via WebDAV or an API call.\n- Exports flagged as `ftp` can be accessed via FTP.\n- Exports flagged as `sftp` can be accessed via SFTP.\n- Exports flagged as `mail` are sent to the specified address when ready.\n\n**Implementation**\n\nou can implement this method as follows:\n- Poll the [Check Export Status](/reference/openapi.json/paths/~1v2~1export~1{exportId}/get) endpoint to track the export status. When done, access the file at the [Download Export Data](/reference/openapi.json/paths/~1v2~1export~1{exportId}~1data/get) endpoint.\n- Set the `notification_url` parameter to implement a callback mechanism. When the export is ready, a request is sent to the provided URL with the same payload as the [Check Export Status](/reference/openapi.json/paths/~1v2~1export~1{exportId}/get) response. Failures are retried 5 times, with a one-minute wait between each try.\n\n**Notes**\n- As we are using a proxy for FTP traffic, it is not necessary to whitelist any IPs on our side.\n- WebDAV access must be enabled first, and requires authentication to use. For a WebDAV account or (S)FTP access, contact Emarsys support.\n\n**Example**\n\n```csv\nFirst Name;Last Name;E-mail;Opt-in\nFname_1;Lname_1;testuser@example.com;True\nFname_2;Lname_2;testuser@example.com;True\nFname_3;Lname_3;testuser@example.com;True\nFname_4;Lname_4;testuser@example.com;True\n```\n\n> **Important:** Due to limitations of API specification languages, dynamic keys are not yet supported in query strings on the interactive demo page (**Try it out**). We are working on this issue.

**Tip:** You can use the [Postman Collection](https://raw.githubusercontent.com/emartech/developer-hub-public-assets/master/resources/EmarsysV2PostmanCollection.json) to test the endpoint." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"distribution_method\": \"ftp\",\n \"contactlist\": -4537883,\n \"contact_fields\": [\n 89690223\n ],\n \"delimiter\": \",\",\n \"add_field_names_header\": 1,\n \"language\": \"tj\",\n \"ftp_settings\": {\n \"host\": \"Excepteur ut in dolor\",\n \"port\": \"sint consectetur laborum\",\n \"username\": \"eu labore cillum\",\n \"password\": \"commodo incididunt\",\n \"folder\": \"ex officia dolore\"\n },\n \"distribution_email_address\": \"I62Vc68n18ha3xu@fFYWiNGZpTcvEPmkjdAvfbMdcGlpV.zy\",\n \"notification_url\": \"dolore eiusmod\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email/getcontacts" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -76482165,\n \"replyText\": \"nostrud enim proident adipisicing\",\n \"data\": {\n \"id\": 98938000\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"distribution_method\": \"ftp\",\n \"contactlist\": -4537883,\n \"contact_fields\": [\n 89690223\n ],\n \"delimiter\": \",\",\n \"add_field_names_header\": 1,\n \"language\": \"tj\",\n \"ftp_settings\": {\n \"host\": \"Excepteur ut in dolor\",\n \"port\": \"sint consectetur laborum\",\n \"username\": \"eu labore cillum\",\n \"password\": \"commodo incididunt\",\n \"folder\": \"ex officia dolore\"\n },\n \"distribution_email_address\": \"I62Vc68n18ha3xu@fFYWiNGZpTcvEPmkjdAvfbMdcGlpV.zy\",\n \"notification_url\": \"dolore eiusmod\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email/getcontacts" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Export Responses", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"distribution_method\": \"local\",\n \"time_range\": [\n \"nisi\",\n \"reprehenderit qui do cupidatat dolor\"\n ],\n \"contact_fields\": [\n 88838427\n ],\n \"sources\": [\n \"mail_open\",\n \"mail_open\"\n ],\n \"analysis_fields\": [\n -10834637,\n -89999276\n ],\n \"email_id\": 54944412,\n \"contactlist\": 33171046,\n \"delimiter\": \",\",\n \"add_field_names_header\": 1,\n \"language\": \"aa\",\n \"ftp_settings\": {\n \"host\": \"http://CoFMKDjQtjaVpAwzqJhnSFLzzfWgkl.ihrpGWjf2+ODPLA7CjLvmEEn0TGPP7ImRj0lgHretnCheX\",\n \"port\": \"et commodo\",\n \"username\": \"dolor aliqua laborum et\",\n \"password\": \"culpa ea mollit elit quis\",\n \"folder\": \"dolore sit\"\n },\n \"notification_url\": \"https://TVmjngVMiVskYbQqv.skavOJ79J+yiQ8TjplNfLqenh-T\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email/getresponses", "description": "Exports the specified fields of contacts who responded to an email within a certain time period as a CSV file.\n\n**Important:** \n\nThe results are saved as a CSV file that you can access in multiple ways.\n- Exports flagged as `local` are stored on the Emarsys server that you can download via WebDAV or an API call.\n- Exports flagged as `ftp` can be accessed via FTP.\n\n**Implementation**\n\nou can implement this method as follows:\n- Poll the [Check Export Status](/reference/openapi.json/paths/~1v2~1export~1{exportId}/get) endpoint to track the export status. When done, access the file at the [Download Export Data](/reference/openapi.json/paths/~1v2~1export~1{exportId}~1data/get) endpoint.\n- Set the `notification_url` parameter to implement a callback mechanism. When the export is ready, a request is sent to the provided URL with the same payload as the [Check Export Status](/reference/openapi.json/paths/~1v2~1export~1{exportId}/get) response. Failures are retried 5 times, with a one-minute wait between each try.\n\n**Notes**\n- As we are using a proxy for FTP traffic, it is not necessary to whitelist any IPs on our side.\n- WebDAV access must be enabled first, and requires authentication to use. For a WebDAV account or (S)FTP access, contact Emarsys support.\n\n**Example**\n\n```csv\nuser_id;First Name;Last Name;E-Mail;Campaign title;Link title;Url;source\n287705659;user3;test_import;test1@emarsys.com;VisualCMS_2015_04_09_10_05_03;;www.emarsys.com;click\n287705659;user3;test_import;test1@emarsys.com;RSS_2015_04_09_10_05_03;;www.google.com.com;click\n287705659;user3;test_import;test1@emarsys.com;AC_recurring_2015_04_09_10_05_03;;;open\n```" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"distribution_method\": \"ftp\",\n \"time_range\": [\n \"dolore anim la\",\n \"id aute\"\n ],\n \"contact_fields\": [\n 62179487\n ],\n \"sources\": [\n \"unsubscribe\",\n \"mail_open\"\n ],\n \"analysis_fields\": [\n -61545353,\n -94725956\n ],\n \"email_id\": -99575565,\n \"contactlist\": 36651148,\n \"delimiter\": \",\",\n \"add_field_names_header\": 1,\n \"language\": \"lm\",\n \"ftp_settings\": {\n \"host\": \"http://flSkXorowU.zyalXoVyTdce9eVLfHCkeHS.qMMha9VNwtNIiqjkMDT-\",\n \"port\": \"Ut\",\n \"username\": \"elit\",\n \"password\": \"in eiusmod commodo\",\n \"folder\": \"do\"\n },\n \"notification_url\": \"http://ftiMGDCkdarb.eajmLiIaOl64xCOJMluUIxTH.gWrilrsL\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email/getresponses" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -76482165,\n \"replyText\": \"nostrud enim proident adipisicing\",\n \"data\": {\n \"id\": 98938000\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"distribution_method\": \"ftp\",\n \"time_range\": [\n \"dolore anim la\",\n \"id aute\"\n ],\n \"contact_fields\": [\n 62179487\n ],\n \"sources\": [\n \"unsubscribe\",\n \"mail_open\"\n ],\n \"analysis_fields\": [\n -61545353,\n -94725956\n ],\n \"email_id\": -99575565,\n \"contactlist\": 36651148,\n \"delimiter\": \",\",\n \"add_field_names_header\": 1,\n \"language\": \"lm\",\n \"ftp_settings\": {\n \"host\": \"http://flSkXorowU.zyalXoVyTdce9eVLfHCkeHS.qMMha9VNwtNIiqjkMDT-\",\n \"port\": \"Ut\",\n \"username\": \"elit\",\n \"password\": \"in eiusmod commodo\",\n \"folder\": \"do\"\n },\n \"notification_url\": \"http://ftiMGDCkdarb.eajmLiIaOl64xCOJMluUIxTH.gWrilrsL\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/email/getresponses" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "Event", "item": [ { "name": "{event Id}", "item": [ { "name": "Query an External Event", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/event/:eventId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "event", ":eventId" ], "variable": [ { "key": "eventId", "value": "81739474", "description": "(Required) The identifier of the external event." } ] }, "description": "Returns the name of the external event specified by its identifier." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/event/:eventId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "event", ":eventId" ], "variable": [ { "key": "eventId", "value": "81739474", "description": "(Required) The identifier of the external event." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -86125489,\n \"replyText\": \"et id\",\n \"data\": [\n {\n \"id\": -27547352,\n \"name\": \"in\"\n },\n {\n \"id\": 32466764,\n \"name\": \"sed est dolor Duis\"\n }\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/event/:eventId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "event", ":eventId" ], "variable": [ { "key": "eventId", "value": "81739474", "description": "(Required) The identifier of the external event." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Update an External Event", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"response_email\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/event/:eventId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "event", ":eventId" ], "variable": [ { "key": "eventId", "value": "81739474", "description": "(Required) The identifier of the external event." } ] }, "description": "Updates the name of an external event." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"response_email\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/event/:eventId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "event", ":eventId" ], "variable": [ { "key": "eventId", "value": "81739474", "description": "(Required) The identifier of the external event." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 83496911,\n \"replyText\": \"id ut deserunt\",\n \"data\": {\n \"id\": 74884172,\n \"name\": \"laborum au\"\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"response_email\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/event/:eventId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "event", ":eventId" ], "variable": [ { "key": "eventId", "value": "81739474", "description": "(Required) The identifier of the external event." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "List Uses of an External Event", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/event/:eventId/usages", "host": [ "{{baseUrl}}" ], "path": [ "v2", "event", ":eventId", "usages" ], "variable": [ { "key": "eventId", "value": "81739474", "description": "(Required) The identifier of the external event." } ] }, "description": "Lists the identifiers of the automation programs and emails that the specified external event triggers or is used in. Returns Automation Center and Interactions program identifiers and email identifiers.\n\n**Note:** Emails must be in the *launched* state in order to appear." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/event/:eventId/usages", "host": [ "{{baseUrl}}" ], "path": [ "v2", "event", ":eventId", "usages" ], "variable": [ { "key": "eventId", "value": "81739474", "description": "(Required) The identifier of the external event." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -37481379,\n \"replyText\": \"minim ad id\",\n \"data\": {\n \"program_ids\": [\n -41019621,\n 21538950\n ],\n \"email_ids\": [\n 26515282,\n -34109974\n ],\n \"interactions_program_ids\": [\n \"Lorem magna ad\",\n \"ad et sint\"\n ]\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/event/:eventId/usages", "host": [ "{{baseUrl}}" ], "path": [ "v2", "event", ":eventId", "usages" ], "variable": [ { "key": "eventId", "value": "81739474", "description": "(Required) The identifier of the external event." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Delete an External Event", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/event/:eventId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "event", ":eventId", "delete" ], "variable": [ { "key": "eventId", "value": "81739474", "description": "(Required) The identifier of the external event." } ] }, "description": "Deletes an external event.\n\n**Note:** Deleting an event has no effect on any programs or email campaigns linked to the event." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/event/:eventId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "event", ":eventId", "delete" ], "variable": [ { "key": "eventId", "value": "81739474", "description": "(Required) The identifier of the external event." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/event/:eventId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "event", ":eventId", "delete" ], "variable": [ { "key": "eventId", "value": "81739474", "description": "(Required) The identifier of the external event." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Trigger an External Event", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"veniam deserunt dolor dolor cupidatat\",\n \"contacts\": [\n {\n \"attachment\": \"sint anim\"\n },\n {\n \"event_time\": \"ipsum\",\n \"attachment\": \"nostrud Duis\",\n \"trigger_id\": \"cillum nostrud eu sit est\",\n \"external_id\": \"eiusmod\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/event/:eventId/trigger", "host": [ "{{baseUrl}}" ], "path": [ "v2", "event", ":eventId", "trigger" ], "variable": [ { "key": "eventId", "value": "81739474", "description": "(Required) The identifier of the external event." } ] }, "description": "Activates a named external event trigger for a specified contact.\n\n### NEW PARAMETER\n\nIn January 2021, a new parameter is introduced to this endpoint. If the `event_time` parameter is added to the request, it will be used as the time of event in [Interactions](https://help.emarsys.com/hc/en-us/articles/360003898918). The parameter has to be in one of the following formats: \n- 2007-03-01T13:00:00Z\n- 2007-03-01T13:00:00.000Z. \n\nIf the `event_time` is not provided, we will continue to use the time when the event was processed by Emarsys. If invalid `event_time` is provided (it is set, but not matching the above formats) an error will be provided and the event will not trigger either emails, Automation Center programs, or be used in Interactions.\n\nThe `event_time` parameter is checked at the same level as `trigger_id`, e.g. in the first level for single contact case and within the contacts array for the batch use case.\n\nFor more information on the new parameter, please contact Emarsys Support.\n\n### Prerequisites\n- If you synchronize your contact data using your own unique identifier in your system, a custom contact field `externalId` must exist as the external identifier. To create one, use the [Create a field](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4MTY) endpoint or go to **Admin** > **Field Editor** > **New** in the Emarsys application. For details on contact identifiers, see [Concepts](docs/before-you-start/concepts.md).\n>**Note:** Using external field identifiers is the recommended method for identifying contacts. However, you can use other Emasys system fields as well, such as email. For details, see [Contact system fields](docs/personalization/contact-system-fields.md).\n\n- The specified contact must exist in the Emarsys database to trigger an event.\n- The external event has been created using the API endpoint [Create an External Event](/reference/openapi.json/paths/~1v2~1event/post), or in the Emarsys application. See [Using External Events](https://help.emarsys.com/hc/en-us/articles/115004461489-triggered-email-end-user-guide#preparing-the-external-events) for details.\n- The field identifier is required to create contacts with custom fields. List the field identifiers at the [List available fields](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4MTc) endpoint or go to **Admin** > **Field Editor** in the Emarsys application.\n\n**Notes**\n\n- The maximum number of objects per request is 1000.\n- Do not use the `ems_event_time` key under `data` as this is reserved for internal use. Values sent with this key are **ignored**.\n- New to triggered emails? See [Triggered Email - Overview](https://help.emarsys.com/hc/en-us/articles/115004452105-Triggered-Email-Overview) for an introduction.\n- For further information about creating emails with transaction-specific content, see [Creating Transactional Emails](https://help.emarsys.com/hc/en-us/articles/115004090589#external_data_for_transactional_emails).\n- For the list of possible campaign-related placeholders, see [Email personalization placeholders](docs/personalization/email-personalization-placeholders-legacy.md).\n- An Interactions program will only be triggered if the size of event data for the given event is below 20kB. Events above this limit can still trigger AC programs or emails.\n\n### Payload Structure\n\nYou can trigger an event in different ways as a single or batch request, depending on the content of the email.\n- Global variables are accessible in the entire content of the email, and useful for defining general properties, such the as name of your customer.\n- The scope of section variables are limited to the defined section group. Each section variable in the group adds a copy of the referenced content.\n- [Emarsys Scripting Language](https://help.emarsys.com/hc/en-us/articles/115004090589-Emarsys-Scripting-Language) (ESL) variables allow you to define custom content, but not compatible with section groups.\n\nThe `data` element of the payload contains the variables of the mail, as follows:\n\n| Variable Type | Description | Restrictions |\n| --- | --- | ---\n| global | Contains variables of global scope of the email. | Applies to all variants. |\n| {section_group_name} | Contains variables of the named section group. | Can be paired with global variables, but mutually exclusive with ESL variables. |\n| {twig_variable} | Contains ESL variables. | Can be paired with global variables, but mutually exclusive with section variables. |\n\nThe payload structure also depends on whether the request is a single or batch call. The following examples show all variants.\n\n**Note:** The definition below and the interactive demo feature illustrates a batch call.\n\n\n\n```json\n {\n\"key_id\": 3,\n\"external_id\": \"test@example.com\",\n\"trigger_id\": \"trigger-id-1\",\n\"data\": {\n \"section_group1\": [\n {\n \"section_variable1\": \"some_value\",\n \"section_variable2\": \"another_value\"\n },\n {\n \"section_variable1\": \"yet_another_value\",\n \"section_variable2\": \"one_more_value\"\n }\n ],\n\"global\": {\n \"global_variable1\": \"global_value\",\n \"global_variable2\": \"another_global_value\"\n }\n },\n\"attachment\": [\n {\n \"filename\": \"example.pdf\",\n \"data\": \"ZXhhbXBsZQo=\"\n }\n ]\n}\n```\n\n```json\n{\n \"key_id\": 3,\n \"external_id\": \"test@example.com\",\n \"trigger_id\": \"trigger-id-1\",\n \"data\": {\n \"global\": {\n \"global_variable1\": \"global_value\",\n \"global_variable2\": \"another_global_value\"\n },\n \"twig_variable1\": \"first_value\",\n \"twig_variable2\": \"another_value\"\n },\n \"attachment\": [\n {\n \"filename\": \"example.pdf\",\n \"data\": \"ZXhhbXBsZQo=\" \n }\n ]\n}\n```\n\n```json\n{\n \"key_id\": 3,\n \"contacts\": [\n {\n \"external_id\":\n \"test@example.com\",\n \"trigger_id\": \"trigger-id-2\",\n \"data\": {\n \"section_group1\": [\n {\n \"section_variable1\": \"some_value\",\n \"section_variable2\": \"another_value\"\n },\n {\n \"section_variable1\": \"yet_another_value\",\n \"section_variable2\": \"one_more_value\"\n }\n ],\n \"global\": {\n \"global_variable1\": \"global_value\",\n \"global_variable2\": \"another_global_value\"\n }\n },\n \"attachment\": [\n {\n \"filename\": \"example.pdf\",\n \"data\": \"ZXhhbXBsZQo=\" \n }\n ]\n }\n ]\n}\n```\n\n```json\n{\n \"key_id\": 3,\n \"contacts\": [\n {\n \"external_id\":\n \"test@example.com\",\n \"trigger_id\": \"trigger-id-1\",\n \"data\": {\n \"global\": {\n \"global_variable1\": \"global_value\",\n \"global_variable2\": \"another_global_value\"\n },\n \"twig_variable1\": \"first_value\",\n \"twig_variable2\": \"another_value\"\n },\n \"attachment\": [\n {\n \"filename\": \"example.pdf\",\n \"data\": \"ZXhhbXBsZQo=\" \n }\n ]\n }\n ]\n}\n```\n\nThere are four types of `200 OK` messages we return, depending on whether Interactions advanced features are enabled, and whether the request is a single or a batch call. The four versions differ in what is included in the \"data\" object. \n\nThe following table summarizes how the possible `200 OK` versions differ based on the scenario in which they are sent:\n\n| | **Interactions advanced features not enabled** | **Interactions advanced features enabled** |\n| ---------------------- | ------------------------ | ------------------------------------ |\n| **Single contact trigger** | { } - `200(a)` | {\"connectedTo\"} - `200(c)` |\n| **Batch contact trigger** | {\"ids\",\"errors\"} - `200(b)` | {\"ids\",\"errors\",\"connectedTo\"} - `200(d)` |\n\nYou can find an example for each version (`a`, `b`, `c`, `d`) at the end of this section.\n\nFor customers who have Interactions advanced features enabled, this endpoint returns a `200 OK` response even if the event is not configured to trigger an automated program or an email campaign launch (e.g. the AC program it was linked to has been deleted). In the response body, it is indicated whether any automated programs (AC or Interactions) or email campaigns are connected to the event. Customers who do not have Interactions advanced features enabled get a `400` error in such scenarios: `No program or campaign is triggered.`\n\nIf event data is above the limit of 20kB for the Interactions program, a warning will will inform you of the event not being valid for Interactions under `warnings`.\n\n>**IMPORTANT:** As of September, 2020, every Emarsys customer will get a `200 OK` response regardless of whether automated programs or email campaigns have been triggered by the event. The `400` error `No program or campaign is triggered` will not be used by Emarsys. \n\n\n### Checking Results\nThere are two ways to check if the program was successfully triggered:\n- In the Emarsys application, go to the **Analysis** page of the program and verify that the number of sent emails has increased.\n- Include a test customer in the contact list and check if it receives the relevant email.\n\n\n### Example Use Case\n\nWhen a customer clicks the ***I want to learn more about this product*** button in your webshop, call this endpoint to trigger the associated program, which sends out more information about your product.\n\nFor more use cases, see:\n\n\n \n

Send Batch Emails

\n \n\n\n\n \n

Personalize Your Email with Placeholders

\n \n\n
" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"veniam deserunt dolor dolor cupidatat\",\n \"contacts\": [\n {\n \"attachment\": \"sint anim\"\n },\n {\n \"event_time\": \"ipsum\",\n \"attachment\": \"nostrud Duis\",\n \"trigger_id\": \"cillum nostrud eu sit est\",\n \"external_id\": \"eiusmod\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/event/:eventId/trigger", "host": [ "{{baseUrl}}" ], "path": [ "v2", "event", ":eventId", "trigger" ], "variable": [ { "key": "eventId", "value": "81739474", "description": "(Required) The identifier of the external event." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"veniam deserunt dolor dolor cupidatat\",\n \"contacts\": [\n {\n \"attachment\": \"sint anim\"\n },\n {\n \"event_time\": \"ipsum\",\n \"attachment\": \"nostrud Duis\",\n \"trigger_id\": \"cillum nostrud eu sit est\",\n \"external_id\": \"eiusmod\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/event/:eventId/trigger", "host": [ "{{baseUrl}}" ], "path": [ "v2", "event", ":eventId", "trigger" ], "variable": [ { "key": "eventId", "value": "81739474", "description": "(Required) The identifier of the external event." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"veniam deserunt dolor dolor cupidatat\",\n \"contacts\": [\n {\n \"attachment\": \"sint anim\"\n },\n {\n \"event_time\": \"ipsum\",\n \"attachment\": \"nostrud Duis\",\n \"trigger_id\": \"cillum nostrud eu sit est\",\n \"external_id\": \"eiusmod\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/event/:eventId/trigger", "host": [ "{{baseUrl}}" ], "path": [ "v2", "event", ":eventId", "trigger" ], "variable": [ { "key": "eventId", "value": "81739474", "description": "(Required) The identifier of the external event." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 82808137,\n \"replyText\": \"Duis dolore sunt nisi\",\n \"data\": {\n \"ids\": [\n \"laboris eiusm\",\n \"consectetur commodo\"\n ],\n \"errors\": {}\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"veniam deserunt dolor dolor cupidatat\",\n \"contacts\": [\n {\n \"attachment\": \"sint anim\"\n },\n {\n \"event_time\": \"ipsum\",\n \"attachment\": \"nostrud Duis\",\n \"trigger_id\": \"cillum nostrud eu sit est\",\n \"external_id\": \"eiusmod\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/event/:eventId/trigger", "host": [ "{{baseUrl}}" ], "path": [ "v2", "event", ":eventId", "trigger" ], "variable": [ { "key": "eventId", "value": "81739474", "description": "(Required) The identifier of the external event." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -27372147,\n \"replyText\": \"officia anim Lorem ut\",\n \"data\": {\n \"connectedTo\": {\n \"email\": true,\n \"acProgram\": true,\n \"interactionsProgram\": true\n }\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"veniam deserunt dolor dolor cupidatat\",\n \"contacts\": [\n {\n \"attachment\": \"sint anim\"\n },\n {\n \"event_time\": \"ipsum\",\n \"attachment\": \"nostrud Duis\",\n \"trigger_id\": \"cillum nostrud eu sit est\",\n \"external_id\": \"eiusmod\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/event/:eventId/trigger", "host": [ "{{baseUrl}}" ], "path": [ "v2", "event", ":eventId", "trigger" ], "variable": [ { "key": "eventId", "value": "81739474", "description": "(Required) The identifier of the external event." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -98824076,\n \"replyText\": \"adipisicing aute tempor\",\n \"data\": {\n \"ids\": [\n \"reprehenderit Excepteur magna Duis\",\n \"eu do sint\"\n ],\n \"errors\": {},\n \"connectedTo\": {\n \"email\": false,\n \"acProgram\": false,\n \"interactionsProgram\": false\n },\n \"\": \"nulla cupidatat\"\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"veniam deserunt dolor dolor cupidatat\",\n \"contacts\": [\n {\n \"attachment\": \"sint anim\"\n },\n {\n \"event_time\": \"ipsum\",\n \"attachment\": \"nostrud Duis\",\n \"trigger_id\": \"cillum nostrud eu sit est\",\n \"external_id\": \"eiusmod\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/event/:eventId/trigger", "host": [ "{{baseUrl}}" ], "path": [ "v2", "event", ":eventId", "trigger" ], "variable": [ { "key": "eventId", "value": "81739474", "description": "(Required) The identifier of the external event." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 80140451,\n \"replyText\": \"ea Excepteur non\",\n \"data\": \"culpa officia\"\n}" } ] } ] }, { "name": "Create an External Event", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"bulk purchasing\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/event", "description": "Creates an external event with the specified name in order to allow your external program, such as a CMS or CRM to trigger an Emarsys event." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"bulk purchasing\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/event" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -77523368,\n \"replyText\": \"incidi\",\n \"data\": {\n \"id\": -29834342,\n \"name\": \"nulla eiusmod\"\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"bulk purchasing\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/event" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "List External Events", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/v2/event/", "description": "Lists external event names and identifiers. Use the returned identifiers to trigger emails or programs." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/event/" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 62042632,\n \"replyText\": \"aliquip do qui non veniam\",\n \"data\": [\n {\n \"id\": 65065636,\n \"name\": \"consectetur labore\",\n \"created\": \"officia minim eu elit\"\n },\n {\n \"id\": 15559195,\n \"name\": \"incididunt Duis proident\",\n \"created\": \"ut in Lorem\"\n }\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/event/" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "Export", "item": [ { "name": "{export Id}", "item": [ { "name": "Check Export Status", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/export/:exportId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "export", ":exportId" ], "variable": [ { "key": "exportId", "value": "81739474", "description": "(Required) The export identifier returned at the [Export Updated Contacts](/reference/openapi.json/paths/~1v2~1contact~1getchanges/post) endpoint." } ] }, "description": "Returns information about an export, including its status, type, and output settings.\n\n**Important:** In the exports, the created column is in Vienna timezone. Vienna timezone is UTC+2 in summertime but with Daylight Saving in wintertime it changes to UTC+1). Bear in mind that UTC does not observe Daylight Saving Time (unlike GMT).\n\n**Note:** This endpoint tracks the status of an asynchronous operation using a job identifier. You can initiate an export job and get the identifier at the following endpoints:\n- [Export Updated Contacts](/reference/openapi.json/paths/~1v2~1contact~1getchanges/post)\n- [Export a Contact List](/reference/openapi.json/paths/~1v2~1email~1getcontacts/post)\n- [Export a Segment](/reference/openapi.json/paths/~1v2~1export~1filter/post)\n- [Export Responses](/reference/openapi.json/paths/~1v2~1email~1getresponses/post)" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/export/:exportId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "export", ":exportId" ], "variable": [ { "key": "exportId", "value": "81739474", "description": "(Required) The export identifier returned at the [Export Updated Contacts](/reference/openapi.json/paths/~1v2~1contact~1getchanges/post) endpoint." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 35122901,\n \"replyText\": \"Ut\",\n \"data\": {\n \"id\": \"consequat pariatur \",\n \"created\": \"magna quis tempor\",\n \"status\": \"in progress\",\n \"type\": \"Registrations\",\n \"file_name\": \"minim\",\n \"ftp_host\": \"magna do reprehenderit est\",\n \"ftp_dir\": \"voluptate fugiat labore non ut\"\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/export/:exportId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "export", ":exportId" ], "variable": [ { "key": "exportId", "value": "81739474", "description": "(Required) The export identifier returned at the [Export Updated Contacts](/reference/openapi.json/paths/~1v2~1contact~1getchanges/post) endpoint." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Download Export Data", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "text/csv" } ], "url": { "raw": "{{baseUrl}}/v2/export/:exportId/data?offset=0&limit=10000000", "host": [ "{{baseUrl}}" ], "path": [ "v2", "export", ":exportId", "data" ], "query": [ { "key": "offset", "value": "0", "description": "Specifies an offset for pagination. The offset of the first record is *0*." }, { "key": "limit", "value": "10000000", "description": "Specifies the maximum number of records to return." } ], "variable": [ { "key": "exportId", "value": "81739474", "description": "(Required) The identifier of the export job initiated at the [Export Updated Contacts](/reference/openapi.json/paths/~1v2~1contact~1getchanges/post) endpoint." } ] }, "description": "Returns a CSV file once the export job is finished. You must set the distribution method to `local` when initiating an export job at the following endpoints:\n- [Export Updated Contacts](/reference/openapi.json/paths/~1v2~1contact~1getchanges/post)\n- [Export a Contact List](/reference/openapi.json/paths/~1v2~1email~1getcontacts/post)\n- [Export a Segment](/reference/openapi.json/paths/~1v2~1export~1filter/post)\n\n**Note:** It is recommended to use FTP or WebDAV to access exports. For configuration options, contact Emarsys support.\n\n**Important:** This endpoint returns a file instead of JSON. The *Content-Type* of the response is `text/csv;charset=UTF-8`." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/export/:exportId/data?offset=0&limit=10000000", "host": [ "{{baseUrl}}" ], "path": [ "v2", "export", ":exportId", "data" ], "query": [ { "key": "offset", "value": "0" }, { "key": "limit", "value": "10000000" } ], "variable": [ { "key": "exportId", "value": "81739474", "description": "(Required) The identifier of the export job initiated at the [Export Updated Contacts](/reference/openapi.json/paths/~1v2~1contact~1getchanges/post) endpoint." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/csv" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Export a Segment", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"distribution_method\": \"local\",\n \"filter\": -69356423,\n \"contact_fields\": [\n -26126550\n ],\n \"delimiter\": \",\",\n \"add_field_names_header\": 1,\n \"language\": \"bk\",\n \"ftp_settings\": {\n \"host\": \"ut\",\n \"port\": \"mollit\",\n \"username\": \"proident\",\n \"password\": \"tempor Excepteur\",\n \"folder\": \"quis non esse\"\n },\n \"distribution_email_address\": \"EPU3QixTLS16kj0@EntXQPiDTmaxDYfJoEzFqoPljAPQujbpm.nfx\",\n \"notification_url\": \"pariatur minim reprehenderit enim\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/export/filter", "description": "Exports the specified fields of contacts from a segment as a CSV file.\n\n**Important:** \n\nThe results are saved as a CSV file that you can access in multiple ways.\n- Exports flagged as `local` are stored on the Emarsys server that you can download via WebDAV or an API call.\n- Exports flagged as `ftp` can be accessed via FTP.\n- Exports flagged as `sftp` can be accessed via SFTP.\n- Exports flagged as `mail` are sent to the specified address when ready.\n\n**Implementation**\n\nou can implement this method as follows:\n- Poll the [Check Export Status](/reference/openapi.json/paths/~1v2~1export~1{exportId}/get) endpoint to track the export status. When done, access the file at the [Download Export Data](/reference/openapi.json/paths/~1v2~1export~1{exportId}~1data/get) endpoint.\n- Set the `notification_url` parameter to implement a callback mechanism. When the export is ready, a request is sent to the provided URL with the same payload as the [Check Export Status](/reference/openapi.json/paths/~1v2~1export~1{exportId}/get) response. Failures are retried 5 times, with a one-minute wait between each try.\n\n**Notes**\n- As we are using a proxy for FTP traffic, it is not necessary to whitelist any IPs on our side.\n- WebDAV access must be enabled first, and requires authentication to use. For a WebDAV account or (S)FTP access, contact Emarsys support.\n\n**Example**\n\nAn example contact list export including first name, last name, email address and opt-in status results in the following CSV:\n```csv\nFirst Name;Last Name;E-mail;Opt-in\nFname_1;Lname_1;testuser@example.com;True\nFname_2;Lname_2;testuser@example.com;True\nFname_3;Lname_3;testuser@example.com;True\nFname_4;Lname_4;testuser@example.com;True\n```" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"distribution_method\": \"local\",\n \"filter\": -69356423,\n \"contact_fields\": [\n -26126550\n ],\n \"delimiter\": \",\",\n \"add_field_names_header\": 1,\n \"language\": \"bk\",\n \"ftp_settings\": {\n \"host\": \"ut\",\n \"port\": \"mollit\",\n \"username\": \"proident\",\n \"password\": \"tempor Excepteur\",\n \"folder\": \"quis non esse\"\n },\n \"distribution_email_address\": \"EPU3QixTLS16kj0@EntXQPiDTmaxDYfJoEzFqoPljAPQujbpm.nfx\",\n \"notification_url\": \"pariatur minim reprehenderit enim\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/export/filter" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -76482165,\n \"replyText\": \"nostrud enim proident adipisicing\",\n \"data\": {\n \"id\": 98938000\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"distribution_method\": \"local\",\n \"filter\": -69356423,\n \"contact_fields\": [\n -26126550\n ],\n \"delimiter\": \",\",\n \"add_field_names_header\": 1,\n \"language\": \"bk\",\n \"ftp_settings\": {\n \"host\": \"ut\",\n \"port\": \"mollit\",\n \"username\": \"proident\",\n \"password\": \"tempor Excepteur\",\n \"folder\": \"quis non esse\"\n },\n \"distribution_email_address\": \"EPU3QixTLS16kj0@EntXQPiDTmaxDYfJoEzFqoPljAPQujbpm.nfx\",\n \"notification_url\": \"pariatur minim reprehenderit enim\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/export/filter" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "External content", "item": [ { "name": "Request External Content for Personalization", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": [\n {\n \"{reference-field-1}\": \"exercitation fugiat ipsum pariatur\",\n \"{reference-value-1_N}\": \"eu do sit\",\n \"{reference-field-2}\": \"fugiat voluptate qui labore\",\n \"{reference-value-2_N}\": \"culpa sit laborum deserunt commodo\"\n },\n {\n \"{reference-field-1}\": \"ullamco\",\n \"{reference-value-1_N}\": \"ut qui sed\",\n \"{reference-field-2}\": \"enim\",\n \"{reference-value-2_N}\": \"dolor mollit consectetur\"\n }\n ],\n \"fields\": [\n \"uA6EZ\",\n \"f\"\n ],\n \"limit\": 82128321\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/https://:customer-website.com/api/example/", "description": "### Basics\n\nWith External Content, you can use your own API to personalize content in your messages.\n\nIn this scenario, Emarsys calls your API by sending a POST request.\n\nIn the following example, we are going to request information that is not present in the Emarsys Database.\n\n\nImagine that the following attributes (key-value pairs) describe a specific record in your database:\n- **email=john@example.com**\n- **external_id=90210**\n- *title=Footbal shirt*\n- *price=100*\n- *image_url=https://example.com/images/football-shirt.png*\n\nIn the Emarsys Database, only the first two: **email=john@example.com** and **external_id=90210** are available. (The purchase history of this contact is stored in your database only.)\n\n\n#### Request logic and contents\n\n\"*For records where **email=john@example.com** and **external_id=90210**, return the values for **title**, **price**, and **image_url**, requesting a maximum of <**limit**> number of content objects per reference field.*\"\n\n***parameters*** (reference fields):\n- *email=john@example.com*\n- *external_id=90210*\n\n***fields*** (response fields, the keys we expect values for):\n\n- *title*\n- *price*\n- *image_url*\n\n***limit*** (for the returned content per reference field)\n\n___\n\n#### Response contents\n\n***content***:\n- *email=john@example.com*\n- *external_id=90210*\n- *title=Football shirt*\n- *price=100*\n- *image_url=https://example.com/images/football-shirt.png*\n---\n\n### Request\n\n
\n
parameters
\n
\n \n - This array lists the preconfigured *reference fields* and their values.
\n
fields
\n
\n \n - This array lists the expected response fields configured on the UI.
\n
limit
\n
\n \n - Indicates how many personalization values we expect to get for each contact from your API (if there are multiple values for the same response field).\n \n \n - Value automatically calculated value during the personalization process (based on your e-mail template). For example, if your system calculates a product recommendation and you use 3 recommendations, the limit value is automatically set to 3.
\n \n\n**NOTE**: Basic HTTP authentication and OAuth2 are supported.\n\n**IMPORTANT**:\nThe request will always be in batch and can contain up to 1000 contacts (maximum 100 paralelly at a time per host).\n\n***Request structure***\n\n```\n{\n\t\"parameters\": [\n\t\t{\n\t\t\t\"\": \"\",\n\t\t\t\"\": \",\"\n\t\t\t...\n\t\t},\n\t\t{\n\t\t\t\"\": \"\",\n\t\t\t\"\": \"\",\n\t\t\t...\n\t\t},\n\t\t...\n\t],\n\t\"fields\": [\n\t\t\"\",\n\t\t\"\",\n\t\t...\n\t],\n\t\"limit\": \n}\n```\n\n\n***Request example***\n\n```\n{\n\t\"parameters\": [\n\t\t{\n\t\t\t\"email\": \"john@example.com\",\n\t\t\t\"external_id\": \"92010\"\n\t\t},\n\t\t{\n\t\t\t\"email\": \"jane@example.com\",\n\t\t\t\"external_id\": \"21235\"\n\t\t}\n\t],\n\t\"fields\": [\n\t\t\"title\",\n\t\t\"price\",\n\t\t\"img_url\"\n\t],\n\t\"limit\": 3\n}\n```\n\n---\n\n### Response\n\nThe response must contain a **content** array, which contains all personalization data. Every object in the array must belong to a contact.\n\n- Maximum response body size: *2MB*\n- Supported response type:\n*gzip-encoded* (suggested)\n\n**IMPORTANT**\n\n- Nested objects and arrays placed inside the content objects are considered as a syntactical error, resulting in the whole response being discarded. \n- Response fields that were not specified on the configuration screen will be discarded. The same happens if you exceed the number per contact (per reference field) set in **limit**.\n\n***Response structure***\n```\n{\n\t\"content\": [\n\t\t{\n\t\t\t\"\": \"\",\n\t\t\t\"\": \"\",\n\t\t\t...\n\t\t\t\"\": \"\",\n\t\t\t\"\": \"\",\n\t\t\t...\n\t\t},\n\t\t{\n\t\t\t\"\": \"\",\n\t\t\t\"\": \"\",\n\t\t\t...\n\t\t\t\"\": \"\",\n\t\t\t\"\": \"\",\n\t\t\t...\n\t\t},\n\t\t...\n\t],\n}\n```\n\n***Response example***\n\n```\n{\n\t\"content\": [\n\t\t{\n\t\t\t\"email\": \"john@example.com\",\n\t\t\t\"external_id\": \"90210\"\n\t\t\t\"title\": \"Football shirt\",\n\t\t\t\"price\": 100,\n\t\t\t\"img_url\": \"https://example.com/images/football-shirt.png\"\n\t\t},\n\t\t{\n\t\t\t\"email\": \"jane@example.com\",\n\t\t\t\"external_id\": \"21235\"\n\t\t\t\"title\": \"Bicycle\",\n\t\t\t\"price\": 120,\n\t\t\t\"img_url\": \"https://example.com/images/bicycle.png\"\n\t\t},\n\t\t{\n\t\t\t\"email\": \"bill@example.com\",\n\t\t\t\"external_id\": \"42469\"\n\t\t\t\"title\": \"Baseball cap\",\n\t\t\t\"price\": 50,\n\t\t\t\"img_url\": \"https://example.com/images/baseball-cap.png\"\n\t\t}\n\t]\n}\n```\n\n---\n\n### Error handling\n\nIf External Content doesn't receive a preconfigured response field, we will treat it as missing personalization.\n\nUpon receiving a request from Emarsys via External Content, if you cannot send back the personalized content, do not send back any content about the contact that cannot be personalized.\n\n**Blocking errors**\n\nSome errors may result in paused or aborted Automation Center (AC) or Real Time Interaction (RTI) campaigns.\n\nAC and RTI programs using personalization tokens built with External Content are paused or aborted in the following cases:\n\n- Any of the requests fails with a 4xx status code, except for 429 or 408;\n- The response body is not a valid JSON document;\n- The response format violates the requirements;\n- The response body contains insufficient data (not all parameters/ reference fields are echoed back in the content items), as in the following example:\n\n\nRequest body:\n```\n{\n \"parameters\": [\n {\n \"email\": \"aaa@example.com\",\n \"UID\": \"1234\"\n }\n ],\n \"fields\": [\n \"img_url\"\n ],\n \"limit\": 1\n}\n```\n**Incorrect** response body (the UID parameter is missing):\n```\n{\n \"content\": [\n {\n \"email\": \"aaa@example.com\",\n \"img_url\": \"https://example.com/images/example.png\"\n }\n ]\n}\n```\n\n**Retrying requests**\n\nIf there are no blocking errors, the requests will be retried. Examples include:\n\n-\tthe configured endpoint is unreachable;\n-\tthe request times out;\n-\tthe status code is 5xx (server error);\n-\tthe status code is 429 (too many requests);\n-\tthe status code is 408.\n\nYou can find the comprehensive list of all Emarsys error codes in [Response codes](docs/response-codes/error-codes.md)." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"parameters\": [\n {\n \"{reference-field-1}\": \"dolore sed\",\n \"{reference-value-1_N}\": \"veniam laboris dolor\",\n \"{reference-field-2}\": \"enim est officia ea ad\",\n \"{reference-value-2_N}\": \"nisi minim\"\n },\n {\n \"{reference-field-1}\": \"et ex tempor aliqua Lorem\",\n \"{reference-value-1_N}\": \"dolore veniam non qui in\",\n \"{reference-field-2}\": \"ullamco\",\n \"{reference-value-2_N}\": \"irure eu voluptate in adipisicing\"\n }\n ],\n \"fields\": [\n \"ZA7R\",\n \"WI\"\n ],\n \"limit\": -87434217\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/https://:customer-website.com/api/example/" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"content\": [\n {\n \"date_of_birth\": \"1990-01-01\",\n \"season\": \"winter\",\n \"generated_image_url\": \"https://customer.com/personal-images/ea6b95d41f8\",\n \"age\": \"30\"\n }\n ]\n}" } ] } ] }, { "name": "Field", "item": [ { "name": "Create a Field", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"The name of the new field\",\n \"application_type\": \"shorttext\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/field", "description": "Creates a new field in the contact database. Please note that you cannot create single- or multi-choice fields via the API, nor can you create more than one field at a time.\n\n**Note:** The endpoint replicates the functionality of the **Field Generator** in the Emarsys application. To manage fields, go to **Admin** > **Field Editor** > **New**." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"The name of the new field\",\n \"application_type\": \"shorttext\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/field" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -49893849,\n \"replyText\": \"incididunt quis est dolor\",\n \"data\": {\n \"id\": 56976387\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"The name of the new field\",\n \"application_type\": \"shorttext\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/field" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "List Available Fields", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/field/translate/:languageId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "field", "translate", ":languageId" ], "variable": [ { "key": "languageId", "value": "en", "description": "(Required) The two-letter ISO 639-1 language code. See available [language codes](docs/appendix/language-codes.md).\n\n**Note:** Using the `/field` URI without the `translate/{languageId}` path returns the default English fields." } ] }, "description": "Generates a list of the available contact fields." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/field/translate/:languageId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "field", "translate", ":languageId" ], "variable": [ { "key": "languageId", "value": "en", "description": "(Required) The two-letter ISO 639-1 language code. See available [language codes](docs/appendix/language-codes.md).\n\n**Note:** Using the `/field` URI without the `translate/{languageId}` path returns the default English fields." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 66910711,\n \"replyText\": \"irure deserunt in\",\n \"data\": [\n {\n \"id\": \"aliquip dolore\",\n \"name\": \"velit rep\",\n \"application_type\": \"Duis aliqua pariatur in\"\n },\n {\n \"id\": \"dolore\",\n \"name\": \"dolor esse irure\",\n \"application_type\": \"adipisicing exercitation veniam labore\"\n }\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/field/translate/:languageId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "field", "translate", ":languageId" ], "variable": [ { "key": "languageId", "value": "en", "description": "(Required) The two-letter ISO 639-1 language code. See available [language codes](docs/appendix/language-codes.md).\n\n**Note:** Using the `/field` URI without the `translate/{languageId}` path returns the default English fields." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "List Available Choices of a Single-choice Field", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/field/:fieldID/choice/translate/:languageId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "field", ":fieldID", "choice", "translate", ":languageId" ], "variable": [ { "key": "fieldID", "value": "81739474", "description": "(Required) The field identifier." }, { "key": "languageId", "value": "en", "description": "(Required) The two-letter ISO 639-1 language code. See available [language codes](docs/appendix/language-codes.md).\n\n**Note:** Using the `/field/{fieldId}/choice` URI without the `translate/{languageId}` path returns the default English fields." } ] }, "description": "Generates a list of all available options for any given single- or multi-choice field.\n\n**Tip**: See [List customer forms](/reference/openapi.json/paths/~1v2~1form/get) for how to list forms and newsletters." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/field/:fieldID/choice/translate/:languageId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "field", ":fieldID", "choice", "translate", ":languageId" ], "variable": [ { "key": "fieldID", "value": "81739474", "description": "(Required) The field identifier." }, { "key": "languageId", "value": "en", "description": "(Required) The two-letter ISO 639-1 language code. See available [language codes](docs/appendix/language-codes.md).\n\n**Note:** Using the `/field/{fieldId}/choice` URI without the `translate/{languageId}` path returns the default English fields." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 19445938,\n \"replyText\": \"commodo occaecat tempor laboris\",\n \"data\": [\n {\n \"id\": \"culpa adipisicing quis occaecat\",\n \"choice\": \"dolor nostrud\",\n \"bit_position\": -24664577\n },\n {\n \"id\": \"adipisicing\",\n \"choice\": \"anim sit consequat occaecat labore\",\n \"bit_position\": 4035136\n }\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/field/:fieldID/choice/translate/:languageId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "field", ":fieldID", "choice", "translate", ":languageId" ], "variable": [ { "key": "fieldID", "value": "81739474", "description": "(Required) The field identifier." }, { "key": "languageId", "value": "en", "description": "(Required) The two-letter ISO 639-1 language code. See available [language codes](docs/appendix/language-codes.md).\n\n**Note:** Using the `/field/{fieldId}/choice` URI without the `translate/{languageId}` path returns the default English fields." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "List Available Choices of a Multiple-choice Field", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/field/choices?fields=81739474&language=en", "host": [ "{{baseUrl}}" ], "path": [ "v2", "field", "choices" ], "query": [ { "key": "fields", "value": "81739474", "description": "(Required) The field identifier." }, { "key": "language", "value": "en", "description": "(Required) The two-letter ISO 639-1 language code. For available language codes, see [Language codes](docs/appendix/language-codes.md).\n\n**Note:** Using the `/field/{fieldId}/choice` URI without the `translate/{languageId}` path returns the default English fields." } ] }, "description": "Generates a list of all available options for the specified multi-choice field.\n\n**Tip**: See [List customer forms](/reference/openapi.json/paths/~1v2~1form/get) for how to list forms and newsletters." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/field/choices?fields=81739474&language=en", "host": [ "{{baseUrl}}" ], "path": [ "v2", "field", "choices" ], "query": [ { "key": "fields", "value": "81739474" }, { "key": "language", "value": "en" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 64397709,\n \"replyText\": \"commodo eiusmod\",\n \"data\": {\n \"{fieldId}\": [\n {\n \"id\": \"ut minim\",\n \"choice\": \"deserunt\",\n \"bit_position\": 44343566\n },\n {\n \"id\": \"ex fugiat\",\n \"choice\": \"et consectetur\",\n \"bit_position\": -176043\n }\n ]\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/field/choices?fields=81739474&language=en", "host": [ "{{baseUrl}}" ], "path": [ "v2", "field", "choices" ], "query": [ { "key": "fields", "value": "81739474" }, { "key": "language", "value": "en" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Delete a Field", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/field/:fieldId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "field", ":fieldId" ], "variable": [ { "key": "fieldId", "value": "81739474", "description": "(Required) The identifier of the field to be deleted." } ] }, "description": "Deletes a custom contact field.\n\n**Important:** This action cannot be reverted, and removes all existing contact data associated with the field." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/field/:fieldId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "field", ":fieldId" ], "variable": [ { "key": "fieldId", "value": "81739474", "description": "(Required) The identifier of the field to be deleted." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/field/:fieldId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "field", ":fieldId" ], "variable": [ { "key": "fieldId", "value": "81739474", "description": "(Required) The identifier of the field to be deleted." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/field/:fieldId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "field", ":fieldId" ], "variable": [ { "key": "fieldId", "value": "81739474", "description": "(Required) The identifier of the field to be deleted." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "Filter", "item": [ { "name": "{segment Id}", "item": [ { "name": "contact criteria", "item": [ { "name": "Update Contact Criteria in a Segment", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"and\",\n \"children\": [\n {\n \"type\": \"criteria\",\n \"field\": \"gender\",\n \"operator\": \"equals\",\n \"value\": \"female\"\n },\n {\n \"type\": \"criteria\",\n \"field\": \"age\",\n \"operator\": \"greater_or_equal\",\n \"value\": \"22\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/contact_criteria", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "contact_criteria" ], "variable": [ { "key": "segmentId", "value": "81739474", "description": "(Required) The segment identifier.\n\n**Note:** The identifier must not be *0*." } ] }, "description": "Updates the contact criteria of a specific segment.\n\nFor details on how the response body is structured, see [Create a segment](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4NDY) endpoint." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"and\",\n \"children\": [\n {\n \"type\": \"criteria\",\n \"field\": \"gender\",\n \"operator\": \"equals\",\n \"value\": \"female\"\n },\n {\n \"type\": \"criteria\",\n \"field\": \"age\",\n \"operator\": \"greater_or_equal\",\n \"value\": \"22\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/contact_criteria", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "contact_criteria" ], "variable": [ { "key": "segmentId", "value": "81739474", "description": "(Required) The segment identifier.\n\n**Note:** The identifier must not be *0*." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -4520890,\n \"replyText\": \"elit ut et\",\n \"data\": {\n \"type\": \"or\",\n \"children\": [\n {\n \"type\": \"or\",\n \"field\": \"deserunt\",\n \"operator\": \"dolor esse nulla\",\n \"value\": \"sint ut\"\n },\n {\n \"type\": \"criteria\",\n \"field\": \"incididunt occaecat\",\n \"operator\": \"voluptate veniam exercitation consequat\",\n \"value\": \"in consectetur cillum\"\n }\n ]\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"and\",\n \"children\": [\n {\n \"type\": \"criteria\",\n \"field\": \"gender\",\n \"operator\": \"equals\",\n \"value\": \"female\"\n },\n {\n \"type\": \"criteria\",\n \"field\": \"age\",\n \"operator\": \"greater_or_equal\",\n \"value\": \"22\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/contact_criteria", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "contact_criteria" ], "variable": [ { "key": "segmentId", "value": "81739474", "description": "(Required) The segment identifier.\n\n**Note:** The identifier must not be *0*." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"and\",\n \"children\": [\n {\n \"type\": \"criteria\",\n \"field\": \"gender\",\n \"operator\": \"equals\",\n \"value\": \"female\"\n },\n {\n \"type\": \"criteria\",\n \"field\": \"age\",\n \"operator\": \"greater_or_equal\",\n \"value\": \"22\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/contact_criteria", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "contact_criteria" ], "variable": [ { "key": "segmentId", "value": "81739474", "description": "(Required) The segment identifier.\n\n**Note:** The identifier must not be *0*." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Get Segment Contact Criteria", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/contact_criteria", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "contact_criteria" ], "variable": [ { "key": "segmentId", "value": "81739474", "description": "(Required) The segment identifier.\n\n**Note:** The identifier must not be *0*." } ] }, "description": "Returns the contact criteria for the specified segment.\n\nFor details on how the response body is structured, see [Create a segment](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4NDY) endpoint." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/contact_criteria", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "contact_criteria" ], "variable": [ { "key": "segmentId", "value": "81739474", "description": "(Required) The segment identifier.\n\n**Note:** The identifier must not be *0*." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 6154820,\n \"replyText\": \"ad sed proident\",\n \"data\": {\n \"type\": \"and\",\n \"children\": [\n {\n \"type\": \"and\",\n \"field\": \"eu occaecat\",\n \"operator\": \"fugiat pariatur\",\n \"value\": \"ut minim anim ea\"\n },\n {\n \"type\": \"criteria\",\n \"field\": \"enim ad eiusmod\",\n \"operator\": \"elit ut cillum reprehenderit\",\n \"value\": \"consectetur cupidatat non\"\n }\n ]\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/contact_criteria", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "contact_criteria" ], "variable": [ { "key": "segmentId", "value": "81739474", "description": "(Required) The segment identifier.\n\n**Note:** The identifier must not be *0*." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/contact_criteria", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "contact_criteria" ], "variable": [ { "key": "segmentId", "value": "81739474", "description": "(Required) The segment identifier.\n\n**Note:** The identifier must not be *0*." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "contacts", "item": [ { "name": "Count Contacts in a Segment", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/contacts/count", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "contacts", "count" ], "variable": [ { "key": "segmentId", "value": "81739474", "description": "(Required) The segment identifier." } ] }, "description": "Provides the number of contacts in the specified segment.\n\n**Note:** This endpoint does not return data immediately because it requires further processing." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/contacts/count", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "contacts", "count" ], "variable": [ { "key": "segmentId", "value": "81739474", "description": "(Required) The segment identifier." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 7120974,\n \"replyText\": \"dolore officia do\",\n \"data\": -95152054\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/contacts/count", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "contacts", "count" ], "variable": [ { "key": "segmentId", "value": "81739474", "description": "(Required) The segment identifier." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Look Up a Contact in a Segment", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/contacts/:contactId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "contacts", ":contactId" ], "variable": [ { "key": "segmentId", "value": "81739474", "description": "(Required) The segment identifier." }, { "key": "contactId", "value": "81739474", "description": "(Required) The contact identifier (`id`)." } ] }, "description": "Looks up a specific contact in a segment. If the segment includes the contact, returns `true`, otherwise returns `false`." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/contacts/:contactId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "contacts", ":contactId" ], "variable": [ { "key": "segmentId", "value": "81739474", "description": "(Required) The segment identifier." }, { "key": "contactId", "value": "81739474", "description": "(Required) The contact identifier (`id`)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 3393586,\n \"replyText\": \"laboris ullamco minim\",\n \"data\": true\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/contacts/:contactId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "contacts", ":contactId" ], "variable": [ { "key": "segmentId", "value": "81739474", "description": "(Required) The segment identifier." }, { "key": "contactId", "value": "81739474", "description": "(Required) The contact identifier (`id`)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "List Segments", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId" ], "variable": [ { "key": "segmentId", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) The identifier of the segment. If provided, returns the details of the specified only." } ] }, "description": "Generates a list of segments." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId" ], "variable": [ { "key": "segmentId", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) The identifier of the segment. If provided, returns the details of the specified only." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -67586624,\n \"replyText\": \"non in\",\n \"data\": [\n {\n \"id\": -20753017,\n \"name\": \"aute\",\n \"type\": \"ea ut sed\",\n \"tags\": [\n \"ai\",\n \"ai\"\n ],\n \"criteriaTypes\": \"geo\",\n \"baseContactListId\": 91783744,\n \"predefinedSegmentId\": -14746753\n },\n {\n \"id\": 358436,\n \"name\": \"laborum magna commodo aute\",\n \"type\": \"officia ipsum esse\",\n \"tags\": [\n \"ai\",\n \"ai\"\n ],\n \"criteriaTypes\": \"geo\",\n \"baseContactListId\": 90531178,\n \"predefinedSegmentId\": -69043500\n }\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId" ], "variable": [ { "key": "segmentId", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) The identifier of the segment. If provided, returns the details of the specified only." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Delete a Segment", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "delete" ], "variable": [ { "key": "segmentId", "value": "81739474", "description": "(Required) The segment identifier." } ] } }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "delete" ], "variable": [ { "key": "segmentId", "value": "81739474", "description": "(Required) The segment identifier." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "delete" ], "variable": [ { "key": "segmentId", "value": "81739474", "description": "(Required) The segment identifier." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "delete" ], "variable": [ { "key": "segmentId", "value": "81739474", "description": "(Required) The segment identifier." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Run a Segment for a Single Contact", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/single_runs?contact_id=-24187902.757311657", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "single_runs" ], "query": [ { "key": "contact_id", "value": "-24187902.757311657", "description": "Checks whether the contact specified by its internal identifier is included in the segment. Use the [List Contact Data](reference/openapi.json/paths/~1v2~1contact~1query~1/get) or the [Get Internal Contact Identifiers](/reference/openapi.json/paths/~1v2~1contact~1query~1{keyId}={keyValue}/get) endpoint to get the internal identifier." } ], "variable": [ { "key": "segmentId", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) The identifier of the segment to run. Use the [List segments](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4NDk) endpoint to get the identifier." } ] }, "description": "Checks whether the specified contact is included in a segment and starts the segment running process.\n\n**Important:** Depending on the composition of the segment, the running time may take hours. Use the [Poll the status of a segment run for a single contact](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4NTk) endpoint to check the status." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/single_runs?contact_id=-24187902.757311657", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "single_runs" ], "query": [ { "key": "contact_id", "value": "-24187902.757311657" } ], "variable": [ { "key": "segmentId", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) The identifier of the segment to run. Use the [List segments](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4NDk) endpoint to get the identifier." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"esse ea ipsum veniam\",\n \"data\": {\n \"run_id\": \"quis culpa est\",\n \"status\": \"done\"\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/single_runs?contact_id=-24187902.757311657", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "single_runs" ], "query": [ { "key": "contact_id", "value": "-24187902.757311657" } ], "variable": [ { "key": "segmentId", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) The identifier of the segment to run. Use the [List segments](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4NDk) endpoint to get the identifier." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/single_runs?contact_id=-24187902.757311657", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "single_runs" ], "query": [ { "key": "contact_id", "value": "-24187902.757311657" } ], "variable": [ { "key": "segmentId", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) The identifier of the segment to run. Use the [List segments](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4NDk) endpoint to get the identifier." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Run a Segment for Multiple Contacts", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/runs", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "runs" ], "variable": [ { "key": "segmentId", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) The identifier of the segment to run. Use the [List segments](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4NDk) endpoint to get the identifier." } ] }, "description": "Starts the segment calculation process and returns information on the included contacts.\n\n**Important:** Depending on the composition of the segment, the running time may take hours. Use the [Poll the Status of a Segment Run for Multiple Contacts](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4NjE) endpoint to check the status." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/runs", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "runs" ], "variable": [ { "key": "segmentId", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) The identifier of the segment to run. Use the [List segments](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4NDk) endpoint to get the identifier." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"esse ea ipsum veniam\",\n \"data\": {\n \"run_id\": \"quis culpa est\",\n \"status\": \"done\"\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/filter/:segmentId/runs", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", ":segmentId", "runs" ], "variable": [ { "key": "segmentId", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) The identifier of the segment to run. Use the [List segments](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4NDk) endpoint to get the identifier." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "Create a Segment", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"summer_sale\",\n \"description\": \"gender_based\",\n \"baseContactListId\": \"123456\",\n \"contactCriteria\": {\n \"type\": \"and\",\n \"children\": [\n {\n \"type\": \"criteria\",\n \"field\": \"gender\",\n \"operator\": \"equals\",\n \"value\": \"male\"\n },\n {\n \"type\": \"and\",\n \"children\": [\n {\n \"type\": \"and\",\n \"children\": [\n {\n \"type\": \"criteria\",\n \"field\": \"email\",\n \"operator\": \"not_empty\",\n \"value\": \"is_not_empty\"\n },\n {\n \"type\": \"criteria\",\n \"field\": \"email\",\n \"operator\": \"contains\",\n \"value\": \"@gmail.com\"\n },\n {\n \"type\": \"criteria\",\n \"field\": \"email_valid\",\n \"operator\": \"equals\",\n \"value\": \"true\"\n },\n {\n \"type\": \"criteria\",\n \"field\": \"optin\",\n \"operator\": \"equals\",\n \"value\": \"true\"\n },\n {\n \"criteria\": \"response_open_click\",\n \"type\": \"criteria\",\n \"time_restriction\": \"between_dates\",\n \"from_date\": \"2016-08-26\",\n \"to_date\": \"2016-08-31\"\n },\n {\n \"criteria\": \"response_click\",\n \"type\": \"criteria\",\n \"time_restriction\": \"between_days\",\n \"from_day\": \"0\",\n \"to_day\": \"3\"\n },\n {\n \"criteria\": \"bounce\",\n \"type\": \"criteria\",\n \"time_restriction\": \"last_days\",\n \"from_day\": \"0\"\n }\n ]\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/filter", "description": "Creates a segment based on the specified contact and email behavior criteria.\n\n### Overview\nCritera are represented as JSON object nodes in the request body. The relationship between the nodes is defined by the following:\n- Grouping operators link filter conditions with a logical AND or OR operator using the `type` property.\n- The node hierarchy correspond to the structure of the filters.\n\nFor easier understanding of the nested contact criteria, see the configuration of filter conditions in the Emarsys application:\n\n![Filter conditions in the Emarsys application](https://raw.githubusercontent.com/emartech/developer-hub-public-assets/master/assets/images/filter-conditions.png \"Filter conditions in the Emarsys application\")\n\n### Node Structure\nNodes can either be conjunctive or a criteria nodes. The function of each node is defined in the `type` property.\n- **Conjunctive nodes:** Nodes with a grouping operator `and` or `or` establish the relationship between parent and children nodes, and do not have any other property.\n- **Criteria nodes:** Nodes with the `criteria` property define a filter condition.\n\n| Criterion Type | Mandatory Properties | Optional Properties |\n| --- | --- | --- |\n| Contact criteria | - field
- operator
- value ||\n| Behavior criteria | - criteria | - time_restriction |\n\n**Important:**\n- Either one contact or behavior criteria must be specified in the request.\n- Nested nodes are specified in a `children` array of the JSON payload. See the Request Body section for details.\n\n**Note:** Mobile behavior, geolocation, and Smart Insight criteria are not supported using the API at the moment." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"summer_sale\",\n \"description\": \"gender_based\",\n \"baseContactListId\": \"123456\",\n \"contactCriteria\": {\n \"type\": \"and\",\n \"children\": [\n {\n \"type\": \"criteria\",\n \"field\": \"gender\",\n \"operator\": \"equals\",\n \"value\": \"male\"\n },\n {\n \"type\": \"and\",\n \"children\": [\n {\n \"type\": \"and\",\n \"children\": [\n {\n \"type\": \"criteria\",\n \"field\": \"email\",\n \"operator\": \"not_empty\",\n \"value\": \"is_not_empty\"\n },\n {\n \"type\": \"criteria\",\n \"field\": \"email\",\n \"operator\": \"contains\",\n \"value\": \"@gmail.com\"\n },\n {\n \"type\": \"criteria\",\n \"field\": \"email_valid\",\n \"operator\": \"equals\",\n \"value\": \"true\"\n },\n {\n \"type\": \"criteria\",\n \"field\": \"optin\",\n \"operator\": \"equals\",\n \"value\": \"true\"\n },\n {\n \"criteria\": \"response_open_click\",\n \"type\": \"criteria\",\n \"time_restriction\": \"between_dates\",\n \"from_date\": \"2016-08-26\",\n \"to_date\": \"2016-08-31\"\n },\n {\n \"criteria\": \"response_click\",\n \"type\": \"criteria\",\n \"time_restriction\": \"between_days\",\n \"from_day\": \"0\",\n \"to_day\": \"3\"\n },\n {\n \"criteria\": \"bounce\",\n \"type\": \"criteria\",\n \"time_restriction\": \"last_days\",\n \"from_day\": \"0\"\n }\n ]\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/filter" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"summer_sale\",\n \"description\": \"gender_based\",\n \"baseContactListId\": \"123456\",\n \"contactCriteria\": {\n \"type\": \"and\",\n \"children\": [\n {\n \"type\": \"criteria\",\n \"field\": \"gender\",\n \"operator\": \"equals\",\n \"value\": \"male\"\n },\n {\n \"type\": \"and\",\n \"children\": [\n {\n \"type\": \"and\",\n \"children\": [\n {\n \"type\": \"criteria\",\n \"field\": \"email\",\n \"operator\": \"not_empty\",\n \"value\": \"is_not_empty\"\n },\n {\n \"type\": \"criteria\",\n \"field\": \"email\",\n \"operator\": \"contains\",\n \"value\": \"@gmail.com\"\n },\n {\n \"type\": \"criteria\",\n \"field\": \"email_valid\",\n \"operator\": \"equals\",\n \"value\": \"true\"\n },\n {\n \"type\": \"criteria\",\n \"field\": \"optin\",\n \"operator\": \"equals\",\n \"value\": \"true\"\n },\n {\n \"criteria\": \"response_open_click\",\n \"type\": \"criteria\",\n \"time_restriction\": \"between_dates\",\n \"from_date\": \"2016-08-26\",\n \"to_date\": \"2016-08-31\"\n },\n {\n \"criteria\": \"response_click\",\n \"type\": \"criteria\",\n \"time_restriction\": \"between_days\",\n \"from_day\": \"0\",\n \"to_day\": \"3\"\n },\n {\n \"criteria\": \"bounce\",\n \"type\": \"criteria\",\n \"time_restriction\": \"last_days\",\n \"from_day\": \"0\"\n }\n ]\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/filter" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Poll the Status of a Segment Run for a Single Contact", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/filter/single_runs/:runId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", "single_runs", ":runId" ], "variable": [ { "key": "runId", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) The identifier of the segment run. Get this identifier on the [Run a segment for a single contact](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4NTg) endpoint to start the segment caclulation process." } ] }, "description": "Poll this endpoint to check the status of a started segment run of a single contact. Once the process is completed, returns whether the specified contact is included in the segment.\n \n **Note:** Use the [Run a segment for a single contact](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4NTg) endpoint to initiate the segment run and specify the contact." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/filter/single_runs/:runId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", "single_runs", ":runId" ], "variable": [ { "key": "runId", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) The identifier of the segment run. Get this identifier on the [Run a segment for a single contact](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4NTg) endpoint to start the segment caclulation process." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"ullamco dolor\",\n \"data\": {\n \"status\": \"done\",\n \"result\": {\n \"is_in_segment\": true\n },\n \"run_id\": \"consectetur in\"\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/filter/single_runs/:runId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", "single_runs", ":runId" ], "variable": [ { "key": "runId", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) The identifier of the segment run. Get this identifier on the [Run a segment for a single contact](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4NTg) endpoint to start the segment caclulation process." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Poll the Status of a Segment Run for Multiple Contacts", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/filter/runs/:runId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", "runs", ":runId" ], "variable": [ { "key": "runId", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) The identifier of the segment run. Get this identifier on the [Run a Segment for Multiple Contacts](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4NjE) endpoint to start the segment caclulation process." } ] }, "description": "Poll this endpoint to check the status of a started segment run of multiple contacts. Once the process is completed, returns information on the contacts included in the segment.\n \n **Note:** Use the [Run a Segment for Multiple Contacts](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4NjA-run-a-segment-for-multiple-contacts) endpoint to initiate the segment run.\n \n **Note:** The contact list created as a result of the segment run is available for at least 12 hours. You can find its ID in the response: `contact_list_id`." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/filter/runs/:runId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", "runs", ":runId" ], "variable": [ { "key": "runId", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) The identifier of the segment run. Get this identifier on the [Run a Segment for Multiple Contacts](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4NjE) endpoint to start the segment caclulation process." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"consectetur\",\n \"data\": {\n \"status\": \"error\",\n \"result\": {\n \"contact_list_id\": 3251688.437765628,\n \"user_count\": -43151846.28021771,\n \"opt_in_count\": 22283638.008738607,\n \"duration\": 25900616.68750608\n },\n \"run_id\": \"L\"\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/filter/runs/:runId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "filter", "runs", ":runId" ], "variable": [ { "key": "runId", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) The identifier of the segment run. Get this identifier on the [Run a Segment for Multiple Contacts](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4NjE) endpoint to start the segment caclulation process." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "Form", "item": [ { "name": "List Customer Forms", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/v2/form", "description": "Generates a list of all available forms designed to collect data from contacts, such as registration forms in a web page." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/form" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -92567363,\n \"replyText\": \"qui dolore pariatur ipsum\",\n \"data\": [\n {\n \"id\": 34299167,\n \"type\": 3\n },\n {\n \"id\": 41647344,\n \"type\": 4\n }\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/form" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Trigger Contact Registration", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"3\",\n \"external_id\": \"mycontact@example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/form/:formId/trigger", "host": [ "{{baseUrl}}" ], "path": [ "v2", "form", ":formId", "trigger" ], "variable": [ { "key": "formId", "value": "81739474", "description": "(Required) The identifier of the form as the source of registration." } ] }, "description": "Registers a contact in a form and triggers assigned campaigns. For details on the functionality, see [New Contact Registrations](https://help.emarsys.com/hc/en-us/articles/115005198989-New-Contact-Registrations)." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"3\",\n \"external_id\": \"mycontact@example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/form/:formId/trigger", "host": [ "{{baseUrl}}" ], "path": [ "v2", "form", ":formId", "trigger" ], "variable": [ { "key": "formId", "value": "81739474", "description": "(Required) The identifier of the form as the source of registration." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 55832129,\n \"replyText\": \"in occaecat\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"3\",\n \"external_id\": \"mycontact@example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/form/:formId/trigger", "host": [ "{{baseUrl}}" ], "path": [ "v2", "form", ":formId", "trigger" ], "variable": [ { "key": "formId", "value": "81739474", "description": "(Required) The identifier of the form as the source of registration." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "Keys and keyring", "item": [ { "name": "List Keys in the Keyring", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/v2/keyring/keys", "description": "Lists all keys in the keyring for SFTP key-based authentication.\n\n**Note:** This feature is in the pilot phase and currently available for a limited number of clients only. If you are interested in participating, contact Emarsys support.\n\n**Important:** Access to administrative endpoints is restricted. If you need access, contact Emarsys support." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/keyring/keys" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 60347545,\n \"replyText\": \"nisi aute consequat ut\",\n \"data\": [\n {\n \"id\": \"incididunt ex ut s\",\n \"comment\": \"adipisicing cillum\",\n \"created\": \"reprehend\"\n },\n {\n \"id\": \"mollit eu commodo sint minim\",\n \"comment\": \"minim nisi proident\",\n \"created\": \"in dolore\"\n }\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/keyring/keys" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Create a Key in the Keyring", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"comment\": \"key_0\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/settings/keyrings", "description": "Creates and returns a new key in the keyring for SFTP key-based authentication.\n\n**Note:** This feature is in the pilot phase and currently available for a limited number of clients only. If you are interested in participating, contact Emarsys support.\n\n**Important:** Access to administrative endpoints is restricted. If you need access, contact Emarsys support." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"comment\": \"key_0\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/settings/keyrings" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -70405937,\n \"replyText\": \"ullamco commodo dolore consectetur\",\n \"data\": {\n \"id\": \"Lorem sunt in laboris\",\n \"comment\": \"ipsum ut\",\n \"created\": \"exercitation aute\",\n \"ssh_fingerprint\": \"ex m\",\n \"ssh_public_key\": \"mollit\"\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"comment\": \"key_0\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/settings/keyrings" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Retrieve a Key from the Keyring", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/settings/keyring/keys/:keyId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "settings", "keyring", "keys", ":keyId" ], "variable": [ { "key": "keyId", "value": "81739474", "description": "(Required) The identifier of the key." } ] }, "description": "Returns a key from the keyring for SFTP key-based authentication.\n\n**Note:** This feature is in the pilot phase and currently available for a limited number of clients only. If you are interested in participating, contact Emarsys support.\n\n**Important:** Access to administrative endpoints is restricted. If you need access, contact Emarsys support." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/settings/keyring/keys/:keyId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "settings", "keyring", "keys", ":keyId" ], "variable": [ { "key": "keyId", "value": "81739474", "description": "(Required) The identifier of the key." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -70405937,\n \"replyText\": \"ullamco commodo dolore consectetur\",\n \"data\": {\n \"id\": \"Lorem sunt in laboris\",\n \"comment\": \"ipsum ut\",\n \"created\": \"exercitation aute\",\n \"ssh_fingerprint\": \"ex m\",\n \"ssh_public_key\": \"mollit\"\n }\n}" } ] }, { "name": "Delete a Key from the Keyring", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/keyring/keys/:keyId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keyring", "keys", ":keyId", "delete" ], "variable": [ { "key": "keyId", "value": "81739474", "description": "(Required) The identifier of the key." } ] }, "description": "Deletes a single key from the keyring.\n\n**Note:** This feature is in the pilot phase and currently available for a limited number of clients only. If you are interested in participating, contact Emarsys support.\n\n**Important:** Access to administrative endpoints is restricted. If you need access, contact Emarsys support." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/keyring/keys/:keyId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keyring", "keys", ":keyId", "delete" ], "variable": [ { "key": "keyId", "value": "81739474", "description": "(Required) The identifier of the key." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/keyring/keys/:keyId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "keyring", "keys", ":keyId", "delete" ], "variable": [ { "key": "keyId", "value": "81739474", "description": "(Required) The identifier of the key." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "Media db", "item": [ { "name": "Database folder", "item": [ { "name": "Create a Media Database Folder", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Assets\",\n \"parent\": 12341234\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/folder", "description": "Creates a new folder in a specified existing parent folder in the Media Database." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Assets\",\n \"parent\": 12341234\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/folder" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 10061949,\n \"replyText\": \"Ut irure quis pariatur\",\n \"data\": {\n \"id\": 79063425\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Assets\",\n \"parent\": 12341234\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/folder" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "List Media Database Folders", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/folder?folder=81739474", "host": [ "{{baseUrl}}" ], "path": [ "v2", "folder" ], "query": [ { "key": "folder", "value": "81739474", "description": "The folder identifier. If provided, only subfolders of the specified folder are listed." } ] }, "description": "Returns a list of all folders in the Media Database.\n\n**Tip:** Use the `folder` query parameter to only list subfolders of a specific folder." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/folder?folder=81739474", "host": [ "{{baseUrl}}" ], "path": [ "v2", "folder" ], "query": [ { "key": "folder", "value": "81739474" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -1311396,\n \"replyText\": \"esse fugiat pariatur\",\n \"data\": [\n {\n \"id\": -66958222,\n \"parent\": -18445079,\n \"name\": \"tempor quis Ut\"\n },\n {\n \"id\": 6970554,\n \"parent\": -10230582,\n \"name\": \"velit do\"\n }\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/folder?folder=81739474", "host": [ "{{baseUrl}}" ], "path": [ "v2", "folder" ], "query": [ { "key": "folder", "value": "81739474" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "Database file", "item": [ { "name": "{file Id}", "item": [ { "name": "Get a Media Database File", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/file/:fileId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "file", ":fileId" ], "variable": [ { "key": "fileId", "value": "81739474", "description": "(Required) The identifier of the file." } ] }, "description": "Returns the properties of a media file in the Media Database." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/file/:fileId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "file", ":fileId" ], "variable": [ { "key": "fileId", "value": "81739474", "description": "(Required) The identifier of the file." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 97525696,\n \"replyText\": \"dolore occaecat in\",\n \"data\": {\n \"id\": 25073479,\n \"folder\": 62349186,\n \"filename\": \"culpa ad qui\",\n \"size\": -74847291,\n \"original_name\": \"veniam aliqua Excepteur ullamco\",\n \"url\": \"esse c\"\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/file/:fileId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "file", ":fileId" ], "variable": [ { "key": "fileId", "value": "81739474", "description": "(Required) The identifier of the file." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Delete a Media Database File", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/file/:fileId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "file", ":fileId", "delete" ], "variable": [ { "key": "fileId", "value": "81739474", "description": "(Required) The identifier of the file." } ] }, "description": "Removes a media file from the Media Database." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/file/:fileId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "file", ":fileId", "delete" ], "variable": [ { "key": "fileId", "value": "81739474", "description": "(Required) The identifier of the file." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/file/:fileId/delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "file", ":fileId", "delete" ], "variable": [ { "key": "fileId", "value": "81739474", "description": "(Required) The identifier of the file." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "Upload a File into the Media Database", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"folder\": 840559,\n \"filename\": \"logo.png\",\n \"file\": \"Dm++/vUMBAQEBAQEBAQEBAQEBAQAQEAQEBAQEBAQEBAQEBAcO/w4Dvv70RCO+/veKCrO+/veKCrAMBIgRAQ==…\",\n \"preserve_filename\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/file", "description": "Uploads a file to the Media Database in Base64 encoding.\n\n**Notes**\n- File names are case sensitive.\n- The upload limit is 1 MB for images, 8 MB for documents, and 4 MB for other file formats.\n- Refer to uploaded files in email campaigns in the following format:\n ```\n \n ```" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"folder\": 840559,\n \"filename\": \"logo.png\",\n \"file\": \"Dm++/vUMBAQEBAQEBAQEBAQEBAQAQEAQEBAQEBAQEBAQEBAcO/w4Dvv70RCO+/veKCrO+/veKCrAMBIgRAQ==…\",\n \"preserve_filename\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/file" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -69946036,\n \"replyText\": \"commodo consectetur tempor anim\",\n \"data\": [\n {\n \"id\": \"incididunt consequat Duis labore\",\n \"folder\": \"sed magna velit\",\n \"filename\": \"Duis qui est\",\n \"size\": \"ea irure\",\n \"original_name\": \"elit est occaecat quis ad\"\n },\n {\n \"id\": \"laboris veniam\",\n \"folder\": \"ipsum\",\n \"filename\": \"consequat\",\n \"size\": \"ullamco consectetur ad\",\n \"original_name\": \"in quis amet\"\n }\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"folder\": 840559,\n \"filename\": \"logo.png\",\n \"file\": \"Dm++/vUMBAQEBAQEBAQEBAQEBAQAQEAQEBAQEBAQEBAQEBAcO/w4Dvv70RCO+/veKCrO+/veKCrAMBIgRAQ==…\",\n \"preserve_filename\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/file" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "List Media Database Files", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/file/?folder=81739474", "host": [ "{{baseUrl}}" ], "path": [ "v2", "file", "" ], "query": [ { "key": "folder", "value": "81739474", "description": "The folder identifier. If provided, only files in the specified folder are listed." } ] }, "description": "Returns a list of all media files in the Media Database.\n\n**Tip:** Use the `folder` query parameter to only list files in a specific folder." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/file/?folder=81739474", "host": [ "{{baseUrl}}" ], "path": [ "v2", "file", "" ], "query": [ { "key": "folder", "value": "81739474" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -93756094,\n \"replyText\": \"ipsum reprehenderit\",\n \"data\": [\n {\n \"id\": -31408782,\n \"folder\": -78746432,\n \"filename\": \"eu exercitati\",\n \"size\": -87360027,\n \"original_name\": \"Duis in nisi\",\n \"url\": \"labore cupidatat anim occaecat adipisicing\"\n },\n {\n \"id\": 93250474,\n \"folder\": 33083490,\n \"filename\": \"id sint non do\",\n \"size\": 33383194,\n \"original_name\": \"mollit deserunt labore in dolor\",\n \"url\": \"occaecat est\"\n }\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/file/?folder=81739474", "host": [ "{{baseUrl}}" ], "path": [ "v2", "file", "" ], "query": [ { "key": "folder", "value": "81739474" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] } ] }, { "name": "Relational data", "item": [ { "name": "Insert Records into an RDS Table", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"Joe\",\n \"age\": 34\n },\n {\n \"name\": \"Mary\",\n \"age\": null\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rds/connections/:connectionName/tables/:tableName/records", "host": [ "{{baseUrl}}" ], "path": [ "rds", "connections", ":connectionName", "tables", ":tableName", "records" ], "variable": [ { "key": "connectionName", "value": "id", "description": "(Required) The name of the connection to the Relational Data Service." }, { "key": "tableName", "value": "id", "description": "(Required) The name of the table in the Relational Data Service." } ] }, "description": "Inserts the records into a custom table in the Relational Data Service (RDS). Records that violate any constraints on the table are ignored. For example, new records that have a conflicting primary key with an existing record are not inserted.\n\nThis feature is only available for subscribed customers. For further information, contact your account manager.\n\n**Note:** The maximum number of objects per request is 1000." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/rds/connections/:connectionName/tables/:tableName/records", "host": [ "{{baseUrl}}" ], "path": [ "rds", "connections", ":connectionName", "tables", ":tableName", "records" ], "variable": [ { "key": "connectionName", "value": "id", "description": "(Required) The name of the connection to the Relational Data Service." }, { "key": "tableName", "value": "id", "description": "(Required) The name of the table in the Relational Data Service." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"dolor aliquip anim laboris ess\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/rds/connections/:connectionName/tables/:tableName/records", "host": [ "{{baseUrl}}" ], "path": [ "rds", "connections", ":connectionName", "tables", ":tableName", "records" ], "variable": [ { "key": "connectionName", "value": "id", "description": "(Required) The name of the connection to the Relational Data Service." }, { "key": "tableName", "value": "id", "description": "(Required) The name of the table in the Relational Data Service." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"dolor aliquip anim laboris ess\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/rds/connections/:connectionName/tables/:tableName/records", "host": [ "{{baseUrl}}" ], "path": [ "rds", "connections", ":connectionName", "tables", ":tableName", "records" ], "variable": [ { "key": "connectionName", "value": "id", "description": "(Required) The name of the connection to the Relational Data Service." }, { "key": "tableName", "value": "id", "description": "(Required) The name of the table in the Relational Data Service." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"dolor aliquip anim laboris ess\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/rds/connections/:connectionName/tables/:tableName/records", "host": [ "{{baseUrl}}" ], "path": [ "rds", "connections", ":connectionName", "tables", ":tableName", "records" ], "variable": [ { "key": "connectionName", "value": "id", "description": "(Required) The name of the connection to the Relational Data Service." }, { "key": "tableName", "value": "id", "description": "(Required) The name of the table in the Relational Data Service." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Query Records in an RDS Table", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rds/connections/:connectionName/tables/:tableName/records?{keyField}=id", "host": [ "{{baseUrl}}" ], "path": [ "rds", "connections", ":connectionName", "tables", ":tableName", "records" ], "query": [ { "key": "{keyField}", "value": "id", "description": "(Required) The name of the key field and its value used as search criteria.\n\n**Notes**\n- Only exact matches are supported.\n- Key fields must be indexed, assuming that indexing is available for the database type of the connection.\n- Append multiple key-value pairs separated by an ampersand to add multiple search criteria.\n\n**Example**\n```\n?{key_field_1}={value_1}&{key_field_2}={value_2}\n```" } ], "variable": [ { "key": "connectionName", "value": "id", "description": "(Required) The name of the connection to the Relational Data Service." }, { "key": "tableName", "value": "id", "description": "(Required) The name of the table in the Relational Data Service." } ] }, "description": "Returns the records from a custom table in the Relational Data Service (RDS).\n\nThis feature is only available for subscribed customers. For further information, contact your account manager.\n\n**Note:** Results are not paged. The maximum number of objects per request is 1000." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/rds/connections/:connectionName/tables/:tableName/records?{keyField}=id", "host": [ "{{baseUrl}}" ], "path": [ "rds", "connections", ":connectionName", "tables", ":tableName", "records" ], "query": [ { "key": "{keyField}", "value": "id" } ], "variable": [ { "key": "connectionName", "value": "id", "description": "(Required) The name of the connection to the Relational Data Service." }, { "key": "tableName", "value": "id", "description": "(Required) The name of the table in the Relational Data Service." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"dolor aliquip anim laboris ess\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/rds/connections/:connectionName/tables/:tableName/records?{keyField}=id", "host": [ "{{baseUrl}}" ], "path": [ "rds", "connections", ":connectionName", "tables", ":tableName", "records" ], "query": [ { "key": "{keyField}", "value": "id" } ], "variable": [ { "key": "connectionName", "value": "id", "description": "(Required) The name of the connection to the Relational Data Service." }, { "key": "tableName", "value": "id", "description": "(Required) The name of the table in the Relational Data Service." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"dolor aliquip anim laboris ess\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/rds/connections/:connectionName/tables/:tableName/records?{keyField}=id", "host": [ "{{baseUrl}}" ], "path": [ "rds", "connections", ":connectionName", "tables", ":tableName", "records" ], "query": [ { "key": "{keyField}", "value": "id" } ], "variable": [ { "key": "connectionName", "value": "id", "description": "(Required) The name of the connection to the Relational Data Service." }, { "key": "tableName", "value": "id", "description": "(Required) The name of the table in the Relational Data Service." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"dolor aliquip anim laboris ess\"\n}" } ] }, { "name": "Replace an RDS Table", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"Joe\",\n \"age\": 34\n },\n {\n \"name\": \"Mary\",\n \"age\": null\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rds/connections/:connectionName/tables/:tableName/records", "host": [ "{{baseUrl}}" ], "path": [ "rds", "connections", ":connectionName", "tables", ":tableName", "records" ], "variable": [ { "key": "connectionName", "value": "id", "description": "(Required) The name of the connection to the Relational Data Service." }, { "key": "tableName", "value": "id", "description": "(Required) The name of the table in the Relational Data Service." } ] }, "description": "Replaces a custom table with the provided records in the Relational Data Service (RDS).\n\nThis feature is only available for subscribed customers. For further information, contact your account manager.\n\n**Important:** This call deletes all previous records from the table.\n\n**Note:** The maximum number of objects per request is 1000." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/rds/connections/:connectionName/tables/:tableName/records", "host": [ "{{baseUrl}}" ], "path": [ "rds", "connections", ":connectionName", "tables", ":tableName", "records" ], "variable": [ { "key": "connectionName", "value": "id", "description": "(Required) The name of the connection to the Relational Data Service." }, { "key": "tableName", "value": "id", "description": "(Required) The name of the table in the Relational Data Service." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"dolor aliquip anim laboris ess\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/rds/connections/:connectionName/tables/:tableName/records", "host": [ "{{baseUrl}}" ], "path": [ "rds", "connections", ":connectionName", "tables", ":tableName", "records" ], "variable": [ { "key": "connectionName", "value": "id", "description": "(Required) The name of the connection to the Relational Data Service." }, { "key": "tableName", "value": "id", "description": "(Required) The name of the table in the Relational Data Service." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"dolor aliquip anim laboris ess\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/rds/connections/:connectionName/tables/:tableName/records", "host": [ "{{baseUrl}}" ], "path": [ "rds", "connections", ":connectionName", "tables", ":tableName", "records" ], "variable": [ { "key": "connectionName", "value": "id", "description": "(Required) The name of the connection to the Relational Data Service." }, { "key": "tableName", "value": "id", "description": "(Required) The name of the table in the Relational Data Service." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"dolor aliquip anim laboris ess\"\n}" } ] }, { "name": "Upsert Records in an RDS Table", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1,\n \"name\": \"Joe\",\n \"age\": 34\n },\n {\n \"id\": 2,\n \"name\": \"Mary\",\n \"age\": null\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rds/connections/:connectionName/tables/:tableName/records/upsert", "host": [ "{{baseUrl}}" ], "path": [ "rds", "connections", ":connectionName", "tables", ":tableName", "records", "upsert" ], "variable": [ { "key": "connectionName", "value": "id", "description": "(Required) The name of the connection to the Relational Data Service." }, { "key": "tableName", "value": "id", "description": "(Required) The name of the table in the Relational Data Service." } ] }, "description": "Inserts and updates records in a custom table in the Relational Data Service (RDS).\n\nThis feature is only available for subscribed customers. For further information, contact your account manager.\n\n**Notes**\n- The maximum number of objects per request is 1000.\n- Table structures are not returned on this endpoint. Therefore, you must know the primary key column(s) defined in the table you are accessing." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1,\n \"name\": \"Joe\",\n \"age\": 34\n },\n {\n \"id\": 2,\n \"name\": \"Mary\",\n \"age\": null\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rds/connections/:connectionName/tables/:tableName/records/upsert", "host": [ "{{baseUrl}}" ], "path": [ "rds", "connections", ":connectionName", "tables", ":tableName", "records", "upsert" ], "variable": [ { "key": "connectionName", "value": "id", "description": "(Required) The name of the connection to the Relational Data Service." }, { "key": "tableName", "value": "id", "description": "(Required) The name of the table in the Relational Data Service." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"dolor aliquip anim laboris ess\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1,\n \"name\": \"Joe\",\n \"age\": 34\n },\n {\n \"id\": 2,\n \"name\": \"Mary\",\n \"age\": null\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rds/connections/:connectionName/tables/:tableName/records/upsert", "host": [ "{{baseUrl}}" ], "path": [ "rds", "connections", ":connectionName", "tables", ":tableName", "records", "upsert" ], "variable": [ { "key": "connectionName", "value": "id", "description": "(Required) The name of the connection to the Relational Data Service." }, { "key": "tableName", "value": "id", "description": "(Required) The name of the table in the Relational Data Service." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"dolor aliquip anim laboris ess\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1,\n \"name\": \"Joe\",\n \"age\": 34\n },\n {\n \"id\": 2,\n \"name\": \"Mary\",\n \"age\": null\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rds/connections/:connectionName/tables/:tableName/records/upsert", "host": [ "{{baseUrl}}" ], "path": [ "rds", "connections", ":connectionName", "tables", ":tableName", "records", "upsert" ], "variable": [ { "key": "connectionName", "value": "id", "description": "(Required) The name of the connection to the Relational Data Service." }, { "key": "tableName", "value": "id", "description": "(Required) The name of the table in the Relational Data Service." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"dolor aliquip anim laboris ess\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1,\n \"name\": \"Joe\",\n \"age\": 34\n },\n {\n \"id\": 2,\n \"name\": \"Mary\",\n \"age\": null\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rds/connections/:connectionName/tables/:tableName/records/upsert", "host": [ "{{baseUrl}}" ], "path": [ "rds", "connections", ":connectionName", "tables", ":tableName", "records", "upsert" ], "variable": [ { "key": "connectionName", "value": "id", "description": "(Required) The name of the connection to the Relational Data Service." }, { "key": "tableName", "value": "id", "description": "(Required) The name of the table in the Relational Data Service." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1,\n \"name\": \"Joe\",\n \"age\": 34\n },\n {\n \"id\": 2,\n \"name\": \"Mary\",\n \"age\": null\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rds/connections/:connectionName/tables/:tableName/records/upsert", "host": [ "{{baseUrl}}" ], "path": [ "rds", "connections", ":connectionName", "tables", ":tableName", "records", "upsert" ], "variable": [ { "key": "connectionName", "value": "id", "description": "(Required) The name of the connection to the Relational Data Service." }, { "key": "tableName", "value": "id", "description": "(Required) The name of the table in the Relational Data Service." } ] } }, "status": "Bad Gateway", "code": 502, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"dolor aliquip anim laboris ess\"\n}" } ] }, { "name": "Delete Records from an RDS Table", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"Joe\",\n \"age\": 34\n },\n {\n \"name\": \"Mary\",\n \"age\": null\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rds/connections/:connectionName/tables/:tableName/records/remove", "host": [ "{{baseUrl}}" ], "path": [ "rds", "connections", ":connectionName", "tables", ":tableName", "records", "remove" ], "variable": [ { "key": "connectionName", "value": "id", "description": "(Required) The name of the connection to the Relational Data Service." }, { "key": "tableName", "value": "id", "description": "(Required) The name of the table in the Relational Data Service." } ] }, "description": "Deletes the records from a custom table in the Relational Data Service (RDS) that match the specified criteria.\n\nThis feature is only available for subscribed customers. For further information, contact your account manager.\n\n**Note:** The maximum number of objects per request is 1000." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/rds/connections/:connectionName/tables/:tableName/records/remove", "host": [ "{{baseUrl}}" ], "path": [ "rds", "connections", ":connectionName", "tables", ":tableName", "records", "remove" ], "variable": [ { "key": "connectionName", "value": "id", "description": "(Required) The name of the connection to the Relational Data Service." }, { "key": "tableName", "value": "id", "description": "(Required) The name of the table in the Relational Data Service." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"dolor aliquip anim laboris ess\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/rds/connections/:connectionName/tables/:tableName/records/remove", "host": [ "{{baseUrl}}" ], "path": [ "rds", "connections", ":connectionName", "tables", ":tableName", "records", "remove" ], "variable": [ { "key": "connectionName", "value": "id", "description": "(Required) The name of the connection to the Relational Data Service." }, { "key": "tableName", "value": "id", "description": "(Required) The name of the table in the Relational Data Service." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"dolor aliquip anim laboris ess\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/rds/connections/:connectionName/tables/:tableName/records/remove", "host": [ "{{baseUrl}}" ], "path": [ "rds", "connections", ":connectionName", "tables", ":tableName", "records", "remove" ], "variable": [ { "key": "connectionName", "value": "id", "description": "(Required) The name of the connection to the Relational Data Service." }, { "key": "tableName", "value": "id", "description": "(Required) The name of the table in the Relational Data Service." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"dolor aliquip anim laboris ess\"\n}" } ] } ] }, { "name": "Settings (misc)", "item": [ { "name": "Get Customer Settings", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/v2/settings", "description": "Returns the current settings of the specified customer account, such as timezone or name.\n\n**Important:** Access to administrative endpoints is restricted. If you need access, contact Emarsys support." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/settings" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -31250405,\n \"replyText\": \"ad anim sit esse\",\n \"data\": {\n \"environment\": \"ullamco do fugiat\",\n \"timezone\": \"dolore aliqua exercitation e\",\n \"name\": \"do occaecat tempor\",\n \"password_history_queue_size\": 22201018,\n \"country\": \"Ut nisi magna ut\"\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/settings" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "List Link Categories", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/v2/settings/linkcategories", "description": "Returns the categories of links used in emails based on their type." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/settings/linkcategories" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -33684964,\n \"replyText\": \"tempor in velit\",\n \"data\": {}\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/settings/linkcategories" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Get Account Languages", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/v2/settings/languages/translation/en", "description": "Returns the list of available languages of the account." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/settings/languages/translation/en" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 66808229,\n \"replyText\": \"ex\",\n \"data\": {\n \"\": \"sd\"\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/settings/languages/translation/en" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "Smart Insight (Scarab)", "item": [ { "name": "*** Upload Sales Data", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/https://admin.scarabresearch.com/hapi/merchant/:merchant-id/sales-data/api", "protocol": "{{baseUrl}}/https", "host": [ "admin", "scarabresearch", "com" ], "path": [ "hapi", "merchant", ":merchant-id", "sales-data", "api" ], "variable": [ { "key": "merchant-id", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) The 16-letter merchant identifier provided by Emarsys." } ] }, "description": ">**Note:** If you are a Smart Insight customer, you can choose to upload your sales data to our SFTP servers. However, this is a legacy option that has several disadvantages compared to using the Sales Data API. If you prefer to use SFTP, contact Emarsys support.\n\n## 1. Make Your Initial Upload\n\nManual upload on the **Sales Data** page is the preferred method for making your initial upload of historical sales data during the onboarding process, as it allows you to validate the file and correct any errors straight away.\n\nProceed as follows:\n1. Ensure that your sales data file is ready and formatted according to the [specifications](https://help.emarsys.com/hc/en-us/articles/360003070654-preparing-your-sales-data-file).\n2. Go to **Admin** > **Data Sources** > **Sales Data**.\n3. Click **Validate/upload file**.\n \n4. Browse for your sales data file and select it.\n\n Detected issues are listed as warnings and errors. Files with issues cannot be uploaded. Fix them and try again.\n\n **Note:** Submitting the same file multiple times does not duplicate your data.\n5. Click **Activate upload** to finalize the upload.\n\n\n## Set Up Regular Updates\n\nSet up regular updates once the initial historical sales data is uploaded. The easiest way to automate regular sales data imports to Emarsys is to use the Sales Data API.\n\n1. Go to **Admin** > **Data Sources** > **Sales Data**.\n2. Click **Manage sales data**.\n3. Click **Show API upload details**\n\n All information you need to set up the import with minimal effort is shown." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/https://admin.scarabresearch.com/hapi/merchant/:merchant-id/sales-data/api", "protocol": "{{baseUrl}}/https", "host": [ "admin", "scarabresearch", "com" ], "path": [ "hapi", "merchant", ":merchant-id", "sales-data", "api" ], "variable": [ { "key": "merchant-id", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) The 16-letter merchant identifier provided by Emarsys." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{}" } ] } ] }, { "name": "Source", "item": [ { "name": "List Contact Sources", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/v2/source" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/source" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -75840032,\n \"replyText\": \"enim nisi\",\n \"data\": [\n {\n \"id\": 34226900,\n \"name\": \"deserunt culpa exercitation\"\n },\n {\n \"id\": -48776953,\n \"name\": \"qui officia elit\"\n }\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/source" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Create a Contact Source", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"my_super_source\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/source/create", "description": "Creates and labels a new contact source.\n\nSources created via the API are **only** for exporting data changes. Once created via the API, the source can be selected in **Contacts > Data Export > Data changes > Changes originate from**. For more on the export process, see [Exporting data changes](https://help.emarsys.com/hc/en-us/articles/115004635729-Exporting-data-changes \"Emarsys Help Portal\").\n\nContact sources of this type can only be created through the API.\n\n**Important:** Contact sources described here and the internal contact `source_id` (field identifier *33*) are different entities. The `source_id` fields record how the contact was added, such as by manual entry, import, or using a registration form. These fields are often used for segmentation in the Emarsys Suite." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"my_super_source\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/source/create" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"my_super_source\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/source/create" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Delete a Contact Source", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/source/:sourceId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "source", ":sourceId" ], "variable": [ { "key": "sourceId", "value": "81739474", "description": "(Required) The identifier of the contact source." } ] }, "description": "Deletes an existing contact source." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v2/source/:sourceId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "source", ":sourceId" ], "variable": [ { "key": "sourceId", "value": "81739474", "description": "(Required) The identifier of the contact source." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v2/source/:sourceId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "source", ":sourceId" ], "variable": [ { "key": "sourceId", "value": "81739474", "description": "(Required) The identifier of the contact source." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] }, { "name": "Wishlist", "item": [ { "name": "Get Email Campaign Languages", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/v2/language", "description": "Returns a list of languages available for creating emails. For a list of supported languages, see [Language codes](docs/appendix/language-codes.md)." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/language" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 52119532,\n \"replyText\": \"i\",\n \"data\": [\n {\n \"id\": \"ld\",\n \"language\": \"mollit dolore et veniam\"\n },\n {\n \"id\": \"oa\",\n \"language\": \"Excepteur dolore fugiat magna\"\n }\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/language" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Get Email Campaign Categories", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/v2/emailcategory", "description": "Returns the alphabetized list of email campaign categories available for creating email campaigns." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/emailcategory" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -38935461,\n \"replyText\": \"fug\",\n \"data\": [\n {\n \"id\": \"ullamco eu pariatur\",\n \"category\": \"cupidatat magna consequat\"\n },\n {\n \"id\": \"aute eiusmod sint\",\n \"category\": \"enim cillum dolor\"\n }\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/emailcategory" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Blocklist Emails and Domains", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"emails\": [\n \"address1@example.com\",\n \"address2@example.com\"\n ],\n \"domains\": [\n \"example.com\",\n \"example.net\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/blocklist", "description": "Adds emails and domains to the internal blocklist. Blocklisted entries are not participating in any campaign.\n\n**Note:** The maximum batch size is 1000 emails and 1000 domains per call." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"emails\": [\n \"address1@example.com\",\n \"address2@example.com\"\n ],\n \"domains\": [\n \"example.com\",\n \"example.net\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/blocklist" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 83582956,\n \"replyText\": \"tempor ullamco sunt elit pariatur\",\n \"data\": {\n \"emails\": [\n \"irure\",\n \"culpa ve\"\n ],\n \"domains\": [\n \"aliqua proident ni\",\n \"ullamco Ut deserunt do\"\n ]\n }\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"emails\": [\n \"address1@example.com\",\n \"address2@example.com\"\n ],\n \"domains\": [\n \"example.com\",\n \"example.net\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/blocklist" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "List Conditional Text Rules", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/v2/condition", "description": "Returns a list of conditional text rules. Use conditional text to tailor the content of an email campain to your customers." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/condition" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 80546729,\n \"replyText\": \"Excepteur fugiat aute ex\",\n \"data\": [\n {\n \"id\": -18638991,\n \"name\": \"magna occaecat culpa aute\",\n \"condName\": \"veniam\"\n },\n {\n \"id\": 56727523,\n \"name\": \"do laborum ipsum\",\n \"condName\": \"deserunt\"\n }\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": "{{baseUrl}}/v2/condition" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Trigger a Wishlist Update", "request": { "method": "POST", "header": [ { "description": "(Required) ", "key": "WSSE", "value": "Ut pariatur adipisicing irure ut" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"culpa \",\n \"events\": [\n {\n \"external_id\": \"qui in fugiat reprehenderit\",\n \"event_time\": \"adipisicing cillum amet\",\n \"wishlist_content\": [\n {\n \"item_id\": \"ut ipsum qui Excepteur deserunt\",\n \"quantity\": 18136546\n },\n {\n \"item_id\": \"id ut aliquip\",\n \"quantity\": -21872150\n }\n ],\n \"trigger_id\": \"culpa\",\n \"event_attributes\": {\n \"myNumber\": 77079101,\n \"myString\": \"L\"\n }\n },\n {\n \"external_id\": \"non id quis\",\n \"event_time\": \"occaecat irure\",\n \"wishlist_content\": [\n {\n \"item_id\": \"amet eu \",\n \"quantity\": -24260164\n },\n {\n \"item_id\": \"pariatur consectetur ea\",\n \"quantity\": -56458779\n }\n ],\n \"trigger_id\": \"reprehenderit voluptate\",\n \"event_attributes\": {\n \"myNumber\": -70154819,\n \"myString\": \"officia elit dolor Ut\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/wishlist/update", "description": "Activates a wishlist update event for the specified contacts.\n\n\n### Prerequisites\n- If you synchronize your contact data using your own unique identifier in your system, a custom contact field `externalId` must exist as the external identifier. To create one, use the [Create a field](https://dev.emarsys.com/docs/emarsys-api/b3A6MjQ4OTk4MTY) endpoint or go to **Admin** > **Field Editor** > **New** in the Emarsys application. For details on contact identifiers, see [Concepts](docs/before-you-start/concepts.md).\n>**Note:** Using external field identifiers is the recommended method for identifying contacts. However, you can use other Emasys system fields as well, such as email. For details, see [Contact system fields](docs/personalization/contact-system-fields.md).\n\n- The specified contact must exist in the Emarsys database to trigger an event.\n\n**Notes**\n\n- The maximum number of objects per request is 1000.\n- The maximum size of a single event is 20kB.\n- For Emarsys to follow-up changes, it is beneficial to have an initial load: we recommend sending through the current wishlist state for all your contacts with their corresponding event time. From that point on, Emarsys can calculate changes from the states (wishlist contents)." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "WSSE", "value": "Ut pariatur adipisicing irure ut" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"cupidatat mollit\",\n \"events\": [\n {\n \"external_id\": \"sint adipisicing cupidatat\",\n \"event_time\": \"cillum eiusmod deserunt\",\n \"wishlist_content\": [\n {\n \"item_id\": \"minim commodo consectetur\",\n \"quantity\": 17501894\n },\n {\n \"item_id\": \"dolore fugiat dolore in\",\n \"quantity\": -1069810\n }\n ],\n \"trigger_id\": \"sit deserunt aliquip eu\",\n \"event_attributes\": {\n \"myNumber\": 38301807,\n \"myString\": \"laboris ex\"\n }\n },\n {\n \"external_id\": \"proident aliquip dolore est\",\n \"event_time\": \"adipisicing Duis labore veniam\",\n \"wishlist_content\": [\n {\n \"item_id\": \"reprehenderit sunt\",\n \"quantity\": -16973229\n },\n {\n \"item_id\": \"dolore voluptate anim\",\n \"quantity\": -82336218\n }\n ],\n \"trigger_id\": \"adipisicing ea non\",\n \"event_attributes\": {\n \"myNumber\": 76691680,\n \"myString\": \"occaecat sunt\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/wishlist/update" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -59565759,\n \"replyText\": \"qu\",\n \"data\": {}\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "WSSE", "value": "Ut pariatur adipisicing irure ut" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"cupidatat mollit\",\n \"events\": [\n {\n \"external_id\": \"sint adipisicing cupidatat\",\n \"event_time\": \"cillum eiusmod deserunt\",\n \"wishlist_content\": [\n {\n \"item_id\": \"minim commodo consectetur\",\n \"quantity\": 17501894\n },\n {\n \"item_id\": \"dolore fugiat dolore in\",\n \"quantity\": -1069810\n }\n ],\n \"trigger_id\": \"sit deserunt aliquip eu\",\n \"event_attributes\": {\n \"myNumber\": 38301807,\n \"myString\": \"laboris ex\"\n }\n },\n {\n \"external_id\": \"proident aliquip dolore est\",\n \"event_time\": \"adipisicing Duis labore veniam\",\n \"wishlist_content\": [\n {\n \"item_id\": \"reprehenderit sunt\",\n \"quantity\": -16973229\n },\n {\n \"item_id\": \"dolore voluptate anim\",\n \"quantity\": -82336218\n }\n ],\n \"trigger_id\": \"adipisicing ea non\",\n \"event_attributes\": {\n \"myNumber\": 76691680,\n \"myString\": \"occaecat sunt\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/wishlist/update" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -53028643,\n \"replyText\": \"dolore esse non cupidatat\",\n \"data\": \"elit pariatur Excepteur ullamco\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "WSSE", "value": "Ut pariatur adipisicing irure ut" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"cupidatat mollit\",\n \"events\": [\n {\n \"external_id\": \"sint adipisicing cupidatat\",\n \"event_time\": \"cillum eiusmod deserunt\",\n \"wishlist_content\": [\n {\n \"item_id\": \"minim commodo consectetur\",\n \"quantity\": 17501894\n },\n {\n \"item_id\": \"dolore fugiat dolore in\",\n \"quantity\": -1069810\n }\n ],\n \"trigger_id\": \"sit deserunt aliquip eu\",\n \"event_attributes\": {\n \"myNumber\": 38301807,\n \"myString\": \"laboris ex\"\n }\n },\n {\n \"external_id\": \"proident aliquip dolore est\",\n \"event_time\": \"adipisicing Duis labore veniam\",\n \"wishlist_content\": [\n {\n \"item_id\": \"reprehenderit sunt\",\n \"quantity\": -16973229\n },\n {\n \"item_id\": \"dolore voluptate anim\",\n \"quantity\": -82336218\n }\n ],\n \"trigger_id\": \"adipisicing ea non\",\n \"event_attributes\": {\n \"myNumber\": 76691680,\n \"myString\": \"occaecat sunt\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/wishlist/update" }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 59039933,\n \"replyText\": \"nostrud eu pariatur in in\",\n \"data\": \"officia in sint fugiat\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "WSSE", "value": "Ut pariatur adipisicing irure ut" } ], "body": { "mode": "raw", "raw": "{\n \"key_id\": \"cupidatat mollit\",\n \"events\": [\n {\n \"external_id\": \"sint adipisicing cupidatat\",\n \"event_time\": \"cillum eiusmod deserunt\",\n \"wishlist_content\": [\n {\n \"item_id\": \"minim commodo consectetur\",\n \"quantity\": 17501894\n },\n {\n \"item_id\": \"dolore fugiat dolore in\",\n \"quantity\": -1069810\n }\n ],\n \"trigger_id\": \"sit deserunt aliquip eu\",\n \"event_attributes\": {\n \"myNumber\": 38301807,\n \"myString\": \"laboris ex\"\n }\n },\n {\n \"external_id\": \"proident aliquip dolore est\",\n \"event_time\": \"adipisicing Duis labore veniam\",\n \"wishlist_content\": [\n {\n \"item_id\": \"reprehenderit sunt\",\n \"quantity\": -16973229\n },\n {\n \"item_id\": \"dolore voluptate anim\",\n \"quantity\": -82336218\n }\n ],\n \"trigger_id\": \"adipisicing ea non\",\n \"event_attributes\": {\n \"myNumber\": 76691680,\n \"myString\": \"occaecat sunt\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/wishlist/update" }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -61997494,\n \"replyText\": \"velit ipsum consectetur\",\n \"data\": {\n \"errors\": {\n \"jane.doe@example.com\": {\n \"1008\": \"Ut\",\n \"\": \"magna ut\"\n }\n }\n }\n}" } ] }, { "name": "List Program Resources in Use", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/programresource/?service_id=Ut pariatur adipisicing irure ut&resource_id=Ut pariatur adipisicing irure ut", "host": [ "{{baseUrl}}" ], "path": [ "v2", "programresource", "" ], "query": [ { "key": "service_id", "value": "Ut pariatur adipisicing irure ut", "description": "(Required) The identifier of the external service." }, { "key": "resource_id", "value": "Ut pariatur adipisicing irure ut", "description": "The identifier of the resource that represents the settings of a particular node of a customer in the Automation Center." } ] }, "description": "Returns a list of all external services and their resources available in the Automation Center for a customer." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/programresource/?service_id=Ut pariatur adipisicing irure ut&resource_id=Ut pariatur adipisicing irure ut", "host": [ "{{baseUrl}}" ], "path": [ "v2", "programresource", "" ], "query": [ { "key": "service_id", "value": "Ut pariatur adipisicing irure ut" }, { "key": "resource_id", "value": "Ut pariatur adipisicing irure ut" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": -26437053,\n \"replyText\": \"esse eu aliquip ex cillum\",\n \"data\": [\n {\n \"service_id\": \"consequat id\",\n \"customer_id\": \"veniam do\",\n \"program_id\": \"non\",\n \"node_id\": \"dolor nostrud irure\",\n \"resource_id\": \"nostrud magna do nulla\"\n },\n {\n \"service_id\": \"Ut et enim ullamco reprehenderit\",\n \"customer_id\": \"fugiat minim amet esse\",\n \"program_id\": \"in est proident\",\n \"node_id\": \"cillum voluptate\",\n \"resource_id\": \"eiusmod quis\"\n }\n ]\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/programresource/?service_id=Ut pariatur adipisicing irure ut&resource_id=Ut pariatur adipisicing irure ut", "host": [ "{{baseUrl}}" ], "path": [ "v2", "programresource", "" ], "query": [ { "key": "service_id", "value": "Ut pariatur adipisicing irure ut" }, { "key": "resource_id", "value": "Ut pariatur adipisicing irure ut" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] }, { "name": "Send a Notification Message", "request": { "auth": { "type": "apikey", "apikey": { "key": "X-WSSE", "value": "", "in": "header" } }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"message\": \"Hello World!\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/notification", "description": "Sends a popup notification to the administrators of the account.\n\n**Important:** Only displayed if the administrator is currently logged in. You can check unread messages by clicking the bell icon in the navigation bar.\n\n\n**Note:** Potential errors originating from this endpoint are investigated during working hours only." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"message\": \"Hello World!\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/notification" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-WSSE", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"message\": \"Hello World!\"\n}", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/v2/notification" }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"replyCode\": 0,\n \"replyText\": \"do irure veniam Duis\",\n \"data\": \"ut veniam\"\n}" } ] } ] } ] }, { "name": "/sms/ ( SMS )", "item": [ { "name": "Campaigns", "item": [ { "name": "{campaign Id}", "item": [ { "name": "PUT campaigns-campaign Id", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "\"eiusmod nisi Duis\"", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/campaigns/:campaignId", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":campaignId" ], "variable": [ { "key": "campaignId", "value": "eiusmod nisi Duis", "description": "(Required) " } ] }, "description": "Lets you update an existing SMS campaign.\n\n---\n**Mandatory parameters**\n\nAt least one of the following:\n\n- **type**: the type can only be changed from *ac* to *batch* if no active AC program uses the campaign\n- **title**\n- **sender**\n-\t**message**\n-\t**deduplicate_recipients**\n-\t**source_type** (**source_type** and **source_id** must be present in the suite in case of *batch* campaigns, and must be *null* or undefined for campaigns with **type** *ac*)\n-\t**source_id**\n-\t**unsubscribe.enabled**\n-\t**unsubscribe.title**\n-\t**unsubscribe.text**\n-\t**unsubscribe.button_text**\n-\t**unsubscribe.after_text**\n\n---\n**Forbidden parameters**\n\nIn order to change the following parameters, a **Launch a Campaign** request must be made:\n-\t**status**\n- **scheduled_to**\n\n---\n**IMPORTANT**\nMake sure the following conditions apply:\n- The recipient source exists in the Suite if **source_type**|**source_id** is updated.\n-\ta campaign can only be updated while it is in either *draft** or *scheduled* state. If the campaign is in *scheduled* state, the **scheduled_to** date must be at least 1 minute in the future.\n- TWIG template syntax is used." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/campaigns/:campaignId", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":campaignId" ], "variable": [ { "key": "campaignId", "value": "eiusmod nisi Duis", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Untitled Example", "originalRequest": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/campaigns/:campaignId", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":campaignId" ], "variable": [ { "key": "campaignId", "value": "eiusmod nisi Duis", "description": "(Required) " } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "PATCH campaigns-campaign Id", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "\"eiusmod nisi Duis\"", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/campaigns/:campaignId", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":campaignId" ], "variable": [ { "key": "campaignId", "value": "eiusmod nisi Duis", "description": "(Required) " } ] }, "description": "Lets you launch/schedule a *batch* campaign, or cancel its scheduled launch by updating the value of the **status** attribute the following way:\r\n\r\n**1.** To launch the campaign at a specific date (schedule a campaign):\r\n\r\n- {\r\n \"**status**\": \"*scheduled*\",\r\n \r\n \"**scheduled_to**\": \"2018-02-28T13:15:00.000Z\"\r\n}\r\n\r\n**2.** To launch the campaign immediately:\r\n\r\n - {\r\n \"**status**\": \"*triggered*\"\r\n}\r\n\r\n**3.** To cancel a scheduled launch:\r\n\r\n- {\r\n \"**status**\": \"*draft*\"\r\n}\r\n___\r\n**Mandatory parameters:**\r\n- **customerId**\r\n- **campaignId**\r\n- **status** (*draft* or *triggered*)\r\n___\r\nCampaigns with **type** *AC* must be triggered/scheduled/canceled through an AC program.\r\n\r\n**Note**: Only campaigns in *scheduled* state can be canceled." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/campaigns/:campaignId", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":campaignId" ], "variable": [ { "key": "campaignId", "value": "eiusmod nisi Duis", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Untitled Example", "originalRequest": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/campaigns/:campaignId", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":campaignId" ], "variable": [ { "key": "campaignId", "value": "eiusmod nisi Duis", "description": "(Required) " } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "GET campaigns-campaign Id", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/campaigns/:campaignId", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":campaignId" ], "variable": [ { "key": "campaignId", "value": "eiusmod nisi Duis", "description": "(Required) " } ] }, "description": "Returns the SMS campaign with the specified campaign ID." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/campaigns/:campaignId", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":campaignId" ], "variable": [ { "key": "campaignId", "value": "eiusmod nisi Duis", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/campaigns/:campaignId", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":campaignId" ], "variable": [ { "key": "campaignId", "value": "eiusmod nisi Duis", "description": "(Required) " } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "GET campaigns", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/campaigns?limit=-23532290&offset=-23532290", "host": [ "{{baseUrl}}" ], "path": [ "campaigns" ], "query": [ { "key": "limit", "value": "-23532290", "description": "(Required) Limits the number of SMS campaigns returned in the list." }, { "key": "offset", "value": "-23532290", "description": "(Required) Used to skip a number of SMS campaigns before results are fetched (remember that campaigns are listed in a *latest first* fashion)." } ] }, "description": "Returns a list of ongoing SMS campaigns.\n\n**Example**\n\nhttps://api.emarsys.net/api/sms/campaigns?limit=1000&offset=0" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/campaigns?limit=-23532290&offset=-23532290", "host": [ "{{baseUrl}}" ], "path": [ "campaigns" ], "query": [ { "key": "limit", "value": "-23532290" }, { "key": "offset", "value": "-23532290" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/campaigns?limit=-23532290&offset=-23532290", "host": [ "{{baseUrl}}" ], "path": [ "campaigns" ], "query": [ { "key": "limit", "value": "-23532290" }, { "key": "offset", "value": "-23532290" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "POST campaigns", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "\"eiusmod nisi Duis\"", "options": { "raw": { "language": "json" } } }, "url": "{{baseUrl}}/campaigns", "description": "Lets you create an SMS campaign.\n\nMake sure the following conditions apply:\n- You are using all the mandatory parameters;\n- The\trecipient source exists in your Suite (in case of batch SMS sending);\n- **source_type** and **source_id** must be *null* or undefined in case of AC type requests;\n- TWIG template syntax is used." }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [], "url": "{{baseUrl}}/campaigns" }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Untitled Example", "originalRequest": { "method": "POST", "header": [], "url": "{{baseUrl}}/campaigns" }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "GET inbound-messages", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/inbound-messages?{limit}=1000&{offset}=4101444904&{startDate}=nothing&{endDate}=now", "host": [ "{{baseUrl}}" ], "path": [ "inbound-messages" ], "query": [ { "key": "{limit}", "value": "1000", "description": "(Required) The maximum number of inbound SMS fetched by request." }, { "key": "{offset}", "value": "4101444904", "description": "(Required) The logic will start fetching after skipping the number of inbound sms messages specified here." }, { "key": "{startDate}", "value": "nothing", "description": "(Required) All fetched inbound SMS messages will be newer than the date specified here.\nIt must be URL-encoded." }, { "key": "{endDate}", "value": "now", "description": "(Required) All fetched inbound SMS messages will be older than the date specified here.\nIt must be URL-encoded." } ] }, "description": "Fetches inbound SMS messages in **latest first** order.\n\n**Example:**\n\napi.emarsys.net/api/sms/inbound-messages?limit=500&offset=100?startDate=2018-02-28T13%3A15%3A00.000Z&endDate=2018-03-05T00%3A00%3A00.000Z" }, "response": [ { "name": "Untitled Example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/inbound-messages?{limit}=1000&{offset}=4101444904&{startDate}=nothing&{endDate}=now", "host": [ "{{baseUrl}}" ], "path": [ "inbound-messages" ], "query": [ { "key": "{limit}", "value": "1000" }, { "key": "{offset}", "value": "4101444904" }, { "key": "{startDate}", "value": "nothing" }, { "key": "{endDate}", "value": "now" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] } ], "variable": [ { "key": "baseUrl", "value": "https://api.emarsys.net/api", "type": "string" }, { "key": "keyId", "value": "81739474", "type": "any" }, { "key": "keyValue", "value": "Ut pariatur adipisicing irure ut", "type": "any" } ] }