Some test http://example.com
\",\n \"plain\": \"test 12 Some test\"\n }\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Accounts", "item": [ { "name": "Returns account blocklist masks", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/accounts/blocklists", "host": [ "{{baseUrl}}" ], "path": [ "accounts", "blocklists" ], "query": [ { "key": "query[mask]", "value": "", "description": "Blocklist mask to search for", "disabled": true } ] } } }, { "name": "Update account blocklist", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/accounts/blocklists", "host": [ "{{baseUrl}}" ], "path": [ "accounts", "blocklists" ], "query": [ { "key": "additionalFlags", "value": "", "description": "The flag value `add` adds the masks provided in the request body to your blocklist. The flag value `delete` deletes the masks. The masks are replaced if there are no flag values in the request body. \n\n For better performance, use the flag value `noResponse`. It removes the response body and can be used alone or combined with other flags. If multiple flags are used, separate them by a comma, like this: `additionalFlags=noResponse` or `additionalFlags=add,noResponse`.", "disabled": true } ] }, "body": { "mode": "raw", "raw": "{\n \"masks\": [\n \"jack@somedomain.com\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Account information", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/accounts", "host": [ "{{baseUrl}}" ], "path": [ "accounts" ], "query": [] } } }, { "name": "Update account", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/accounts", "host": [ "{{baseUrl}}" ], "path": [ "accounts" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"companyName\": \"MyBigCompany\",\n \"phone\": \"+00155555555\",\n \"state\": \"Oklahoma\",\n \"city\": \"Alderson\",\n \"street\": \"Sunset blv.\",\n \"zipCode\": \"81-611\",\n \"numberOfEmployees\": \"500\",\n \"timeFormat\": \"24h\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Billing information", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/accounts/billing", "host": [ "{{baseUrl}}" ], "path": [ "accounts", "billing" ], "query": [] } } }, { "name": "List of timezones", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/accounts/timezones", "host": [ "{{baseUrl}}" ], "path": [ "accounts", "timezones" ], "query": [] } } }, { "name": "Get callbacks configuration", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/accounts/callbacks", "host": [ "{{baseUrl}}" ], "path": [ "accounts", "callbacks" ], "query": [] } } }, { "name": "Enable or update callbacks configuration", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/accounts/callbacks", "host": [ "{{baseUrl}}" ], "path": [ "accounts", "callbacks" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/callback\",\n \"actions\": {\n \"open\": true,\n \"click\": true,\n \"subscribe\": true,\n \"unsubscribe\": true,\n \"survey\": true\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Disable callbacks", "request": { "method": "DELETE", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/accounts/callbacks", "host": [ "{{baseUrl}}" ], "path": [ "accounts", "callbacks" ], "query": [] } } }, { "name": "List of Industry Tags", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/accounts/industries", "host": [ "{{baseUrl}}" ], "path": [ "accounts", "industries" ], "query": [] } } }, { "name": "History of logins", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/accounts/login-history", "host": [ "{{baseUrl}}" ], "path": [ "accounts", "login-history" ], "query": [] } } }, { "name": "Current status of your GetResponse badge", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/accounts/badge", "host": [ "{{baseUrl}}" ], "path": [ "accounts", "badge" ], "query": [] } } }, { "name": "Turn on/off the GetResponse Badge", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/accounts/badge", "host": [ "{{baseUrl}}" ], "path": [ "accounts", "badge" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"enabled\",\n \"type\": \"landing_page\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send limits", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/accounts/sending-limits", "host": [ "{{baseUrl}}" ], "path": [ "accounts", "sending-limits" ], "query": [] } } } ] }, { "name": "Addresses", "item": [ { "name": "Get an address by ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/addresses/{addressId}", "host": [ "{{baseUrl}}" ], "path": [ "addresses", ":addressId" ], "query": [] } } }, { "name": "Update address", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/addresses/{addressId}", "host": [ "{{baseUrl}}" ], "path": [ "addresses", ":addressId" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"countryCode\": \"POL\",\n \"name\": \"some_shipping_address\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address1\": \"Arkonska 6\",\n \"address2\": \"\",\n \"city\": \"Gdansk\",\n \"zip\": \"80-387\",\n \"province\": \"pomorskie\",\n \"provinceCode\": \"\",\n \"phone\": \"1122334455\",\n \"company\": \"GetResponse\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete address", "request": { "method": "DELETE", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/addresses/{addressId}", "host": [ "{{baseUrl}}" ], "path": [ "addresses", ":addressId" ], "query": [] } } }, { "name": "Get a list of addresses", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/addresses", "host": [ "{{baseUrl}}" ], "path": [ "addresses" ], "query": [ { "key": "query[name]", "value": "", "description": "Search addresses by name", "disabled": true }, { "key": "query[firstName]", "value": "", "description": "Search addresses by first name", "disabled": true }, { "key": "query[lastName]", "value": "", "description": "Search addresses by last name", "disabled": true }, { "key": "query[address1]", "value": "", "description": "Search addresses by address1 field", "disabled": true }, { "key": "query[address2]", "value": "", "description": "Search addresses by address2 field", "disabled": true }, { "key": "query[city]", "value": "", "description": "Search addresses by city", "disabled": true }, { "key": "query[zip]", "value": "", "description": "Search addresses by ZIP", "disabled": true }, { "key": "query[province]", "value": "", "description": "Search addresses by province", "disabled": true }, { "key": "query[provinceCode]", "value": "", "description": "Search addresses by province code", "disabled": true }, { "key": "query[phone]", "value": "", "description": "Search addresses by phone", "disabled": true }, { "key": "query[company]", "value": "", "description": "Search addresses by company", "disabled": true }, { "key": "query[createdOn][from]", "value": "", "description": "Search addresses created from this date", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "Search addresses created to this date", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort by date", "disabled": true } ] } } }, { "name": "Create address", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/addresses", "host": [ "{{baseUrl}}" ], "path": [ "addresses" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"countryCode\": \"POL\",\n \"name\": \"some_shipping_address\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address1\": \"Arkonska 6\",\n \"address2\": \"\",\n \"city\": \"Gdansk\",\n \"zip\": \"80-387\",\n \"province\": \"pomorskie\",\n \"provinceCode\": \"\",\n \"phone\": \"1122334455\",\n \"company\": \"GetResponse\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Autoresponders", "item": [ { "name": "Get a single autoresponder by its ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/autoresponders/{autoresponderId}", "host": [ "{{baseUrl}}" ], "path": [ "autoresponders", ":autoresponderId" ], "query": [] } } }, { "name": "Update autoresponder", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/autoresponders/{autoresponderId}", "host": [ "{{baseUrl}}" ], "path": [ "autoresponders", ":autoresponderId" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Message 2\",\n \"subject\": \"test12\",\n \"campaignId\": \"V\",\n \"status\": \"enabled\",\n \"fromField\": {\n \"fromFieldId\": \"V\"\n },\n \"replyTo\": {\n \"fromFieldId\": \"V\"\n },\n \"content\": {\n \"html\": \"Some test http://example.com
\",\n \"plain\": \"test 12 Some test\"\n },\n \"flags\": [\n \"openrate\"\n ],\n \"triggerSettings\": {\n \"type\": \"string\",\n \"dayOfCycle\": 0,\n \"selectedCampaigns\": null\n },\n \"sendSettings\": {\n \"type\": \"signup\",\n \"timeTravel\": \"true\",\n \"excludedDaysOfWeek\": [\n \"Monday\"\n ],\n \"externalLexpad\": {\n \"dataSourceUrl\": \"https://example.com/external_lexpad\",\n \"dataSourceToken\": \"cf4dfca78434bf927a7655c0c4d95a2a45c33b71\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete autoresponder.", "request": { "method": "DELETE", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/autoresponders/{autoresponderId}", "host": [ "{{baseUrl}}" ], "path": [ "autoresponders", ":autoresponderId" ], "query": [] } } }, { "name": "The statistics for a single autoresponder", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/autoresponders/{autoresponderId}/statistics", "host": [ "{{baseUrl}}" ], "path": [ "autoresponders", ":autoresponderId", "statistics" ], "query": [ { "key": "query[groupBy]", "value": "", "description": "Group results by time interval", "disabled": true }, { "key": "query[createdOn][from]", "value": "", "description": "Count data from this date", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "Count data to this date", "disabled": true } ] } } }, { "name": "Get the autoresponder thumbnail", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/autoresponders/{autoresponderId}/thumbnail", "host": [ "{{baseUrl}}" ], "path": [ "autoresponders", ":autoresponderId", "thumbnail" ], "query": [ { "key": "size", "value": "", "description": "The size of the autoresponder thumbnail", "disabled": true } ] } } }, { "name": "Get the list of autoresponders.", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/autoresponders", "host": [ "{{baseUrl}}" ], "path": [ "autoresponders" ], "query": [ { "key": "query[subject]", "value": "", "description": "Search autoresponder by subject", "disabled": true }, { "key": "query[name]", "value": "", "description": "Search autoresponder by name", "disabled": true }, { "key": "query[status]", "value": "", "description": "Search autoresponder by status", "disabled": true }, { "key": "query[createdOn][from]", "value": "", "description": "Search autoresponder created from this date", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "Search autoresponder created to this date", "disabled": true }, { "key": "query[campaignId]", "value": "", "description": "Search autoresponder by campaign ID", "disabled": true }, { "key": "sort[name]", "value": "", "description": "Sort by name", "disabled": true }, { "key": "sort[subject]", "value": "", "description": "Sort by subject", "disabled": true }, { "key": "sort[dayOfCycle]", "value": "", "description": "Sort by cycle day", "disabled": true }, { "key": "sort[delivered]", "value": "", "description": "Sort by delivered", "disabled": true }, { "key": "sort[openRate]", "value": "", "description": "Sort by open rate", "disabled": true }, { "key": "sort[clickRate]", "value": "", "description": "Sort by click rate", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort by date", "disabled": true } ] } } }, { "name": "Create autoresponder", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/autoresponders", "host": [ "{{baseUrl}}" ], "path": [ "autoresponders" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Message 2\",\n \"subject\": \"test12\",\n \"campaignId\": \"V\",\n \"status\": \"enabled\",\n \"fromField\": {\n \"fromFieldId\": \"V\"\n },\n \"replyTo\": {\n \"fromFieldId\": \"V\"\n },\n \"content\": {\n \"html\": \"Some test http://example.com
\",\n \"plain\": \"test 12 Some test\"\n },\n \"flags\": [\n \"openrate\"\n ],\n \"triggerSettings\": {\n \"type\": \"string\",\n \"dayOfCycle\": 0,\n \"selectedCampaigns\": null\n },\n \"sendSettings\": {\n \"type\": \"signup\",\n \"timeTravel\": \"true\",\n \"excludedDaysOfWeek\": [\n \"Monday\"\n ],\n \"externalLexpad\": {\n \"dataSourceUrl\": \"https://example.com/external_lexpad\",\n \"dataSourceToken\": \"cf4dfca78434bf927a7655c0c4d95a2a45c33b71\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "The statistics for all autoresponders", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/autoresponders/statistics", "host": [ "{{baseUrl}}" ], "path": [ "autoresponders", "statistics" ], "query": [ { "key": "query[groupBy]", "value": "", "description": "Group results by time interval", "disabled": true }, { "key": "query[autoreponderId]", "value": "", "description": "The list of autoresponder resource IDs (string separated with '')", "disabled": true }, { "key": "query[campaignId]", "value": "", "description": "The list of campaign resource IDs (string separated with '')", "disabled": true }, { "key": "query[createdOn][from]", "value": "", "description": "Count data from this date", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "Count data to this date", "disabled": true } ] } } } ] }, { "name": "Campaigns (Lists)", "item": [ { "name": "Returns campaign blocklist masks", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/campaigns/{campaignId}/blocklists", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":campaignId", "blocklists" ], "query": [ { "key": "query[mask]", "value": "", "description": "Blocklist mask to search for", "disabled": true } ] } } }, { "name": "Updates campaign blocklist masks", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/campaigns/{campaignId}/blocklists", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":campaignId", "blocklists" ], "query": [ { "key": "additionalFlags", "value": "", "description": "The flag value `add` adds the masks provided in the request body to your blocklist. The flag value `delete` deletes the masks. The masks are replaced if there are no flag values in the request body. \n\n For better performance, use the flag value `noResponse`. It removes the response body and can be used alone or combined with other flags. If multiple flags are used, separate them by a comma, like this: `additionalFlags=noResponse` or `additionalFlags=add,noResponse`.", "disabled": true } ] }, "body": { "mode": "raw", "raw": "{\n \"masks\": [\n \"jack@somedomain.com\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a single campaign by the campaign ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/campaigns/{campaignId}", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":campaignId" ], "query": [] } } }, { "name": "Update a campaign", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/campaigns/{campaignId}", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":campaignId" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"my_campaign\",\n \"languageCode\": \"EN\",\n \"isDefault\": \"true\",\n \"postal\": {\n \"addPostalToMessages\": \"true\",\n \"city\": \"London\",\n \"companyName\": \"Company Ltd.\",\n \"country\": \"Great Britain\",\n \"design\": \"[[name]] from [[city]] in [[country]]\",\n \"state\": \"Shire\",\n \"street\": \"Bilbo Baggins Av\",\n \"zipCode\": \"81-611\"\n },\n \"confirmation\": {\n \"fromField\": {\n \"fromFieldId\": \"V\"\n },\n \"redirectType\": \"hosted\",\n \"mimeType\": \"text/plain\",\n \"redirectUrl\": \"http://example.com\",\n \"replyTo\": {\n \"fromFieldId\": \"V\"\n },\n \"subscriptionConfirmationBodyId\": \"asS1\",\n \"subscriptionConfirmationSubjectId\": \"TEww\"\n },\n \"optinTypes\": {\n \"email\": \"single\",\n \"api\": \"single\",\n \"import\": \"single\",\n \"webform\": \"single\"\n },\n \"subscriptionNotifications\": {\n \"status\": \"enabled\",\n \"recipients\": [\n {\n \"fromFieldId\": \"V\"\n }\n ]\n },\n \"profile\": {\n \"description\": \"campaign description\",\n \"industryTagId\": \"1\",\n \"logo\": \"http://logos.com/imageupdated.jpg\",\n \"logoLinkUrl\": \"http://somePageLogoLinkUpdated.com\",\n \"title\": \"title\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a list of campaigns", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/campaigns", "host": [ "{{baseUrl}}" ], "path": [ "campaigns" ], "query": [ { "key": "query[name]", "value": "", "description": "Retrieve campaigns (contact lists) filtered by name", "disabled": true }, { "key": "query[isDefault]", "value": "", "description": "Retrieve campaigns (contact lists) depending on whether they are marked as default (`isDefault` = `true`)", "disabled": true }, { "key": "sort[name]", "value": "", "description": "Sort by name", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort campaigns (contact lists) by creation date", "disabled": true } ] } } }, { "name": "Create a campaign", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/campaigns", "host": [ "{{baseUrl}}" ], "path": [ "campaigns" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"my_campaign\",\n \"languageCode\": \"EN\",\n \"isDefault\": \"true\",\n \"postal\": {\n \"addPostalToMessages\": \"true\",\n \"city\": \"London\",\n \"companyName\": \"Company Ltd.\",\n \"country\": \"Great Britain\",\n \"design\": \"[[name]] from [[city]] in [[country]]\",\n \"state\": \"Shire\",\n \"street\": \"Bilbo Baggins Av\",\n \"zipCode\": \"81-611\"\n },\n \"confirmation\": {\n \"fromField\": {\n \"fromFieldId\": \"V\"\n },\n \"redirectType\": \"hosted\",\n \"mimeType\": \"text/plain\",\n \"redirectUrl\": \"http://example.com\",\n \"replyTo\": {\n \"fromFieldId\": \"V\"\n },\n \"subscriptionConfirmationBodyId\": \"asS1\",\n \"subscriptionConfirmationSubjectId\": \"TEww\"\n },\n \"optinTypes\": {\n \"email\": \"single\",\n \"api\": \"single\",\n \"import\": \"single\",\n \"webform\": \"single\"\n },\n \"subscriptionNotifications\": {\n \"status\": \"enabled\",\n \"recipients\": [\n {\n \"fromFieldId\": \"V\"\n }\n ]\n },\n \"profile\": {\n \"description\": \"campaign description\",\n \"industryTagId\": \"1\",\n \"logo\": \"http://logos.com/imageupdated.jpg\",\n \"logoLinkUrl\": \"http://somePageLogoLinkUpdated.com\",\n \"title\": \"title\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get subscriber origin statistics", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/campaigns/statistics/origins", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", "statistics", "origins" ], "query": [] } } }, { "name": "Get subscriber location statistics", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/campaigns/statistics/locations", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", "statistics", "locations" ], "query": [] } } }, { "name": "Get campaign size statistics", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/campaigns/statistics/list-size", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", "statistics", "list-size" ], "query": [] } } }, { "name": "Get the number and origin of subscription statistics", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/campaigns/statistics/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", "statistics", "subscriptions" ], "query": [] } } }, { "name": "Get removal statistics", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/campaigns/statistics/removals", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", "statistics", "removals" ], "query": [] } } }, { "name": "Get balance statistics", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/campaigns/statistics/balance", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", "statistics", "balance" ], "query": [] } } }, { "name": "Get the statistics summary for selected campaigns", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/campaigns/statistics/summary", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", "statistics", "summary" ], "query": [ { "key": "query[campaignId]", "value": "", "description": "", "disabled": true } ] } } } ] }, { "name": "Carts", "item": [ { "name": "Get shop carts", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/carts", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "carts" ], "query": [ { "key": "query[createdOn][from]", "value": "", "description": "Search carts created from this date", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "Search carts created to this date", "disabled": true }, { "key": "query[externalId]", "value": "", "description": "Search cart by external ID", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort by date", "disabled": true } ] } } }, { "name": "Create cart", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/carts", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "carts" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"contactId\": \"Vp\",\n \"totalPrice\": 1234.56,\n \"totalTaxPrice\": 1334.56,\n \"currency\": \"USD\",\n \"selectedVariants\": [\n {\n \"variantId\": \"VTB\",\n \"quantity\": 3,\n \"price\": 57,\n \"priceTax\": 68\n }\n ],\n \"externalId\": \"ext-1234\",\n \"cartUrl\": \"http://example.com/cart/nQ\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get cart by ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/carts/{cartId}", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "carts", ":cartId" ], "query": [] } } }, { "name": "Update cart", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/carts/{cartId}", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "carts", ":cartId" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"contactId\": \"Vp\",\n \"totalPrice\": 1234.56,\n \"totalTaxPrice\": 1334.56,\n \"currency\": \"USD\",\n \"selectedVariants\": [\n {\n \"variantId\": \"VTB\",\n \"quantity\": 3,\n \"price\": 57,\n \"priceTax\": 68\n }\n ],\n \"externalId\": \"ext-1234\",\n \"cartUrl\": \"http://example.com/cart/nQ\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete cart", "request": { "method": "DELETE", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/carts/{cartId}", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "carts", ":cartId" ], "query": [] } } } ] }, { "name": "Categories", "item": [ { "name": "Get the shop categories list", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/categories", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "categories" ], "query": [ { "key": "query[name]", "value": "", "description": "Search category by name", "disabled": true }, { "key": "query[parentId]", "value": "", "description": "Search categories by their parent", "disabled": true }, { "key": "query[externalId]", "value": "", "description": "Search categories by external ID", "disabled": true }, { "key": "search[createdAt][from]", "value": "", "description": "Show categories starting from this date", "disabled": true }, { "key": "search[createdAt][to]", "value": "", "description": "Show categories starting to this date", "disabled": true }, { "key": "sort[name]", "value": "", "description": "Sort by name", "disabled": true }, { "key": "sort[createdAt]", "value": "", "description": "Sort by date", "disabled": true } ] } } }, { "name": "Create category", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/categories", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "categories" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Headwear\",\n \"parentId\": \"amh\",\n \"isDefault\": true,\n \"url\": \"https://somedomain.com/category/446\",\n \"externalId\": \"ext3343\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a single category by ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/categories/{categoryId}", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "categories", ":categoryId" ], "query": [] } } }, { "name": "Update category", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/categories/{categoryId}", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "categories", ":categoryId" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Headwear\",\n \"parentId\": \"amh\",\n \"isDefault\": true,\n \"url\": \"https://somedomain.com/category/446\",\n \"externalId\": \"ext3343\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete category", "request": { "method": "DELETE", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/categories/{categoryId}", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "categories", ":categoryId" ], "query": [] } } } ] }, { "name": "Click Tracks", "item": [ { "name": "Get click tracked link details by click track ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/click-tracks/{clickTrackId}", "host": [ "{{baseUrl}}" ], "path": [ "click-tracks", ":clickTrackId" ], "query": [] } } }, { "name": "Get click tracked links list", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/click-tracks", "host": [ "{{baseUrl}}" ], "path": [ "click-tracks" ], "query": [ { "key": "query[createdOn][from]", "value": "", "description": "Search click tracks from messages created from this date", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "Search click tracks from messages created to this date", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort by message date", "disabled": true } ] } } } ] }, { "name": "Contacts", "item": [ { "name": "Get a list of contact activities", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/contacts/{contactId}/activities", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactId", "activities" ], "query": [ { "key": "query[createdOn][from]", "value": "", "description": "", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "", "disabled": true } ] } } }, { "name": "Get contacts from a single campaign", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/campaigns/{campaignId}/contacts", "host": [ "{{baseUrl}}" ], "path": [ "campaigns", ":campaignId", "contacts" ], "query": [ { "key": "query[email]", "value": "", "description": "Search contacts by email", "disabled": true }, { "key": "query[name]", "value": "", "description": "Search contacts by name", "disabled": true }, { "key": "query[createdOn][from]", "value": "", "description": "Return only contacts created on or after the given date. Use ISO 8601 format", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "Return only contacts created on or before the given date. Use ISO 8601 format", "disabled": true }, { "key": "sort[email]", "value": "", "description": "Sort contacts by email", "disabled": true }, { "key": "sort[name]", "value": "", "description": "Sort contacts by name", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort contacts by creation date", "disabled": true } ] } } }, { "name": "Upsert the custom fields of a contact", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/contacts/{contactId}/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactId", "custom-fields" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"customFieldValues\": [\n {\n \"customFieldId\": \"kL6Nh\",\n \"value\": [\n \"18-35\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Upsert the tags of a contact", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/contacts/{contactId}/tags", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactId", "tags" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"tags\": [\n {\n \"tagId\": \"m7E2\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get contact details by contact ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/contacts/{contactId}", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactId" ], "query": [] } } }, { "name": "Update contact details", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/contacts/{contactId}", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactId" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"John Doe\",\n \"campaign\": {\n \"campaignId\": \"C\"\n },\n \"email\": \"john.doe@example.com\",\n \"dayOfCycle\": \"42\",\n \"scoring\": 8,\n \"note\": \"string\",\n \"tags\": [\n {\n \"tagId\": \"m7E2\"\n }\n ],\n \"customFieldValues\": [\n {\n \"customFieldId\": \"kL6Nh\",\n \"value\": [\n \"18-35\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a contact by contact ID", "request": { "method": "DELETE", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/contacts/{contactId}", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactId" ], "query": [ { "key": "messageId", "value": "", "description": ">\nThe ID of a message (such as a newsletter, an autoresponder, or an RSS-newsletter).\nWhen passed, this method will simulate the unsubscribe process, as if the contact clicked the unsubscribe link in a given message.", "disabled": true }, { "key": "ipAddress", "value": "", "description": "This makes it possible to pass the IP from which the contact unsubscribed. Used only if the `messageId` was send.", "disabled": true } ] } } }, { "name": "Get contact list", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/contacts", "host": [ "{{baseUrl}}" ], "path": [ "contacts" ], "query": [ { "key": "query[email]", "value": "", "description": "Search contacts by email", "disabled": true }, { "key": "query[name]", "value": "", "description": "Search contacts by name", "disabled": true }, { "key": "query[campaignId]", "value": "", "description": "Search contacts by campaign ID", "disabled": true }, { "key": "query[origin]", "value": "", "description": "Search contacts by origin", "disabled": true }, { "key": "query[createdOn][from]", "value": "", "description": "Return only contacts created on or after the given date. Use ISO 8601 format", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "Return only contacts created on or before the given date. Use ISO 8601 format", "disabled": true }, { "key": "query[changedOn][from]", "value": "", "description": "Return only contacts whose data was changed on or after the given date. Use ISO 8601 format", "disabled": true }, { "key": "query[changedOn][to]", "value": "", "description": "Return only contacts whose data was changed on or before the given date. Use ISO 8601 format", "disabled": true }, { "key": "sort[email]", "value": "", "description": "Sort by email", "disabled": true }, { "key": "sort[name]", "value": "", "description": "Sort by name", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort contacts by subscription date", "disabled": true }, { "key": "sort[changedOn]", "value": "", "description": "Sort by change date", "disabled": true }, { "key": "sort[campaignId]", "value": "", "description": "Sort by campaign ID", "disabled": true }, { "key": "additionalFlags", "value": "", "description": "The additional flags parameter with the value 'exactMatch' will search for contacts with the exact value of the email and name provided in the query string. Without this flag, matching is done via a standard 'like' comparison, which may sometimes be slow.", "disabled": true } ] } } }, { "name": "Create a new contact", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/contacts", "host": [ "{{baseUrl}}" ], "path": [ "contacts" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"John Doe\",\n \"campaign\": {\n \"campaignId\": \"C\"\n },\n \"email\": \"john.doe@example.com\",\n \"dayOfCycle\": \"42\",\n \"scoring\": 8,\n \"ipAddress\": \"1.2.3.4\",\n \"tags\": [\n {\n \"tagId\": \"m7E2\"\n }\n ],\n \"customFieldValues\": [\n {\n \"customFieldId\": \"kL6Nh\",\n \"value\": [\n \"18-35\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create multiple contacts at once", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/contacts/batch", "host": [ "{{baseUrl}}" ], "path": [ "contacts", "batch" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"campaignId\": \"C\",\n \"contacts\": [\n {\n \"email\": \"john.doe@example.com\",\n \"name\": \"John Doe\",\n \"dayOfCycle\": \"42\",\n \"scoring\": 8,\n \"ipAddress\": \"1.2.3.4\",\n \"tags\": {\n \"ids\": [\n \"kL6Nh\"\n ]\n },\n \"customFieldValues\": [\n {\n \"customFieldId\": \"kL6Nh\",\n \"value\": [\n \"18-35\"\n ]\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get contact's consent fields", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/contacts/{contactId}/consents", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactId", "consents" ], "query": [] } } } ] }, { "name": "Custom Events", "item": [ { "name": "Get custom events by custom event ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/custom-events/{customEventId}", "host": [ "{{baseUrl}}" ], "path": [ "custom-events", ":customEventId" ], "query": [] } } }, { "name": "Update custom event details", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/custom-events/{customEventId}", "host": [ "{{baseUrl}}" ], "path": [ "custom-events", ":customEventId" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"sample_custom_event\",\n \"attributes\": [\n {\n \"name\": \"sample_attribute\",\n \"type\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a custom event by custom event ID", "request": { "method": "DELETE", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/custom-events/{customEventId}", "host": [ "{{baseUrl}}" ], "path": [ "custom-events", ":customEventId" ], "query": [] } } }, { "name": "Get a list of custom events", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/custom-events", "host": [ "{{baseUrl}}" ], "path": [ "custom-events" ], "query": [ { "key": "query[name]", "value": "", "description": "Search custom events by name", "disabled": true }, { "key": "query[hasAttributes]", "value": "", "description": "Search custom events with or without attributes", "disabled": true }, { "key": "sort[name]", "value": "", "description": "Sort by name", "disabled": true } ] } } }, { "name": "Create custom event", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/custom-events", "host": [ "{{baseUrl}}" ], "path": [ "custom-events" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"sample_custom_event\",\n \"attributes\": [\n {\n \"name\": \"sample_attribute\",\n \"type\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Trigger a custom event", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/custom-events/trigger", "host": [ "{{baseUrl}}" ], "path": [ "custom-events", "trigger" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"lesson_finished\",\n \"contactId\": \"lTgH5\",\n \"attributes\": [\n {\n \"name\": \"lesson_name\",\n \"value\": \"lesson_3\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Custom Fields", "item": [ { "name": "Get a single custom field definition by the custom field ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/custom-fields/{customFieldId}", "host": [ "{{baseUrl}}" ], "path": [ "custom-fields", ":customFieldId" ], "query": [] } } }, { "name": "Update the custom field definition", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/custom-fields/{customFieldId}", "host": [ "{{baseUrl}}" ], "path": [ "custom-fields", ":customFieldId" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"hidden\": \"false\",\n \"values\": [\n \"+48600100200\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a single custom field definition", "request": { "method": "DELETE", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/custom-fields/{customFieldId}", "host": [ "{{baseUrl}}" ], "path": [ "custom-fields", ":customFieldId" ], "query": [] } } }, { "name": "Get a list of custom fields", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "custom-fields" ], "query": [ { "key": "query[name]", "value": "", "description": "Search custom fields by name", "disabled": true }, { "key": "sort[name]", "value": "", "description": "Sort by name", "disabled": true } ] } } }, { "name": "Create a custom field", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "custom-fields" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"office_phone_number\",\n \"type\": \"phone\",\n \"format\": \"text\",\n \"hidden\": \"false\",\n \"values\": [\n \"+48600100200\"\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Custom Reports", "item": [ { "name": "Get a single custom report by ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/custom-reports/{customReportId}", "host": [ "{{baseUrl}}" ], "path": [ "custom-reports", ":customReportId" ], "query": [] } } }, { "name": "Get a list of custom reports", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/custom-reports", "host": [ "{{baseUrl}}" ], "path": [ "custom-reports" ], "query": [ { "key": "query[name]", "value": "", "description": "Search custom reports by name", "disabled": true }, { "key": "sort[name]", "value": "", "description": "Sort custom reports by name", "disabled": true }, { "key": "sort[frequency]", "value": "", "description": "Sort custom reports by frequency", "disabled": true }, { "key": "sort[generatedAt]", "value": "", "description": "Sort custom reports by generation date", "disabled": true } ] } } }, { "name": "Create the custom report", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/custom-reports", "host": [ "{{baseUrl}}" ], "path": [ "custom-reports" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"My new custom report\",\n \"type\": \"subscription_rejections\",\n \"scheduling\": {\n \"frequency\": \"one_time\",\n \"startDate\": \"2024-01-01\",\n \"endDate\": \"2024-01-15\"\n }\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Ecommerce", "item": [ { "name": "Get the ecommerce revenue statistics", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/statistics/ecommerce/revenue", "host": [ "{{baseUrl}}" ], "path": [ "statistics", "ecommerce", "revenue" ], "query": [ { "key": "query[orderDate][from]", "value": "", "description": "Show statistics for orders from this date", "disabled": true }, { "key": "query[orderDate][to]", "value": "", "description": "Show statistics for orders to this date", "disabled": true }, { "key": "query[shopId]", "value": "", "description": "Search statistics by shop ID. You can get the shop ID by calling the `/v3/shops` endpoint. You can search for multiple shops using comma-separated values, for example, `pgIH, CNXF`", "disabled": true } ] } } }, { "name": "Get the ecommerce general performance statistics", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/statistics/ecommerce/performance", "host": [ "{{baseUrl}}" ], "path": [ "statistics", "ecommerce", "performance" ], "query": [ { "key": "query[orderDate][from]", "value": "", "description": "Show statistics for orders from this date", "disabled": true }, { "key": "query[orderDate][to]", "value": "", "description": "Show statistics for orders to this date", "disabled": true }, { "key": "query[shopId]", "value": "", "description": "Search statistics by shop ID. You can get the shop ID by calling the `/v3/shops` endpoint. You can search for multiple shops using comma-separated values, for example, `pgIH, CNXF`", "disabled": true } ] } } } ] }, { "name": "File Library", "item": [ { "name": "Get file by ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/file-library/files/{fileId}", "host": [ "{{baseUrl}}" ], "path": [ "file-library", "files", ":fileId" ], "query": [] } } }, { "name": "Delete file by file ID", "request": { "method": "DELETE", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/file-library/files/{fileId}", "host": [ "{{baseUrl}}" ], "path": [ "file-library", "files", ":fileId" ], "query": [] } } }, { "name": "Delete folder by folder ID", "request": { "method": "DELETE", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/file-library/folders/{folderId}", "host": [ "{{baseUrl}}" ], "path": [ "file-library", "folders", ":folderId" ], "query": [] } } }, { "name": "Get storage space information", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/file-library/quota", "host": [ "{{baseUrl}}" ], "path": [ "file-library", "quota" ], "query": [] } } }, { "name": "Get the list of files", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/file-library/files", "host": [ "{{baseUrl}}" ], "path": [ "file-library", "files" ], "query": [ { "key": "query[allFolders]", "value": "", "description": "Return files from all folders, including the root folder. **This parameter can't be used together with ** `query[folderId]`", "disabled": true }, { "key": "query[folderId]", "value": "", "description": "Search for files in a specific folder. **This parameter can't be used together with ** `query[allFolders]`", "disabled": true }, { "key": "query[name]", "value": "", "description": "Search for files by name", "disabled": true }, { "key": "query[group]", "value": "", "description": "Search for files by group", "disabled": true }, { "key": "sort[name]", "value": "", "description": "Sort by name", "disabled": true }, { "key": "sort[group]", "value": "", "description": "Sort files by group", "disabled": true }, { "key": "sort[size]", "value": "", "description": "Sort files by size", "disabled": true } ] } } }, { "name": "Create a file", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/file-library/files", "host": [ "{{baseUrl}}" ], "path": [ "file-library", "files" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"image\",\n \"extension\": \"jpg\",\n \"folder\": {\n \"folderId\": \"4a9f\"\n },\n \"content\": \"dGVzdCBjb250ZW50\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get the list of folders", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/file-library/folders", "host": [ "{{baseUrl}}" ], "path": [ "file-library", "folders" ], "query": [ { "key": "query[name]", "value": "", "description": "Search folders by name", "disabled": true }, { "key": "sort[name]", "value": "", "description": "Sort folders by name", "disabled": true }, { "key": "sort[size]", "value": "", "description": "Sort folders by size", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort folders by creation date", "disabled": true } ] } } }, { "name": "Create a folder", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/file-library/folders", "host": [ "{{baseUrl}}" ], "path": [ "file-library", "folders" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"sample folder\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Form and Popup", "item": [ { "name": "Get statistics for a single form or popup", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/statistics/popups/{popupId}/performance", "host": [ "{{baseUrl}}" ], "path": [ "statistics", "popups", ":popupId", "performance" ], "query": [ { "key": "query[date][from]", "value": "", "description": "Get statistics for a single form or popup from this date", "disabled": true }, { "key": "query[date][to]", "value": "", "description": "Get statistics for a single form or popup to this date", "disabled": true }, { "key": "query[location]", "value": "", "description": "Form or popup statistics by location", "disabled": true }, { "key": "query[device]", "value": "", "description": "Form or popup statistics by device", "disabled": true } ] } } } ] }, { "name": "Forms", "item": [ { "name": "Get form by ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/forms/{formId}", "host": [ "{{baseUrl}}" ], "path": [ "forms", ":formId" ], "query": [] } } }, { "name": "Get the list of form variants (A/B tests)", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/forms/{formId}/variants", "host": [ "{{baseUrl}}" ], "path": [ "forms", ":formId", "variants" ], "query": [] } } }, { "name": "Get the list of forms.", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/forms", "host": [ "{{baseUrl}}" ], "path": [ "forms" ], "query": [ { "key": "query[name]", "value": "", "description": "Search forms by name", "disabled": true }, { "key": "query[createdOn][from]", "value": "", "description": "Search forms created from this date", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "Search forms created to this date", "disabled": true }, { "key": "query[campaignId]", "value": "", "description": "Search forms assigned to this list (campaign). You can pass multiple comma-separated values, eg. `Xd1P,sC7r`", "disabled": true }, { "key": "query[status]", "value": "", "description": "Search by status. **Note:** `disabled` includes both `unpublished` and `draft` and `enabled` equals `published`", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "", "disabled": true }, { "key": "sort[name]", "value": "", "description": "", "disabled": true }, { "key": "sort[visitors]", "value": "", "description": "", "disabled": true }, { "key": "sort[uniqueVisitors]", "value": "", "description": "", "disabled": true }, { "key": "sort[subscribed]", "value": "", "description": "", "disabled": true }, { "key": "sort[subscriptionRate]", "value": "", "description": "", "disabled": true } ] } } } ] }, { "name": "Forms and Popups", "item": [ { "name": "Get a single form or popup by ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/popups/{popupId}", "host": [ "{{baseUrl}}" ], "path": [ "popups", ":popupId" ], "query": [] } } }, { "name": "Get the list of forms and popups", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/popups", "host": [ "{{baseUrl}}" ], "path": [ "popups" ], "query": [ { "key": "query[name]", "value": "", "description": "Search forms and popups by name", "disabled": true }, { "key": "query[status]", "value": "", "description": "Search forms and popups by status", "disabled": true }, { "key": "stats[from]", "value": "", "description": "Show statistics from this date", "disabled": true }, { "key": "stats[to]", "value": "", "description": "Show statistics to this date", "disabled": true }, { "key": "sort[name]", "value": "", "description": "Sort forms and popups by name", "disabled": true }, { "key": "sort[status]", "value": "", "description": "Sort forms and popups by status", "disabled": true }, { "key": "sort[createdAt]", "value": "", "description": "Sort forms and popups by creation date", "disabled": true }, { "key": "sort[updatedAt]", "value": "", "description": "Sort forms and popups by modification date", "disabled": true }, { "key": "sort[views]", "value": "", "description": "Sort by number of views", "disabled": true }, { "key": "sort[uniqueVisitors]", "value": "", "description": "Sort by number of unique visitors", "disabled": true }, { "key": "sort[leads]", "value": "", "description": "Sort by number of leads", "disabled": true }, { "key": "sort[ctr]", "value": "", "description": "Sort by CTR (click-through rate)", "disabled": true } ] } } } ] }, { "name": "From Fields", "item": [ { "name": "Get a single 'From' address by ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/from-fields/{fromFieldId}", "host": [ "{{baseUrl}}" ], "path": [ "from-fields", ":fromFieldId" ], "query": [] } } }, { "name": "Delete 'From' address", "request": { "method": "DELETE", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/from-fields/{fromFieldId}", "host": [ "{{baseUrl}}" ], "path": [ "from-fields", ":fromFieldId" ], "query": [ { "key": "fromFieldIdToReplaceWith", "value": "", "description": "The 'From' address ID that should replace the deleted 'From' address", "disabled": true } ] } } }, { "name": "Set a 'From' address as default", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/from-fields/{fromFieldId}/default", "host": [ "{{baseUrl}}" ], "path": [ "from-fields", ":fromFieldId", "default" ], "query": [] } } }, { "name": "Get the list of 'From' addresses", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/from-fields", "host": [ "{{baseUrl}}" ], "path": [ "from-fields" ], "query": [ { "key": "query[email]", "value": "", "description": "Search 'From' address by email", "disabled": true }, { "key": "query[name]", "value": "", "description": "Search 'From' address by name", "disabled": true }, { "key": "query[isDefault]", "value": "", "description": "Search only default 'From' address", "disabled": true }, { "key": "query[isActive]", "value": "", "description": "Search only active 'From' addresses", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort 'From' address by date", "disabled": true } ] } } }, { "name": "Create 'From' address", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/from-fields", "host": [ "{{baseUrl}}" ], "path": [ "from-fields" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"jsmith@example.com\",\n \"name\": \"John Smith\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "GDPR Fields", "item": [ { "name": "Get GDPR Field details", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/gdpr-fields/{gdprFieldId}", "host": [ "{{baseUrl}}" ], "path": [ "gdpr-fields", ":gdprFieldId" ], "query": [] } } }, { "name": "Get the GDPR fields list", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/gdpr-fields", "host": [ "{{baseUrl}}" ], "path": [ "gdpr-fields" ], "query": [ { "key": "sort[name]", "value": "", "description": "Sort fields by name", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort fields by creation date", "disabled": true } ] } } } ] }, { "name": "Imports", "item": [ { "name": "Get import details by ID.", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/imports/{importId}", "host": [ "{{baseUrl}}" ], "path": [ "imports", ":importId" ], "query": [] } } }, { "name": "Get a list of imports.", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/imports", "host": [ "{{baseUrl}}" ], "path": [ "imports" ], "query": [ { "key": "query[campaignId]", "value": "", "description": "Search imports by campaignId", "disabled": true }, { "key": "query[createdOn][from]", "value": "", "description": "Search imports created from this date", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "Search imports created to this date", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort imports by creation date", "disabled": true }, { "key": "sort[finishedOn]", "value": "", "description": "Sort imports by finish date", "disabled": true }, { "key": "sort[campaignName]", "value": "", "description": "Sort imports by campaign name", "disabled": true }, { "key": "sort[uploadedContacts]", "value": "", "description": "Sort imports by uploaded contact count", "disabled": true }, { "key": "sort[updatedContacts]", "value": "", "description": "Sort imports by updated contact count", "disabled": true }, { "key": "sort[addedContacts]", "value": "", "description": "Sort imports by inserted contact count", "disabled": true }, { "key": "sort[invalidContacts]", "value": "", "description": "Sort imports by invalid contact count", "disabled": true }, { "key": "sort[status]", "value": "", "description": "Sort imports by status (uploaded, to_review, approved, finished, rejected, canceled)", "disabled": true } ] } } }, { "name": "Schedule a new contact import", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/imports", "host": [ "{{baseUrl}}" ], "path": [ "imports" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"campaignId\": \"z5c\",\n \"fieldMapping\": [\n \"email\"\n ],\n \"contacts\": [\n [\n \"example@somedomain.com\"\n ]\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Landing Page", "item": [ { "name": "Get details for landing page statistics", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/statistics/lps/{lpsId}/performance", "host": [ "{{baseUrl}}" ], "path": [ "statistics", "lps", ":lpsId", "performance" ], "query": [ { "key": "query[date][from]", "value": "", "description": "Show a single landing page statistics from this date", "disabled": true }, { "key": "query[date][to]", "value": "", "description": "Show a single landing page statistics to this date", "disabled": true }, { "key": "query[location]", "value": "", "description": "Landing page statistics by location", "disabled": true }, { "key": "query[device]", "value": "", "description": "Landing page statistics by device", "disabled": true }, { "key": "query[page]", "value": "", "description": "Landing page statistics by page UUID", "disabled": true } ] } } } ] }, { "name": "Landing Pages", "item": [ { "name": "Get a single landing page by ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/lps/{lpsId}", "host": [ "{{baseUrl}}" ], "path": [ "lps", ":lpsId" ], "query": [] } } }, { "name": "Get the list of landing pages", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/lps", "host": [ "{{baseUrl}}" ], "path": [ "lps" ], "query": [ { "key": "query[name]", "value": "", "description": "Search landing pages by name", "disabled": true }, { "key": "query[status]", "value": "", "description": "Search landing pages by status", "disabled": true }, { "key": "stats[from]", "value": "", "description": "Show statistics for landing pages from this date", "disabled": true }, { "key": "stats[to]", "value": "", "description": "Show statistics for landing pages to this date", "disabled": true }, { "key": "sort[name]", "value": "", "description": "Sort landing pages by name", "disabled": true }, { "key": "sort[createdAt]", "value": "", "description": "Sort landing pages by creation date", "disabled": true }, { "key": "sort[updatedAt]", "value": "", "description": "Sort landing pages by modification date", "disabled": true }, { "key": "sort[visits]", "value": "", "description": "Sort by number of page visits", "disabled": true }, { "key": "sort[leads]", "value": "", "description": "Sort landing pages by number of leads", "disabled": true }, { "key": "sort[subscriptionRate]", "value": "", "description": "Sort by subscription rate", "disabled": true } ] } } } ] }, { "name": "Legacy Forms", "item": [ { "name": "Get Legacy Form by ID.", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/webforms/{webformId}", "host": [ "{{baseUrl}}" ], "path": [ "webforms", ":webformId" ], "query": [] } } }, { "name": "Get Legacy Forms.", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/webforms", "host": [ "{{baseUrl}}" ], "path": [ "webforms" ], "query": [ { "key": "query[name]", "value": "", "description": "Search Legacy Forms by name", "disabled": true }, { "key": "query[modifiedOn][from]", "value": "", "description": "Search Legacy Forms modified from this date", "disabled": true }, { "key": "query[modifiedOn][to]", "value": "", "description": "Search Legacy Forms modified to this date", "disabled": true }, { "key": "query[campaignId]", "value": "", "description": "Search Legacy Forms by campaignId. Accepts multiple IDs separated with a comma", "disabled": true }, { "key": "sort[modifiedOn]", "value": "", "description": "Sort Legacy Forms by modification date", "disabled": true } ] } } } ] }, { "name": "Legacy Landing Pages", "item": [ { "name": "Get single landing page by ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/landing-pages/{landingPageId}", "host": [ "{{baseUrl}}" ], "path": [ "landing-pages", ":landingPageId" ], "query": [] } } }, { "name": "Get a list of landing pages", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/landing-pages", "host": [ "{{baseUrl}}" ], "path": [ "landing-pages" ], "query": [ { "key": "query[domain]", "value": "", "description": "Search landing pages by domain", "disabled": true }, { "key": "query[status]", "value": "", "description": "Search landing pages by status", "disabled": true }, { "key": "query[subdomain]", "value": "", "description": "Search landing pages by subdomain", "disabled": true }, { "key": "query[metaTitle]", "value": "", "description": "Search landing pages by metaTitle field", "disabled": true }, { "key": "query[userDomain]", "value": "", "description": "Search landing pages by user provided domain", "disabled": true }, { "key": "query[campaignId]", "value": "", "description": "Search landing pages by ID of the assigned campaign. Campaign ID must be encoded! You can get the campaign list with encoded IDs by calling the `/v3/campaigns` endpoint. You can search by multiple comma separated values eg. `o5lx,34er`.", "disabled": true }, { "key": "query[createdOn][from]", "value": "", "description": "Show landing pages created from this date", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "Show landing pages created to this date", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort by date", "disabled": true }, { "key": "sort[domain]", "value": "", "description": "Sort by domain", "disabled": true }, { "key": "sort[campaignId]", "value": "", "description": "Sort by campaign", "disabled": true }, { "key": "sort[metaTitle]", "value": "", "description": "Sort by metaTitle", "disabled": true } ] } } } ] }, { "name": "Meta Fields", "item": [ { "name": "Get the shop meta fields", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/meta-fields", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "meta-fields" ], "query": [ { "key": "query[name]", "value": "", "description": "Search meta fields by name", "disabled": true }, { "key": "query[description]", "value": "", "description": "Search meta fields by description", "disabled": true }, { "key": "query[value]", "value": "", "description": "Search meta fields by value", "disabled": true }, { "key": "query[createdOn][from]", "value": "", "description": "Search meta fields created from this date", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "Search meta fields created to this date", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort by date", "disabled": true } ] } } }, { "name": "Create meta field", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/meta-fields", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "meta-fields" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Shoe size\",\n \"value\": \"11\",\n \"valueType\": \"integer\",\n \"description\": \"Description of this meta field\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get the meta field by ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/meta-fields/{metaFieldId}", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "meta-fields", ":metaFieldId" ], "query": [] } } }, { "name": "Update meta field", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/meta-fields/{metaFieldId}", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "meta-fields", ":metaFieldId" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Shoe size\",\n \"value\": \"11\",\n \"valueType\": \"integer\",\n \"description\": \"Description of this meta field\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete meta field", "request": { "method": "DELETE", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/meta-fields/{metaFieldId}", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "meta-fields", ":metaFieldId" ], "query": [] } } } ] }, { "name": "Multimedia", "item": [ { "name": "Get images list", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/multimedia", "host": [ "{{baseUrl}}" ], "path": [ "multimedia" ], "query": [] } } }, { "name": "Upload image", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/multimedia", "host": [ "{{baseUrl}}" ], "path": [ "multimedia" ], "query": [] }, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "" } ] } } } ] }, { "name": "Newsletters", "item": [ { "name": "Get a single newsletter by its ID.", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/newsletters/{newsletterId}", "host": [ "{{baseUrl}}" ], "path": [ "newsletters", ":newsletterId" ], "query": [] } } }, { "name": "Delete newsletter", "request": { "method": "DELETE", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/newsletters/{newsletterId}", "host": [ "{{baseUrl}}" ], "path": [ "newsletters", ":newsletterId" ], "query": [] } } }, { "name": "Get newsletter activities", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/newsletters/{newsletterId}/activities", "host": [ "{{baseUrl}}" ], "path": [ "newsletters", ":newsletterId", "activities" ], "query": [ { "key": "query[activity]", "value": "", "description": "Search newsletter activities by activity type", "disabled": true }, { "key": "query[createdOn][from]", "value": "", "description": "Search newsletter activities from this date. Default value is 14 days earlier. You can get activities for last 30 days only.", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "Search newsletter activities to this date. Default value is now", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort by date", "disabled": true } ] } } }, { "name": "Cancel sending the newsletter", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/newsletters/{newsletterId}/cancel", "host": [ "{{baseUrl}}" ], "path": [ "newsletters", ":newsletterId", "cancel" ], "query": [] } } }, { "name": "The statistics of single newsletter", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/newsletters/{newsletterId}/statistics", "host": [ "{{baseUrl}}" ], "path": [ "newsletters", ":newsletterId", "statistics" ], "query": [ { "key": "query[groupBy]", "value": "", "description": "Group results by time interval", "disabled": true }, { "key": "query[createdOn][from]", "value": "", "description": "Count data from this date", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "Count data to this date", "disabled": true } ] } } }, { "name": "Get newsletter thumbnail", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/newsletters/{newsletterId}/thumbnail", "host": [ "{{baseUrl}}" ], "path": [ "newsletters", ":newsletterId", "thumbnail" ], "query": [ { "key": "size", "value": "", "description": "The size of the thumbnail", "disabled": true } ] } } }, { "name": "Get the newsletter list", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/newsletters", "host": [ "{{baseUrl}}" ], "path": [ "newsletters" ], "query": [ { "key": "query[subject]", "value": "", "description": "Search newsletters by subject", "disabled": true }, { "key": "query[name]", "value": "", "description": "Search newsletters by name", "disabled": true }, { "key": "query[status]", "value": "", "description": "Search newsletters by status", "disabled": true }, { "key": "query[createdOn][from]", "value": "", "description": "Search newsletters created from this date", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "Search newsletters created to this date", "disabled": true }, { "key": "query[sendOn][from]", "value": "", "description": "Search for newsletters sent from this date", "disabled": true }, { "key": "query[sendOn][to]", "value": "", "description": "Search for newsletters sent to this date", "disabled": true }, { "key": "query[type]", "value": "", "description": "Search newsletters by type", "disabled": true }, { "key": "query[campaignId]", "value": "", "description": "Search newsletters by campaign ID", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort by date", "disabled": true }, { "key": "sort[sendOn]", "value": "", "description": "Sort by send on date", "disabled": true } ] } } }, { "name": "Create newsletter", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/newsletters", "host": [ "{{baseUrl}}" ], "path": [ "newsletters" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"content\": {\n \"html\": \"Some test http://example.com
\",\n \"plain\": \"test 12 Some test\"\n },\n \"flags\": [\n \"openrate\"\n ],\n \"name\": \"New message\",\n \"type\": \"broadcast\",\n \"subject\": \"Annual report\",\n \"fromField\": {\n \"fromFieldId\": \"V\"\n },\n \"replyTo\": {\n \"fromFieldId\": \"V\"\n },\n \"campaign\": {\n \"campaignId\": \"C\"\n },\n \"attachments\": [\n {\n \"fileName\": \"some_file.jpg\",\n \"content\": \"sdfadsfetsdjfdskafdsaf==\",\n \"mimeType\": \"image/jpeg\"\n }\n ],\n \"sendSettings\": {\n \"selectedCampaigns\": null,\n \"selectedSegments\": null,\n \"selectedSuppressions\": null,\n \"excludedCampaigns\": null,\n \"excludedSegments\": null,\n \"selectedContacts\": null,\n \"timeTravel\": \"true\",\n \"perfectTiming\": \"false\",\n \"externalLexpad\": {\n \"dataSourceUrl\": \"https://example.com/external_lexpad\",\n \"dataSourceToken\": \"cf4dfca78434bf927a7655c0c4d95a2a45c33b71\"\n },\n \"sendOn\": {\n \"date\": \"2024-07-14T07:00:00\",\n \"timeZone\": {\n \"timeZoneId\": 282\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send the newsletter draft", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/newsletters/send-draft", "host": [ "{{baseUrl}}" ], "path": [ "newsletters", "send-draft" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"messageId\": \"N\",\n \"sendSettings\": {\n \"selectedCampaigns\": null,\n \"selectedSegments\": null,\n \"selectedSuppressions\": null,\n \"excludedCampaigns\": null,\n \"excludedSegments\": null,\n \"selectedContacts\": null,\n \"timeTravel\": \"true\",\n \"perfectTiming\": \"false\",\n \"externalLexpad\": {\n \"dataSourceUrl\": \"https://example.com/external_lexpad\",\n \"dataSourceToken\": \"cf4dfca78434bf927a7655c0c4d95a2a45c33b71\"\n },\n \"sendOn\": {\n \"date\": \"2024-07-14T07:00:00\",\n \"timeZone\": {\n \"timeZoneId\": 282\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Total newsletter statistics", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/newsletters/statistics", "host": [ "{{baseUrl}}" ], "path": [ "newsletters", "statistics" ], "query": [ { "key": "query[groupBy]", "value": "", "description": "Group results by time interval", "disabled": true }, { "key": "query[newsletterId]", "value": "", "description": "The list of newsletter resource IDs (string separated with '')", "disabled": true }, { "key": "query[campaignId]", "value": "", "description": "The list of campaign resource IDs (string separated with '')", "disabled": true }, { "key": "query[createdOn][from]", "value": "", "description": "Count data from this date", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "Count data to this date", "disabled": true } ] } } } ] }, { "name": "Orders", "item": [ { "name": "Get the list of orders", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/orders", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "orders" ], "query": [ { "key": "query[description]", "value": "", "description": "Search order by description", "disabled": true }, { "key": "query[status]", "value": "", "description": "Search order by status", "disabled": true }, { "key": "query[externalId]", "value": "", "description": "Search order by external ID", "disabled": true }, { "key": "query[processedAt][from]", "value": "", "description": "Show orders processed from this date", "disabled": true }, { "key": "query[processedAt][to]", "value": "", "description": "Show orders processed to this date", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort by date", "disabled": true } ] } } }, { "name": "Create order", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/orders", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "orders" ], "query": [ { "key": "additionalFlags", "value": "", "description": "The additional flags parameter with the value `skipAutomation` will skip the triggering `Make a purchase` element in an automated workflow", "disabled": true } ] }, "body": { "mode": "raw", "raw": "{\n \"contactId\": \"k8u\",\n \"orderUrl\": \"https://somedomain.com/orders/order446\",\n \"externalId\": \"DH71239\",\n \"totalPrice\": 716,\n \"totalPriceTax\": 358.67,\n \"currency\": \"PLN\",\n \"status\": \"NEW\",\n \"cartId\": \"QBNgBR\",\n \"description\": \"More information about order.\",\n \"shippingPrice\": 23,\n \"shippingAddress\": {\n \"countryCode\": \"POL\",\n \"name\": \"some_shipping_address\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address1\": \"Arkonska 6\",\n \"address2\": \"\",\n \"city\": \"Gdansk\",\n \"zip\": \"80-387\",\n \"province\": \"pomorskie\",\n \"provinceCode\": \"\",\n \"phone\": \"1122334455\",\n \"company\": \"GetResponse\"\n },\n \"billingStatus\": \"PENDING\",\n \"billingAddress\": {\n \"countryCode\": \"POL\",\n \"name\": \"some_shipping_address\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address1\": \"Arkonska 6\",\n \"address2\": \"\",\n \"city\": \"Gdansk\",\n \"zip\": \"80-387\",\n \"province\": \"pomorskie\",\n \"provinceCode\": \"\",\n \"phone\": \"1122334455\",\n \"company\": \"GetResponse\"\n },\n \"processedAt\": \"2026-01-01T00:00:00+0000\",\n \"metaFields\": [\n {\n \"name\": \"Shoe size\",\n \"value\": \"11\",\n \"valueType\": \"integer\",\n \"description\": \"Description of this meta field\"\n }\n ],\n \"selectedVariants\": [\n {\n \"variantId\": \"p\",\n \"price\": 840,\n \"priceTax\": 428,\n \"quantity\": \"2\",\n \"taxes\": [\n {\n \"name\": \"VAT\",\n \"rate\": 23\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a single order by ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/orders/{orderId}", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "orders", ":orderId" ], "query": [] } } }, { "name": "Update order", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/orders/{orderId}", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "orders", ":orderId" ], "query": [ { "key": "additionalFlags", "value": "", "description": "The additional flags parameter with the value `skipAutomation` will skip the triggering `Make a purchase` element in an automated workflow", "disabled": true } ] }, "body": { "mode": "raw", "raw": "{\n \"contactId\": \"k8u\",\n \"orderUrl\": \"https://somedomain.com/orders/order446\",\n \"externalId\": \"DH71239\",\n \"totalPrice\": 716,\n \"totalPriceTax\": 358.67,\n \"currency\": \"PLN\",\n \"status\": \"NEW\",\n \"cartId\": \"QBNgBR\",\n \"description\": \"More information about order.\",\n \"shippingPrice\": 23,\n \"shippingAddress\": {\n \"countryCode\": \"POL\",\n \"name\": \"some_shipping_address\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address1\": \"Arkonska 6\",\n \"address2\": \"\",\n \"city\": \"Gdansk\",\n \"zip\": \"80-387\",\n \"province\": \"pomorskie\",\n \"provinceCode\": \"\",\n \"phone\": \"1122334455\",\n \"company\": \"GetResponse\"\n },\n \"billingStatus\": \"PENDING\",\n \"billingAddress\": {\n \"countryCode\": \"POL\",\n \"name\": \"some_shipping_address\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"address1\": \"Arkonska 6\",\n \"address2\": \"\",\n \"city\": \"Gdansk\",\n \"zip\": \"80-387\",\n \"province\": \"pomorskie\",\n \"provinceCode\": \"\",\n \"phone\": \"1122334455\",\n \"company\": \"GetResponse\"\n },\n \"processedAt\": \"2026-01-01T00:00:00+0000\",\n \"metaFields\": [\n {\n \"name\": \"Shoe size\",\n \"value\": \"11\",\n \"valueType\": \"integer\",\n \"description\": \"Description of this meta field\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete order", "request": { "method": "DELETE", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/orders/{orderId}", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "orders", ":orderId" ], "query": [] } } } ] }, { "name": "Predefined Fields", "item": [ { "name": "Get a predefined field by ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/predefined-fields/{predefinedFieldId}", "host": [ "{{baseUrl}}" ], "path": [ "predefined-fields", ":predefinedFieldId" ], "query": [] } } }, { "name": "Update a predefined field", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/predefined-fields/{predefinedFieldId}", "host": [ "{{baseUrl}}" ], "path": [ "predefined-fields", ":predefinedFieldId" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"value\": \"my_new_value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a predefined field", "request": { "method": "DELETE", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/predefined-fields/{predefinedFieldId}", "host": [ "{{baseUrl}}" ], "path": [ "predefined-fields", ":predefinedFieldId" ], "query": [] } } }, { "name": "Get the predefined fields list", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/predefined-fields", "host": [ "{{baseUrl}}" ], "path": [ "predefined-fields" ], "query": [ { "key": "sort[name]", "value": "", "description": "Sort by name", "disabled": true }, { "key": "query[name]", "value": "", "description": "Search by name", "disabled": true }, { "key": "query[campaignId]", "value": "", "description": "Search by campaign ID", "disabled": true } ] } } }, { "name": "Create a predefined field", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/predefined-fields", "host": [ "{{baseUrl}}" ], "path": [ "predefined-fields" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"my_predefined_field_123\",\n \"value\": \"my value\",\n \"campaign\": {\n \"campaignId\": \"C\"\n }\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Product Variants", "item": [ { "name": "Get a list of product variants", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/products/{productId}/variants", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "products", ":productId", "variants" ], "query": [ { "key": "query[name]", "value": "", "description": "Search variant by name", "disabled": true }, { "key": "query[sku]", "value": "", "description": "Search variant by SKU", "disabled": true }, { "key": "query[description]", "value": "", "description": "Search variant by description", "disabled": true }, { "key": "query[externalId]", "value": "", "description": "Search variant by external ID", "disabled": true }, { "key": "query[createdAt][from]", "value": "", "description": "Show variants starting from this date", "disabled": true }, { "key": "query[createdAt][to]", "value": "", "description": "Show variants starting to this date", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort by date", "disabled": true } ] } } }, { "name": "Create product variant", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/products/{productId}/variants", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "products", ":productId", "variants" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Red Monster Cap\",\n \"url\": \"https://somedomain.com/products-variants/986\",\n \"sku\": \"SKU-1254-56-457-5689\",\n \"price\": 20,\n \"priceTax\": 27.5,\n \"previousPrice\": 25,\n \"previousPriceTax\": 33.6,\n \"quantity\": 0,\n \"position\": 1,\n \"barcode\": \"12455687\",\n \"externalId\": \"ext1456\",\n \"description\": \"Red Cap with GetResponse Monster print\",\n \"images\": [\n {\n \"src\": \"http://somedomain.com/images/src/img58db7ec64bab9.png\",\n \"position\": \"1\"\n }\n ],\n \"metaFields\": [\n {\n \"name\": \"Shoe size\",\n \"value\": \"11\",\n \"valueType\": \"integer\",\n \"description\": \"Description of this meta field\"\n }\n ],\n \"taxes\": [\n {\n \"name\": \"VAT\",\n \"rate\": 23\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a single product variant by ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/products/{productId}/variants/{variantId}", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "products", ":productId", "variants", ":variantId" ], "query": [] } } }, { "name": "Update product variant", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/products/{productId}/variants/{variantId}", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "products", ":productId", "variants", ":variantId" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Red Monster Cap\",\n \"url\": \"https://somedomain.com/products-variants/986\",\n \"sku\": \"SKU-1254-56-457-5689\",\n \"price\": 20,\n \"priceTax\": 27.5,\n \"previousPrice\": 25,\n \"previousPriceTax\": 33.6,\n \"quantity\": 0,\n \"position\": 1,\n \"barcode\": \"12455687\",\n \"externalId\": \"ext1456\",\n \"description\": \"Red Cap with GetResponse Monster print\",\n \"images\": [\n {\n \"src\": \"http://somedomain.com/images/src/img58db7ec64bab9.png\",\n \"position\": \"1\"\n }\n ],\n \"metaFields\": [\n {\n \"name\": \"Shoe size\",\n \"value\": \"11\",\n \"valueType\": \"integer\",\n \"description\": \"Description of this meta field\"\n }\n ],\n \"taxes\": [\n {\n \"name\": \"VAT\",\n \"rate\": 23\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete product variant", "request": { "method": "DELETE", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/products/{productId}/variants/{variantId}", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "products", ":productId", "variants", ":variantId" ], "query": [] } } } ] }, { "name": "Products", "item": [ { "name": "Get a product list.", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/products", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "products" ], "query": [ { "key": "query[name]", "value": "", "description": "Search products by name", "disabled": true }, { "key": "query[vendor]", "value": "", "description": "Search products by vendor", "disabled": true }, { "key": "query[category]", "value": "", "description": "Search products by category name", "disabled": true }, { "key": "query[categoryId]", "value": "", "description": "Search products by category ID", "disabled": true }, { "key": "query[externalId]", "value": "", "description": "Search products by external ID", "disabled": true }, { "key": "query[variantName]", "value": "", "description": "Search products by product variant name", "disabled": true }, { "key": "query[metaFieldNames]", "value": "", "description": "Search products by meta field name (the list of names must be separated by a comma [,])", "disabled": true }, { "key": "query[metaFieldValues]", "value": "", "description": "Search products by meta field value (the list of values must be separated by a comma [,])", "disabled": true }, { "key": "query[createdOn][from]", "value": "", "description": "Search products created from this date", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "Search products created to this date", "disabled": true }, { "key": "sort[name]", "value": "", "description": "Sort by name", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort by date", "disabled": true } ] } } }, { "name": "Create product", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/products", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "products" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Monster Cap\",\n \"type\": \"Headwear\",\n \"url\": \"https://somedomain.com/products/456\",\n \"vendor\": \"GetResponse\",\n \"externalId\": \"123456\",\n \"categories\": [\n {\n \"name\": \"Headwear\",\n \"parentId\": \"amh\",\n \"isDefault\": true,\n \"url\": \"https://somedomain.com/category/446\",\n \"externalId\": \"ext3343\"\n }\n ],\n \"variants\": [\n {\n \"name\": \"Red Monster Cap\",\n \"url\": \"https://somedomain.com/products-variants/986\",\n \"sku\": \"SKU-1254-56-457-5689\",\n \"price\": 20,\n \"priceTax\": 27.5,\n \"previousPrice\": 25,\n \"previousPriceTax\": 33.6,\n \"quantity\": 0,\n \"position\": 1,\n \"barcode\": \"12455687\",\n \"externalId\": \"ext1456\",\n \"description\": \"Red Cap with GetResponse Monster print\",\n \"images\": [\n {\n \"src\": \"http://somedomain.com/images/src/img58db7ec64bab9.png\",\n \"position\": \"1\"\n }\n ],\n \"metaFields\": [\n {}\n ],\n \"taxes\": [\n {}\n ]\n }\n ],\n \"metaFields\": [\n {\n \"name\": \"Shoe size\",\n \"value\": \"11\",\n \"valueType\": \"integer\",\n \"description\": \"Description of this meta field\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a single product by ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/products/{productId}", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "products", ":productId" ], "query": [] } } }, { "name": "Update product", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/products/{productId}", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "products", ":productId" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Monster Cap\",\n \"type\": \"Headwear\",\n \"url\": \"https://somedomain.com/products/456\",\n \"vendor\": \"GetResponse\",\n \"externalId\": \"123456\",\n \"categories\": [\n {\n \"name\": \"Headwear\",\n \"parentId\": \"amh\",\n \"isDefault\": true,\n \"url\": \"https://somedomain.com/category/446\",\n \"externalId\": \"ext3343\"\n }\n ],\n \"variants\": [\n {\n \"name\": \"Red Monster Cap\",\n \"url\": \"https://somedomain.com/products-variants/986\",\n \"sku\": \"SKU-1254-56-457-5689\",\n \"price\": 20,\n \"priceTax\": 27.5,\n \"previousPrice\": 25,\n \"previousPriceTax\": 33.6,\n \"quantity\": 0,\n \"position\": 1,\n \"barcode\": \"12455687\",\n \"externalId\": \"ext1456\",\n \"description\": \"Red Cap with GetResponse Monster print\",\n \"images\": [\n {\n \"src\": \"http://somedomain.com/images/src/img58db7ec64bab9.png\",\n \"position\": \"1\"\n }\n ],\n \"metaFields\": [\n {}\n ],\n \"taxes\": [\n {}\n ]\n }\n ],\n \"metaFields\": [\n {\n \"name\": \"Shoe size\",\n \"value\": \"11\",\n \"valueType\": \"integer\",\n \"description\": \"Description of this meta field\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete product", "request": { "method": "DELETE", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/products/{productId}", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "products", ":productId" ], "query": [] } } }, { "name": "Upsert product categories", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/products/{productId}/categories", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "products", ":productId", "categories" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"categories\": [\n {\n \"categoryId\": \"atQ\",\n \"isDefault\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Upsert product meta fields", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/products/{productId}/meta-fields", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "products", ":productId", "meta-fields" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"metaFields\": [\n {\n \"metaFieldId\": \"NoF\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "RSS Newsletters", "item": [ { "name": "Get RSS newsletter by ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/rss-newsletters/{rssNewsletterId}", "host": [ "{{baseUrl}}" ], "path": [ "rss-newsletters", ":rssNewsletterId" ], "query": [] } } }, { "name": "Update RSS newsletter", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/rss-newsletters/{rssNewsletterId}", "host": [ "{{baseUrl}}" ], "path": [ "rss-newsletters", ":rssNewsletterId" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"rssFeedUrl\": \"http://blog.getresponse.com\",\n \"subject\": \"My rss to newsletters\",\n \"name\": \"rsstest0\",\n \"status\": \"enabled\",\n \"editor\": {},\n \"fromField\": {\n \"fromFieldId\": \"V\"\n },\n \"replyTo\": {\n \"fromFieldId\": \"V\"\n },\n \"content\": {\n \"html\": \"Some test http://example.com
\",\n \"plain\": \"test 12 Some test\"\n },\n \"sendSettings\": {\n \"frequency\": \"asap\",\n \"filter\": \"recent\",\n \"maxArticles\": 1,\n \"selectedCampaigns\": null,\n \"selectedSegments\": null,\n \"selectedSuppressions\": null,\n \"excludedCampaigns\": null,\n \"excludedSegments\": null,\n \"selectedContacts\": null\n },\n \"flags\": [\n \"openrate\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete RSS newsletter", "request": { "method": "DELETE", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/rss-newsletters/{rssNewsletterId}", "host": [ "{{baseUrl}}" ], "path": [ "rss-newsletters", ":rssNewsletterId" ], "query": [] } } }, { "name": "Get RSS newsletter statistics by ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/rss-newsletters/{rssNewsletterId}/statistics", "host": [ "{{baseUrl}}" ], "path": [ "rss-newsletters", ":rssNewsletterId", "statistics" ], "query": [ { "key": "query[groupBy]", "value": "", "description": "Group results by time interval", "disabled": true }, { "key": "query[createdOn][from]", "value": "", "description": "Count data from this date", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "Count data to this date", "disabled": true } ] } } }, { "name": "Get the list of RSS newsletters", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/rss-newsletters", "host": [ "{{baseUrl}}" ], "path": [ "rss-newsletters" ], "query": [ { "key": "query[subject]", "value": "", "description": "Search RSS newsletters by subject", "disabled": true }, { "key": "query[status]", "value": "", "description": "Search RSS newsletters by status", "disabled": true }, { "key": "query[createdOn][from]", "value": "", "description": "Search RSS newsletters created from this date", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "Search RSS newsletters created to this date", "disabled": true }, { "key": "query[campaignId]", "value": "", "description": "Search RSS newsletters by campaign ID", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort by date", "disabled": true } ] } } }, { "name": "Create RSS newsletter", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/rss-newsletters", "host": [ "{{baseUrl}}" ], "path": [ "rss-newsletters" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"rssFeedUrl\": \"http://blog.getresponse.com\",\n \"subject\": \"My rss to newsletters\",\n \"name\": \"rsstest0\",\n \"status\": \"enabled\",\n \"editor\": {},\n \"fromField\": {\n \"fromFieldId\": \"V\"\n },\n \"replyTo\": {\n \"fromFieldId\": \"V\"\n },\n \"content\": {\n \"html\": \"Some test http://example.com
\",\n \"plain\": \"test 12 Some test\"\n },\n \"sendSettings\": {\n \"frequency\": \"asap\",\n \"filter\": \"recent\",\n \"maxArticles\": 1,\n \"selectedCampaigns\": null,\n \"selectedSegments\": null,\n \"selectedSuppressions\": null,\n \"excludedCampaigns\": null,\n \"excludedSegments\": null,\n \"selectedContacts\": null\n },\n \"flags\": [\n \"openrate\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "The statistics for all RSS newsletters", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/rss-newsletters/statistics", "host": [ "{{baseUrl}}" ], "path": [ "rss-newsletters", "statistics" ], "query": [ { "key": "query[groupBy]", "value": "", "description": "Group results by time interval", "disabled": true }, { "key": "query[rssNewsletterId]", "value": "", "description": "The list of RSS newsletter resource IDs (string separated with ',')", "disabled": true }, { "key": "query[campaignId]", "value": "", "description": "The list of campaign resource IDs (string separated with ',')", "disabled": true }, { "key": "query[createdOn][from]", "value": "", "description": "Count data from this date", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "Count data to this date", "disabled": true } ] } } } ] }, { "name": "SMS Automation Messages", "item": [ { "name": "Get a single automated SMS message by its ID.", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/sms-automation/{smsId}", "host": [ "{{baseUrl}}" ], "path": [ "sms-automation", ":smsId" ], "query": [] } } }, { "name": "Get the list of automated SMS messages.", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/sms-automation", "host": [ "{{baseUrl}}" ], "path": [ "sms-automation" ], "query": [ { "key": "query[name]", "value": "", "description": "Search automated SMS messages by name", "disabled": true }, { "key": "query[campaignId]", "value": "", "description": "Search automated SMS messages by campaign (list) ID", "disabled": true }, { "key": "query[hasLinks]", "value": "", "description": "Search for automated SMS messages containing links", "disabled": true }, { "key": "sort[status]", "value": "", "description": "Sort by the status of the SMS message", "disabled": true }, { "key": "sort[name]", "value": "", "description": "Sort by the name of the automated SMS message", "disabled": true }, { "key": "sort[modifiedOn]", "value": "", "description": "Sort by the date the SMS message was modified on", "disabled": true }, { "key": "sort[delivered]", "value": "", "description": "Sort by the number of delivered SMS messages", "disabled": true }, { "key": "sort[sent]", "value": "", "description": "Sort by the number of sent SMS messages", "disabled": true }, { "key": "sort[clicks]", "value": "", "description": "Sort by the number of link clicks", "disabled": true } ] } } } ] }, { "name": "SMS Messages", "item": [ { "name": "Get a single SMS message by its ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/sms/{smsId}", "host": [ "{{baseUrl}}" ], "path": [ "sms", ":smsId" ], "query": [] } } }, { "name": "Get the list of SMS messages", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/sms", "host": [ "{{baseUrl}}" ], "path": [ "sms" ], "query": [ { "key": "query[type]", "value": "", "description": "Search SMS messages by type", "disabled": true }, { "key": "query[name]", "value": "", "description": "Search SMS messages by name", "disabled": true }, { "key": "query[sendingStatus]", "value": "", "description": "Search SMS messages by status", "disabled": true }, { "key": "query[campaignId]", "value": "", "description": "Search SMS messages by campaign (list) ID", "disabled": true }, { "key": "query[hasLinks]", "value": "", "description": "Search for SMS messages with links", "disabled": true }, { "key": "sort[sendingStatus]", "value": "", "description": "Sort by sending status", "disabled": true }, { "key": "sort[name]", "value": "", "description": "Sort by name", "disabled": true }, { "key": "sort[sendOn]", "value": "", "description": "Sort by sending date", "disabled": true }, { "key": "sort[modifiedOn]", "value": "", "description": "Sort by modification date", "disabled": true }, { "key": "sort[delivered]", "value": "", "description": "Sort by number of delivered messages", "disabled": true }, { "key": "sort[sent]", "value": "", "description": "Sort by number of sent messages", "disabled": true }, { "key": "sort[clicks]", "value": "", "description": "Sort by number of link clicks", "disabled": true } ] } } }, { "name": "Send an SMS message", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/sms", "host": [ "{{baseUrl}}" ], "path": [ "sms" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"New message\",\n \"content\": \"Sample SMS content\",\n \"recipientsType\": \"contacts\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a list of SMS sender names", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/sms/sender-names", "host": [ "{{baseUrl}}" ], "path": [ "sms", "sender-names" ], "query": [ { "key": "query[status]", "value": "", "description": "Search sender names by status", "disabled": true } ] } } } ] }, { "name": "Search Contacts", "item": [ { "name": "Get search contacts by contact ID.", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/search-contacts/{searchContactId}", "host": [ "{{baseUrl}}" ], "path": [ "search-contacts", ":searchContactId" ], "query": [] } } }, { "name": "Update search contacts", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/search-contacts/{searchContactId}", "host": [ "{{baseUrl}}" ], "path": [ "search-contacts", ":searchContactId" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"subscribersType\": [\n \"subscribed\"\n ],\n \"sectionLogicOperator\": \"or\",\n \"section\": [\n {\n \"campaignIdsList\": [\n \"tamqY\"\n ],\n \"logicOperator\": \"or\",\n \"subscriberCycle\": [\n \"receiving_autoresponder\",\n \"not_receiving_autoresponder\"\n ],\n \"subscriptionDate\": \"all_time\",\n \"conditions\": [\n {\n \"conditionType\": \"crm\",\n \"pipelineScope\": \"PSVq\",\n \"stageScope\": \"all\"\n }\n ]\n }\n ],\n \"name\": \"custom test filter\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete search contacts", "request": { "method": "DELETE", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/search-contacts/{searchContactId}", "host": [ "{{baseUrl}}" ], "path": [ "search-contacts", ":searchContactId" ], "query": [] } } }, { "name": "Get contacts by search contacts ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/search-contacts/{searchContactId}/contacts", "host": [ "{{baseUrl}}" ], "path": [ "search-contacts", ":searchContactId", "contacts" ], "query": [ { "key": "sort[name]", "value": "", "description": "Sort by name", "disabled": true }, { "key": "sort[email]", "value": "", "description": "Sort by email", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort by creation date", "disabled": true } ] } } }, { "name": "Upsert custom fields by search contacts", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/search-contacts/{searchContactId}/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "search-contacts", ":searchContactId", "custom-fields" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"customFieldValues\": [\n {\n \"customFieldId\": \"kL6Nh\",\n \"value\": [\n \"18-35\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a saved search contact list", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/search-contacts", "host": [ "{{baseUrl}}" ], "path": [ "search-contacts" ], "query": [ { "key": "sort[name]", "value": "", "description": "Sort by name", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort by creation date", "disabled": true }, { "key": "query[name]", "value": "", "description": "Search by name", "disabled": true }, { "key": "query[createdOn][from]", "value": "", "description": "Count data from this date", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "Count data to this date", "disabled": true } ] } } }, { "name": "Create search contacts", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/search-contacts", "host": [ "{{baseUrl}}" ], "path": [ "search-contacts" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"subscribersType\": [\n \"subscribed\"\n ],\n \"sectionLogicOperator\": \"or\",\n \"section\": [\n {\n \"campaignIdsList\": [\n \"tamqY\"\n ],\n \"logicOperator\": \"or\",\n \"subscriberCycle\": [\n \"receiving_autoresponder\",\n \"not_receiving_autoresponder\"\n ],\n \"subscriptionDate\": \"all_time\",\n \"conditions\": [\n {\n \"conditionType\": \"crm\",\n \"pipelineScope\": \"PSVq\",\n \"stageScope\": \"all\"\n }\n ]\n }\n ],\n \"name\": \"custom test filter\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Search contacts using conditions", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/search-contacts/contacts", "host": [ "{{baseUrl}}" ], "path": [ "search-contacts", "contacts" ], "query": [ { "key": "sort[name]", "value": "", "description": "Sort by name", "disabled": true }, { "key": "sort[email]", "value": "", "description": "Sort by email", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort by creation date", "disabled": true } ] }, "body": { "mode": "raw", "raw": "{\n \"subscribersType\": [\n \"subscribed\"\n ],\n \"sectionLogicOperator\": \"or\",\n \"section\": [\n {\n \"campaignIdsList\": [\n \"tamqY\"\n ],\n \"logicOperator\": \"or\",\n \"subscriberCycle\": [\n \"receiving_autoresponder\",\n \"not_receiving_autoresponder\"\n ],\n \"subscriptionDate\": \"all_time\",\n \"conditions\": [\n {\n \"conditionType\": \"crm\",\n \"pipelineScope\": \"PSVq\",\n \"stageScope\": \"all\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Shops", "item": [ { "name": "Get a single shop by ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId" ], "query": [] } } }, { "name": "Update shop", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Monster market\",\n \"locale\": \"PL\",\n \"currency\": \"PLN\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete shop", "request": { "method": "DELETE", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId" ], "query": [] } } }, { "name": "Get a list of shops", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops", "host": [ "{{baseUrl}}" ], "path": [ "shops" ], "query": [ { "key": "query[name]", "value": "", "description": "Search shop by name", "disabled": true }, { "key": "sort[name]", "value": "", "description": "Sort by name", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort by date", "disabled": true } ] } } }, { "name": "Create shop", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops", "host": [ "{{baseUrl}}" ], "path": [ "shops" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Monster market\",\n \"locale\": \"PL\",\n \"currency\": \"PLN\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Sms", "item": [ { "name": "Get details for the SMS message statistics", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/statistics/sms/{smsId}", "host": [ "{{baseUrl}}" ], "path": [ "statistics", "sms", ":smsId" ], "query": [ { "key": "query[createdOn][from]", "value": "", "description": "Get statistics for a single SMS from this date", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "Get statistics for a single SMS to this date", "disabled": true } ] } } } ] }, { "name": "Subscription Confirmations", "item": [ { "name": "Get collection of SUBSCRIPTION CONFIRMATIONS bodies", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/subscription-confirmations/body/{languageCode}", "host": [ "{{baseUrl}}" ], "path": [ "subscription-confirmations", "body", ":languageCode" ], "query": [] } } }, { "name": "Get collection of SUBSCRIPTION CONFIRMATIONS subjects", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/subscription-confirmations/subject/{languageCode}", "host": [ "{{baseUrl}}" ], "path": [ "subscription-confirmations", "subject", ":languageCode" ], "query": [] } } } ] }, { "name": "Suppressions", "item": [ { "name": "Get a suppression list by ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/suppressions/{suppressionId}", "host": [ "{{baseUrl}}" ], "path": [ "suppressions", ":suppressionId" ], "query": [] } } }, { "name": "Update a suppression list by ID", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/suppressions/{suppressionId}", "host": [ "{{baseUrl}}" ], "path": [ "suppressions", ":suppressionId" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"suppression-name\",\n \"masks\": [\n \"@example.com\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Deletes a given suppression list by ID", "request": { "method": "DELETE", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/suppressions/{suppressionId}", "host": [ "{{baseUrl}}" ], "path": [ "suppressions", ":suppressionId" ], "query": [] } } }, { "name": "Get suppression lists", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/suppressions", "host": [ "{{baseUrl}}" ], "path": [ "suppressions" ], "query": [ { "key": "query[name]", "value": "", "description": "Search suppressions by name", "disabled": true }, { "key": "query[createdOn][from]", "value": "", "description": "Search suppressions created from this date", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "Search suppressions created to this date", "disabled": true }, { "key": "sort[name]", "value": "", "description": "Sort by name", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort by the createdOn date", "disabled": true } ] } } }, { "name": "Creates a new suppression list", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/suppressions", "host": [ "{{baseUrl}}" ], "path": [ "suppressions" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"suppression-name\",\n \"masks\": [\n \"@example.com\"\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Tags", "item": [ { "name": "Get tag by ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/tags/{tagId}", "host": [ "{{baseUrl}}" ], "path": [ "tags", ":tagId" ], "query": [] } } }, { "name": "Update tag by ID", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/tags/{tagId}", "host": [ "{{baseUrl}}" ], "path": [ "tags", ":tagId" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"My_Tag\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete tag by ID", "request": { "method": "DELETE", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/tags/{tagId}", "host": [ "{{baseUrl}}" ], "path": [ "tags", ":tagId" ], "query": [] } } }, { "name": "Get the list of tags", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/tags", "host": [ "{{baseUrl}}" ], "path": [ "tags" ], "query": [ { "key": "query[name]", "value": "", "description": "Search tags by name", "disabled": true }, { "key": "query[createdAt][from]", "value": "", "description": "Search tags created from this date", "disabled": true }, { "key": "query[createdAt][to]", "value": "", "description": "Search tags created to this date", "disabled": true }, { "key": "sort[createdAt]", "value": "", "description": "Sort tags by creation date", "disabled": true }, { "key": "sort[name]", "value": "", "description": "Sort by name", "disabled": true } ] } } }, { "name": "Add a new tag", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/tags", "host": [ "{{baseUrl}}" ], "path": [ "tags" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"My_Tag\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Taxes", "item": [ { "name": "Get a list of taxes", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/taxes", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "taxes" ], "query": [ { "key": "query[name]", "value": "", "description": "Search tax by name", "disabled": true }, { "key": "query[createdOn][from]", "value": "", "description": "Search tax created from this date", "disabled": true }, { "key": "query[createdOn][to]", "value": "", "description": "Search tax created to this date", "disabled": true }, { "key": "sort[createdOn]", "value": "", "description": "Sort by date", "disabled": true } ] } } }, { "name": "Create tax", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/taxes", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "taxes" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"VAT\",\n \"rate\": 23\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a single tax by ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/taxes/{taxId}", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "taxes", ":taxId" ], "query": [] } } }, { "name": "Update tax", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/taxes/{taxId}", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "taxes", ":taxId" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"VAT\",\n \"rate\": 23\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete tax by ID", "request": { "method": "DELETE", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/shops/{shopId}/taxes/{taxId}", "host": [ "{{baseUrl}}" ], "path": [ "shops", ":shopId", "taxes", ":taxId" ], "query": [] } } } ] }, { "name": "Tracking", "item": [ { "name": "Get Tracking JavaScript code snippets", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/tracking", "host": [ "{{baseUrl}}" ], "path": [ "tracking" ], "query": [] } } }, { "name": "Get the list of \"Facebook Pixels\"", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/tracking/facebook-pixels", "host": [ "{{baseUrl}}" ], "path": [ "tracking", "facebook-pixels" ], "query": [] } } } ] }, { "name": "Transactional Emails", "item": [ { "name": "Get transactional email details by transactional email ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/transactional-emails/{transactionalEmailId}", "host": [ "{{baseUrl}}" ], "path": [ "transactional-emails", ":transactionalEmailId" ], "query": [] } } }, { "name": "Get the list of transactional emails", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/transactional-emails", "host": [ "{{baseUrl}}" ], "path": [ "transactional-emails" ], "query": [ { "key": "query[sentOn][from]", "value": "", "description": "Search transactional emails sent from this date", "disabled": true }, { "key": "query[sentOn][to]", "value": "", "description": "Search transactional emails sent to this date", "disabled": true }, { "key": "query[tagged]", "value": "", "description": "Search tagged/untagged transactional emails", "disabled": true }, { "key": "query[tagId]", "value": "", "description": "Search transactional emails with a specific tag ID", "disabled": true } ] } } }, { "name": "Send transactional email", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/transactional-emails", "host": [ "{{baseUrl}}" ], "path": [ "transactional-emails" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"fromField\": {\n \"fromFieldId\": \"V\"\n },\n \"replyTo\": {\n \"fromFieldId\": \"V\"\n },\n \"tag\": {\n \"tagId\": \"vBd5\"\n },\n \"recipients\": {\n \"to\": {\n \"email\": \"john.doe@example.com\",\n \"name\": \"John Doe\",\n \"validSince\": \"2018-05-02T09:30:43+0200\"\n },\n \"cc\": [\n {\n \"email\": \"john.doe@example.com\",\n \"name\": \"John Doe\"\n }\n ],\n \"bcc\": [\n {\n \"email\": \"john.doe@example.com\",\n \"name\": \"John Doe\"\n }\n ]\n },\n \"contentType\": \"direct\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get the overall statistics of transactional emails", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/transactional-emails/statistics", "host": [ "{{baseUrl}}" ], "path": [ "transactional-emails", "statistics" ], "query": [ { "key": "query[groupBy]", "value": "", "description": "Group results by time interval", "disabled": true }, { "key": "query[timeFrame][from]", "value": "", "description": "Count data from this date", "disabled": true }, { "key": "query[timeFrame][to]", "value": "", "description": "Count data to this date", "disabled": true }, { "key": "query[tagged]", "value": "", "description": "Search tagged/untagged transactional emails", "disabled": true }, { "key": "query[tagId]", "value": "", "description": "Search transactional emails with a specific tag ID", "disabled": true } ] } } } ] }, { "name": "Transactional Emails Templates", "item": [ { "name": "Get a single template by ID", "request": { "method": "GET", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/transactional-emails/templates/{transactionalEmailTemplateId}", "host": [ "{{baseUrl}}" ], "path": [ "transactional-emails", "templates", ":transactionalEmailTemplateId" ], "query": [] } } }, { "name": "Update transactional email template", "request": { "method": "POST", "header": [ { "key": "X-Auth-Token", "value": "api-key {{token}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "string" }, { "key": "Content-Type", "value": "application/json", "type": "string" } ], "url": { "raw": "{{baseUrl}}/transactional-emails/templates/{transactionalEmailTemplateId}", "host": [ "{{baseUrl}}" ], "path": [ "transactional-emails", "templates", ":transactionalEmailTemplateId" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"subject\": \"Order Confirmation - Example Shop\",\n \"content\": {\n \"plain\": \"Your order has been confirmed. Thank you for shopping with us!\",\n \"html\": \"