{ "info": { "_postman_id": "ca4b2bf6-0cff-4acd-8d58-db11a9432bea", "name": "Altcraft API collection (JSON)", "description": "This collection provides a comprehensive reference for the **Altcraft Platform REST API (v1.1)**, covering all major areas of the platform. It contains **210 requests** organized into **21 top-level folders**, making it easy to navigate and test every part of the API.\n\n## What's covered\n\n| Area | Description |\n|---|---|\n| **Profiles** | Create, update, delete, merge, and search subscriber profiles; manage action history and profile relations |\n| **Databases** | Manage contact databases and their configuration |\n| **Segments** | Create dynamic and static segments; manage segment membership |\n| **Resources** | Retrieve resource info, counters, subscription fields, and push subscriptions |\n| **Templates** | Create and manage message templates |\n| **Campaigns** | Set up and control marketing campaigns |\n| **Scenarios** | Build and manage automation scenarios |\n| **Messages** | Send broadcast, regular, and trigger messages |\n| **Senders** | List and configure senders, including virtual senders |\n| **Suppression lists** | Manage suppression lists and suppression actions |\n| **Market / E-commerce** | Work with products, SKUs, and orders |\n| **Loyalty & Promocodes** | Manage loyalty programs and promo codes |\n| **Forms** | Create and manage web forms |\n| **External datatables** | Query and manage external data tables |\n| **Analytic reports** | Pull campaign and channel analytics |\n| **Goals** | Define and track conversion goals |\n| **Application push** | Manage mobile push notification settings |\n| **Miscellaneous** | Utility endpoints (matching types, segmentation queries, template queries, etc.) |\n\n## Base URL\n\nAll requests use the `{{url}}` environment variable as the base URL. Make sure to configure this variable in your active environment before sending requests.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "56592128", "_collection_link": "https://go.postman.co/collection/56592128-ca4b2bf6-0cff-4acd-8d58-db11a9432bea?source=collection_link" }, "item": [ { "name": "Forms", "item": [ { "name": "Get form information", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"form\": true,\n \"actions\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/forms/get", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "forms", "get" ] } }, "response": [] }, { "name": "Get forms list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"limit\": 1,\n \"is_nps\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/forms/list", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "forms", "list" ] } }, "response": [] }, { "name": "Activate form", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/forms/activate", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "forms", "activate" ] } }, "response": [] }, { "name": "Deactivate form", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/forms/deactivate", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "forms", "deactivate" ] } }, "response": [] }, { "name": "Delete form", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"data_only\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/forms/delete", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "forms", "delete" ] } }, "response": [] }, { "name": "Export form fill (by user)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"db_id\": 3,\n \"email\": \"user@example.com\",\n \"matching\": \"email\",\n \"file_format\": \"csv\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/forms/fill", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "forms", "fill" ] } }, "response": [] }, { "name": "Export form fills", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"date_from\": \"2026-04-01\",\n \"date_to\": \"2026-04-30\",\n \"file_format\": \"csv\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/forms/fills", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "forms", "fills" ] } }, "response": [] } ], "description": "Manage subscription and data capture forms. Retrieve form lists and details, activate or deactivate forms, delete forms, and export form fill data." }, { "name": "Profiles", "item": [ { "name": "Action history", "item": [ { "name": "Get profile action history", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"list_id\": \"{{db_id}}\",\n \"matching\": \"email\",\n \"email\": \"example@example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/subscribers/history_get", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "subscribers", "history_get" ] } }, "response": [] }, { "name": "Get multiple profiles action history", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"list_id\": \"{{db_id}}\",\n \"limit\": 2,\n \"date_from\": \"2024-03-01\",\n \"date_to\": \"2024-09-01\",\n \"format\": \"json\",\n \"from_id\": \"1\",\n \"fields\": [\n \"_fname\",\n \"{{db_custom_field}}\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/subscribers/history_get_all", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "subscribers", "history_get_all" ] } }, "response": [] } ], "description": "Retrieve the action history for a single profile or multiple profiles, including past interactions and communication events." }, { "name": "Subscriptions", "item": [ { "name": "Add or edit subscription", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"resource_id\": \"{{resource_id}}\",\n \"profile_id\": \"{{profile_id}}\",\n \"channel\": \"email\",\n \"email\": \"example@example.com\",\n \"status\": \"subscribed\",\n \"priority\": 10\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/subscriptions/set", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "subscriptions", "set" ] } }, "response": [] }, { "name": "Get all profile subscriptions", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"profile_id\": \"{{profile_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/subscriptions/list", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "subscriptions", "list" ] } }, "response": [] }, { "name": "Get all subscriptions from multiple profiles", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"resource_id\": \"{{resource_id}}\",\n \"from_id\": \"{{profile_id}}\",\n \"limit\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/subscriptions/list_all", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "subscriptions", "list_all" ] } }, "response": [] }, { "name": "Get profile subscription", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"resource_id\": \"{{resource_id}}\",\n \"channel\": \"push\",\n \"subscription_id\": \"{{subscription_id}}\",\n \"profile_id\": \"{{profile_id}}\",\n \"provider\": \"Firefox\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/subscriptions/get", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "subscriptions", "get" ] } }, "response": [] }, { "name": "Delete profile subscription", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"resource_id\": \"{{resource_id}}\",\n \"channel\": \"push\",\n \"subscription_id\": \"{{subscription_id}}\",\n \"profile_id\": \"{{profile_id}}\",\n \"provider\": \"Firefox\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/subscriptions/delete", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "subscriptions", "delete" ] } }, "response": [] }, { "name": "Restore deleted subscription", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"resource_id\": \"{{resource_id}}\",\n \"channel\": \"push\",\n \"subscription_id\": \"{{subscription_id}}\",\n \"profile_id\": \"{{profile_id}}\",\n \"provider\": \"Firefox\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/subscriptions/undelete", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "subscriptions", "undelete" ] } }, "response": [] }, { "name": "Suspend all subscriptions", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"resource_id\": \"{{resource_id}}\",\n \"channel\": \"email\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/subscriptions/suspend_all", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "subscriptions", "suspend_all" ] } }, "response": [] }, { "name": "Unsuspend all suspended subscriptions", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"resource_id\": \"{{resource_id}}\",\n \"channel\": \"email\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/subscriptions/unsuspend_all", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "subscriptions", "unsuspend_all" ] } }, "response": [] } ], "description": "Manage profile subscriptions to resources. Add, update, retrieve, delete, restore, suspend, and unsuspend subscriptions for individual profiles or in bulk." }, { "name": "Profile relations", "item": [ { "name": "Attach relation", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"rel_id\": 3,\n \"profile_a\": {\n \"profile_id\": \"5d63dbdb439e7306b596c5d0\"\n },\n \"profile_b\": {\n \"profile_id\": \"5d441038439e7363f3c26539\"\n },\n \"weights\": {\n \"user_like\": 2,\n \"donate\": 343,\n \"is_online\": true\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/relations/attach", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "relations", "attach" ] } }, "response": [] }, { "name": "Detach relation", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"rel_id\": 3,\n \"profile_a\": {\n \"profile_id\": \"5d63dbdb439e7306b596c5d0\"\n },\n \"profile_b\": {\n \"profile_id\": \"5d441038439e7363f3c26539\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/relations/detach", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "relations", "detach" ] } }, "response": [] }, { "name": "Modify relation properties", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"rel_id\": 3,\n \"profile_a\": {\n \"profile_id\": \"5d63dbdb439e7306b596c5d0\"\n },\n \"profile_b\": {\n \"profile_id\": \"5d441038439e7363f3c26539\"\n },\n \"weights\": {\n \"user_like\": 2,\n \"donate\": 343,\n \"is_online\": true\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/relations/strengthen", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "relations", "strengthen" ] } }, "response": [] }, { "name": "Overwrite relation properties", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"rel_id\": 3,\n \"profile_a\": {\n \"profile_id\": \"5d63dbdb439e7306b596c5d0\"\n },\n \"profile_b\": {\n \"profile_id\": \"5d441038439e7363f3c26539\"\n },\n \"weights\": {\n \"user_like\": 2,\n \"donate\": 343,\n \"is_online\": true\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/relations/edit", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "relations", "edit" ] } }, "response": [] }, { "name": "Get profile relations info", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"rel_id\": 3,\n \"profile_id\": \"5d63dbdb439e7306b596c5d0\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/relations/get_counter", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "relations", "get_counter" ] } }, "response": [] }, { "name": "Get relations list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"rel_id\": 2,\n \"profile_id\": \"669e6968ebf4ac52b623a997\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/relations/get", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "relations", "get" ] } }, "response": [] } ], "description": "Manage relationships between profiles. Attach and detach relations, modify or overwrite relation properties, and retrieve relation lists and counters." }, { "name": "Import profile", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"matching\": \"email\",\n \"email\": \"example@example.com\",\n \"detect_geo\": true,\n \"data\": {\n \"_fname\": \"Olly\",\n \"_lname\": \"Lambert\",\n \"email\": \"example@example.com\",\n \"phones\": [\n \"+79000000000\"\n ],\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email\": \"example@example.com\",\n \"resource_id\": \"{{resource_id}}\"\n },\n {\n \"channel\": \"sms\",\n \"phone\": \"+79000000000\",\n \"resource_id\": \"{{resource_id}}\"\n },\n {\n \"channel\": \"push\",\n \"subscription_id\": \"{{subscription_id}}\",\n \"provider\": \"android-firebase\",\n \"resource_id\": \"{{resource_id}}\"\n },\n {\n \"channel\": \"telegram_bot\",\n \"resource_id\": \"{{resource_id}}\",\n \"cc_data\": {\n \"id\": \"1234567890\"\n }\n },\n {\n \"channel\": \"whatsapp\",\n \"resource_id\": \"{{resource_id}}\",\n \"cc_data\": {\n \"phone\": \"+79000000000\"\n }\n },\n {\n \"channel\": \"viber\",\n \"resource_id\": \"{{resource_id}}\",\n \"cc_data\": {\n \"phone\": \"+79000000000\"\n }\n }\n ],\n \"_bdate\": \"1990-02-22T21:00:00Z\",\n \"_sex\": 0,\n \"_regdate\": \"2024-03-14T22:00:00Z\",\n \"_regip\": \"94.231.119.122\",\n \"_ip\": \"94.231.119.122\",\n \"_tz\": \"Europe/Moscow\",\n \"_postal_code\": \"390000\",\n \"_os\": \"Windows 10\",\n \"_browser\": \"Firefox\",\n \"_vendor\": \"form_#31\",\n \"{{db_custom_field}}\": 100\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/profiles/import", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "profiles", "import" ] } }, "response": [] }, { "name": "Import profile (resource categories and channel fields)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"matching\": \"email\",\n \"email\": \"example@example.com\",\n \"detect_geo\": true,\n \"data\": {\n \"_fname\": \"Olly\",\n \"_lname\": \"Lambert\",\n \"email\": \"example@example.com\",\n \"phones\": [\n \"+79000000000\"\n ],\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email\": \"example@example.com\",\n \"resource_id\": \"{{resource_id}}\",\n \"cats\": [\n \"category_1\",\n \"category_2\"\n ],\n \"custom_fields\": {\n \"_browser_name\": \"Firefox\",\n \"_device_type\": \"web\",\n \"custom_field_1\": \"test value\"\n }\n },\n {\n \"channel\": \"sms\",\n \"phone\": \"+79000000000\",\n \"resource_id\": \"{{resource_id}}\",\n \"cats\": [\n \"category_1\",\n \"category_2\"\n ]\n },\n {\n \"channel\": \"push\",\n \"subscription_id\": \"{{subscription_id}}\",\n \"provider\": \"android-firebase\",\n \"cats\": [\n \"category_1\",\n \"category_2\"\n ],\n \"resource_id\": \"{{resource_id}}\",\n \"custom_fields\": {\n \"_os\": \"Android\",\n \"_device_type\": \"mob\",\n \"custom_field_1\": \"test value\"\n }\n },\n {\n \"channel\": \"telegram_bot\",\n \"resource_id\": \"{{resource_id}}\",\n \"cc_data\": {\n \"id\": \"2104913985\"\n },\n \"cats\": [\n \"category_1\",\n \"category_2\"\n ]\n },\n {\n \"channel\": \"whatsapp\",\n \"resource_id\": \"{{resource_id}}\",\n \"cc_data\": {\n \"phone\": \"+79000000000\"\n }\n },\n {\n \"channel\": \"viber\",\n \"resource_id\": \"{{resource_id}}\",\n \"cc_data\": {\n \"phone\": \"+79000000000\"\n },\n \"cats\": [\n \"category_1\",\n \"category_2\"\n ]\n }\n ],\n \"_bdate\": \"1990-02-22T21:00:00Z\",\n \"_sex\": 0,\n \"_regdate\": \"2019-03-14T22:00:00Z\",\n \"_regip\": \"94.231.119.122\",\n \"_ip\": \"94.231.119.122\",\n \"_tz\": \"Europe/Moscow\",\n \"_postal_code\": \"390000\",\n \"_os\": \"Windows 10\",\n \"_browser\": \"Firefox\",\n \"_vendor\": \"form_#31\",\n \"{{db_custom_field}}\": 100\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/profiles/import", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "profiles", "import" ] } }, "response": [] }, { "name": "Update profile", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"matching\": \"email\",\n \"email\": \"example@example.com\",\n \"detect_geo\": true,\n \"data\": {\n \"_fname\": \"Olly\",\n \"_lname\": \"Lambert\",\n \"email\": \"example@example.com\",\n \"phones\": [\n \"+79000000000\"\n ],\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email\": \"example@example.com\",\n \"resource_id\": \"{{resource_id}}\"\n },\n {\n \"channel\": \"sms\",\n \"phone\": \"+79000000000\",\n \"resource_id\": \"{{resource_id}}\"\n },\n {\n \"channel\": \"push\",\n \"subscription_id\": \"{{subscription_id}}\",\n \"provider\": \"android-firebase\",\n \"resource_id\": \"{{resource_id}}\"\n },\n {\n \"channel\": \"telegram_bot\",\n \"resource_id\": \"{{resource_id}}\",\n \"cc_data\": {\n \"id\": \"1234567890\"\n }\n },\n {\n \"channel\": \"whatsapp\",\n \"resource_id\": \"{{resource_id}}\",\n \"cc_data\": {\n \"phone\": \"+79000000000\"\n }\n },\n {\n \"channel\": \"viber\",\n \"resource_id\": \"{{resource_id}}\",\n \"cc_data\": {\n \"phone\": \"+79000000000\"\n }\n }\n ],\n \"_bdate\": \"1990-02-22T21:00:00Z\",\n \"_sex\": 0,\n \"_regdate\": \"2024-03-14T22:00:00Z\",\n \"_regip\": \"94.231.119.122\",\n \"_ip\": \"94.231.119.122\",\n \"_tz\": \"Europe/Moscow\",\n \"_postal_code\": \"390000\",\n \"_os\": \"Windows 10\",\n \"_browser\": \"Firefox\",\n \"_vendor\": \"form_#31\",\n \"{{db_custom_field}}\": 100\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/profiles/update", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "profiles", "update" ] } }, "response": [] }, { "name": "Update profile (resource categories and channel fields)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"matching\": \"email\",\n \"email\": \"example@example.com\",\n \"detect_geo\": true,\n \"data\": {\n \"_fname\": \"Olly\",\n \"_lname\": \"Lambert\",\n \"email\": \"example@example.com\",\n \"phones\": [\n \"+79000000000\"\n ],\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email\": \"example@example.com\",\n \"resource_id\": \"{{resource_id}}\",\n \"cats\": [\n \"category_1\",\n \"category_2\"\n ],\n \"custom_fields\": {\n \"_browser_name\": \"Firefox\",\n \"_device_type\": \"web\",\n \"custom_field_1\": \"test value\"\n }\n },\n {\n \"channel\": \"sms\",\n \"phone\": \"+79000000000\",\n \"resource_id\": \"{{resource_id}}\",\n \"cats\": [\n \"category_1\",\n \"category_2\"\n ]\n },\n {\n \"channel\": \"push\",\n \"subscription_id\": \"{{subscription_id}}\",\n \"provider\": \"android-firebase\",\n \"cats\": [\n \"category_1\",\n \"category_2\"\n ],\n \"resource_id\": \"{{resource_id}}\",\n \"custom_fields\": {\n \"_os\": \"Android\",\n \"_device_type\": \"mob\",\n \"custom_field_1\": \"test value\"\n }\n },\n {\n \"channel\": \"telegram_bot\",\n \"resource_id\": \"{{resource_id}}\",\n \"cc_data\": {\n \"id\": \"2104913985\"\n },\n \"cats\": [\n \"category_1\",\n \"category_2\"\n ]\n },\n {\n \"channel\": \"whatsapp\",\n \"resource_id\": \"{{resource_id}}\",\n \"cc_data\": {\n \"phone\": \"+79000000000\"\n }\n },\n {\n \"channel\": \"viber\",\n \"resource_id\": \"{{resource_id}}\",\n \"cc_data\": {\n \"phone\": \"+79000000000\"\n },\n \"cats\": [\n \"category_1\",\n \"category_2\"\n ]\n }\n ],\n \"_bdate\": \"1990-02-22T21:00:00Z\",\n \"_sex\": 0,\n \"_regdate\": \"2019-03-14T22:00:00Z\",\n \"_regip\": \"94.231.119.122\",\n \"_ip\": \"94.231.119.122\",\n \"_tz\": \"Europe/Moscow\",\n \"_postal_code\": \"390000\",\n \"_os\": \"Windows 10\",\n \"_browser\": \"Firefox\",\n \"_vendor\": \"form_#31\",\n \"{{db_custom_field}}\": 100\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/profiles/update", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "profiles", "update" ] } }, "response": [] }, { "name": "Add multiple profiles", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"skip_triggers\": true,\n \"data\": [\n {\n \"_fname\": \"John\",\n \"_lname\": \"Doe\",\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email_data\": {\n \"email\": \"example1@example.com\"\n },\n \"resource_id\": \"{{resource_id}}\"\n }\n ]\n },\n {\n \"_fname\": \"Peter\",\n \"_lname\": \"Smith\",\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email_data\": {\n \"email\": \"example2@example.com\"\n },\n \"resource_id\": \"{{resource_id}}\"\n }\n ]\n },\n {\n \"_fname\": \"Joe\",\n \"_lname\": \"Black\",\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email_data\": {\n \"email\": \"example3@example.com\"\n },\n \"resource_id\": \"{{resource_id}}\",\n \"cats\": [\n \"category_1\",\n \"category_2\"\n ],\n \"custom_fields\": {\n \"_browser_name\": \"Firefox\",\n \"_device_type\": \"web\",\n \"custom_field_1\": \"test value\"\n }\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/profiles/add_batch", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "profiles", "add_batch" ] } }, "response": [] }, { "name": "Import multiple profiles", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"matching\": \"custom\",\n \"field_name\": \"{{db_custom_field}}\",\n \"skip_triggers\": true,\n \"data\": [\n {\n \"_fname\": \"Peter\",\n \"{{db_custom_field}}\": 1,\n \"email\": \"example1@example.com\"\n },\n {\n \"_fname\": \"John\",\n \"{{db_custom_field}}\": 2,\n \"email\": \"example2@example.com\",\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email_data\": {\n \"email\": \"example2@example.com\"\n },\n \"resource_id\": \"{{resource_id}}\",\n \"custom_fields\": {\n \"custom_field_1\": \"test value\"\n },\n \"cats\": [\n \"category_1\",\n \"category_2\"\n ]\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/profiles/import_batch", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "profiles", "import_batch" ] } }, "response": [] }, { "name": "Update multiple profiles", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"matching\": \"custom\",\n \"field_name\": \"{{db_custom_field}}\",\n \"skip_triggers\": true,\n \"data\": [\n {\n \"_fname\": \"Peter\",\n \"_lname\": \"Smith\",\n \"{{db_custom_field}}\": 1,\n \"email\": \"example1@example.com\"\n },\n {\n \"_fname\": \"John\",\n \"_lname\": \"Doe\",\n \"{{db_custom_field}}\": 2,\n \"email\": \"example2@example.com\",\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email_data\": {\n \"email\": \"example2@example.com\"\n },\n \"resource_id\": \"{{resource_id}}\",\n \"custom_fields\": {\n \"custom_field_1\": \"test value\"\n },\n \"cats\": [\n \"category_1\",\n \"category_2\"\n ]\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/profiles/update_batch", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "profiles", "update_batch" ] } }, "response": [] }, { "name": "Add profile to database", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"skip_triggers\": true,\n \"data\": {\n \"_fname\": \"John\",\n \"_lname\": \"Doe\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/profiles/add", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "profiles", "add" ] } }, "response": [] }, { "name": "Get profile data", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"email\": \"example@example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/profiles/get", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "profiles", "get" ] } }, "response": [] }, { "name": "Uploading profiles to a file", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"source_type\": \"database\",\n \"source_id\": \"{{db_id}}\",\n \"file_format\": \"csv\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/profiles/get_all", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "profiles", "get_all" ] } }, "response": [] }, { "name": "Get data for multiple profiles", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"from_id\": \"65117f62736a0e15d273fae9\",\n \"limit\": 1000,\n \"query\": {\n \"$or\": [\n {\n \"_lname\": \"Doe\"\n },\n {\n \"_city\": \"Moscow\"\n }\n ]\n },\n \"fields\": [\n \"_id\",\n \"_lname\",\n \"_fname\",\n \"_city\",\n \"subscriptions\",\n \"{{db_custom_field}}\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/profiles/list", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "profiles", "list" ] } }, "response": [] }, { "name": "Delete profile", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"matching\": \"email\",\n \"email\": \"example@example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/profiles/delete", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "profiles", "delete" ] } }, "response": [] }, { "name": "Merging multiple profiles", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"matching\": \"custom\",\n \"field_name\": \"field_1\",\n \"source\": [\n {\n \"db_id\": \"{{db_id}}\",\n \"field_value\": \"1\",\n \"data\": {\n \"_fname\": \"Profile1\",\n \"_lname\": \"LnameProfile1\"\n }\n },\n {\n \"db_id\": \"{{db_id}}\",\n \"matching\": \"email\",\n \"email\": \"test2@mail.ru\",\n \"data\": {\n \"_fname\": \"Profile2\",\n \"_lname\": \"LnameProfile2\"\n }\n }\n ],\n \"destination\": {\n \"db_id\": \"{{db_id}}\",\n \"matching\": \"email\",\n \"email\": \"test3@mail.ru\",\n \"data\": {\n \"_fname\": \"Profile3\",\n \"_lname\": \"LnameProfile3\"\n }\n },\n \"subscriptions\": true,\n \"static_segments\": true,\n \"history\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/profiles/merge/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "profiles", "merge", "" ] } }, "response": [] }, { "name": "Profile splitting", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"matching\": \"custom\",\n \"field_name\": \"{{db_custom_field}}\",\n \"source\": {\n \"db_id\": \"{{db_id}}\",\n \"field_value\": 1,\n \"data\": {\n \"_fname\": \"Profile1\",\n \"_lname\": \"LnameProfile1\"\n }\n },\n \"destination\": [\n {\n \"db_id\": \"{{db_id}}\",\n \"matching\": \"email\",\n \"email\": \"test2@mail.ru\",\n \"data\": {\n \"_fname\": \"Profile2\",\n \"_lname\": \"LnameProfile2\"\n }\n },\n {\n \"db_id\": \"{{db_id}}\",\n \"field_value\": 3,\n \"data\": {\n \"_fname\": \"Profile3\",\n \"_lname\": \"Lname3\"\n },\n \"subscription_filters\": [\n {\n \"resource_id\": \"{{resource_id}}\",\n \"channel\": \"push\",\n \"provider\": \"Safari\"\n },\n {\n \"resource_id\": \"{{resource_id}}\",\n \"channel\": \"email\"\n }\n ]\n }\n ],\n \"subscriptions\": true,\n \"static_segments\": true,\n \"history\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/profiles/split/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "profiles", "split", "" ] } }, "response": [] }, { "name": "Unsubscribe a profile", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"rtoken\": \"{{rtoken}}\",\n \"smid\": \"{{smid}}\",\n \"categories\": [\n \"category_1\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/profiles/message_unsub", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "profiles", "message_unsub" ] } }, "response": [] }, { "name": "Import subscribers", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"db_id\": \"{{db_id}}\",\n \"matching\": \"email\",\n \"email\": \"example@example.com\",\n \"data\": {\n \"_fname\": \"John\",\n \"_lname\": \"Doe\",\n \"email\": \"example@example.com\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/subscribers/import", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "subscribers", "import" ] } }, "response": [] }, { "name": "Update subscribers", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"db_id\": \"{{db_id}}\",\n \"matching\": \"email\",\n \"email\": \"example@example.com\",\n \"data\": {\n \"_fname\": \"John\",\n \"_lname\": \"Doe\",\n \"email\": \"example@example.com\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/subscribers/update", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "subscribers", "update" ] } }, "response": [] } ], "description": "Core profile management endpoints. Create, import, update, merge, split, delete, and export profiles. Supports single and batch operations, as well as unsubscribing profiles from communications.", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "function generateRandomCharacter() {", " var characters = 'abcdefghijklmnopqrstuvwxyz0123456789';", " var randomIndex = Math.floor(Math.random() * characters.length);", " return characters.charAt(randomIndex);", "}", "", "// Генерируем случайную строку заданной длины", "function generateRandomString(length) {", " var result = '';", " for (var i = 0; i < length; i++) {", " result += generateRandomCharacter();", " }", " return result;", "}", "", "// Рандомизируем поле \"subscription_id\"", "pm.variables.set(\"randomSubscriptionId\", generateRandomString(15));", "", "", "", "function generateRandomSex(){", " return Math.random(65);", "}", "pm.variables.set(\"randomSex\",generateRandomSex());" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Databases", "item": [ { "name": "Get database list", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "token", "value": "{{token}}" }, { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"limit\": 2\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/databases/list/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "databases", "list", "" ] } }, "response": [] }, { "name": "Get database information", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{db_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/databases/get/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "databases", "get", "" ] } }, "response": [] }, { "name": "Get database statistics", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{db_id}}\",\n \"resource_id\": \"{{resource_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/databases/get_counters/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "databases", "get_counters", "" ] } }, "response": [] }, { "name": "Get database fields", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{db_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/databases/fields_get/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "databases", "fields_get", "" ] } }, "response": [] }, { "name": "Database wipe", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{db_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/databases/wipe", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "databases", "wipe" ] } }, "response": [] }, { "name": "Update statistics on database", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{db_id}}\",\n \"resource_id\": \"{{resource_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/databases/refresh_counters", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "databases", "refresh_counters" ] } }, "response": [] }, { "name": "Get database counters", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 5,\n \"resource_id\": 24,\n \"format\": \"json\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/databases/get_counters", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "databases", "get_counters" ] } }, "response": [] }, { "name": "Refresh database counters", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 5,\n \"resource_id\": 24,\n \"format\": \"json\",\n \"feedback\": {\n \"type\": \"JSON\",\n \"url\": \"http://example.com/receiver\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/databases/refresh_counters", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "databases", "refresh_counters" ] } }, "response": [] } ], "description": "Inspect and manage profile databases. Retrieve database lists, field definitions, statistics, and counters. Refresh counters and wipe database contents when needed." }, { "name": "Resources", "item": [ { "name": "Get resources list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"from_id\": 1,\n \"limit\": 2\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/resources/list", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "resources", "list" ] } }, "response": [] }, { "name": "Get resource statistics", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"list_id\": \"{{db_id}}\",\n \"id\": \"{{resource_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/resources/get_counters", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "resources", "get_counters" ] } }, "response": [] }, { "name": "Update statistics on resources", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"list_id\": \"{{db_id}}\",\n \"id\": \"{{resource_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/resources/refresh_counters", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "resources", "refresh_counters" ] } }, "response": [] }, { "name": "Get resource information", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{resource_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/resources/get", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "resources", "get" ] } }, "response": [] }, { "name": "Get resource subscription fields", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{resource_id}}\",\r\n \"channel\": \"email\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/resources/fields_get", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "resources", "fields_get" ] } }, "response": [] }, { "name": "Get resource counters", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"list_id\": 24,\n \"id\": 5,\n \"format\": \"json\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/resources/get_counters", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "resources", "get_counters" ] } }, "response": [] }, { "name": "Refresh resource counters", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 24,\n \"list_id\": 1,\n \"format\": \"json\",\n \"feedback\": {\n \"type\": \"JSON\",\n \"url\": \"http://example.com/receiver\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/resources/refresh_counters", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "resources", "refresh_counters" ] } }, "response": [] }, { "name": "Push subscribe", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"channel\": \"push\",\n \"subscription_id\": \"{{subscription_id}}\",\n \"provider\": \"android-firebase\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/resources/push_subscribe", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "resources", "push_subscribe" ] } }, "response": [] } ], "description": "Manage communication resources (email, SMS, push, etc.). Retrieve resource lists, fetch subscription fields, get and refresh counters, and register push subscriptions." }, { "name": "Segment", "item": [ { "name": "Create static segment", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"name\": \"New stat segment\",\n \"is_static\": true,\n \"is_refresh_daily\": true,\n \"segment\": [\n {\n \"condition\": \"and\",\n \"limit\": 0,\n \"list_id\": \"{{db_id}}\",\n \"percent_from\": 1,\n \"percent_to\": 99,\n \"queries\": [\n {\n \"compo\": \"domaingroup\",\n \"name\": \"email\",\n \"operator\": \"equal\",\n \"type\": \"email\",\n \"value\": [\n {\n \"name\": \"domaingroup\",\n \"value\": \"Yahoo! (US)\"\n }\n ]\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/segments/add/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "segments", "add", "" ] } }, "response": [] }, { "name": "Create dynamic segment", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"name\": \"New dynamic segment\",\n \"segment\": [\n {\n \"condition\": \"and\",\n \"limit\": 0,\n \"list_id\": \"{{db_id}}\",\n \"percent_from\": 0,\n \"percent_to\": 99,\n \"queries\": [\n {\n \"compo\": \"default\",\n \"name\": \"statseg\",\n \"operator\": \"once\",\n \"type\": \"statseg\",\n \"value\": [\n {\n \"name\": \"segment_id\",\n \"value\": 1\n }\n ]\n },\n {\n \"compo\": \"default\",\n \"name\": \"statseg\",\n \"operator\": \"once\",\n \"type\": \"statseg\",\n \"value\": [\n {\n \"name\": \"segment_id\",\n \"value\": 2\n }\n ]\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/segments/add/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "segments", "add", "" ] } }, "response": [] }, { "name": "Update static segment", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{stsegment_id}}\",\n \"name\": \"Updated static segment\",\n \"is_refresh_daily\": true,\n \"segment\": [\n {\n \"condition\": \"and\",\n \"limit\": 0,\n \"list_id\": \"{{db_id}}\",\n \"percent_from\": 1,\n \"percent_to\": 99,\n \"queries\": [\n {\n \"compo\": \"domaingroup\",\n \"name\": \"email\",\n \"operator\": \"equal\",\n \"type\": \"email\",\n \"value\": [\n {\n \"name\": \"domaingroup\",\n \"value\": \"Yahoo! (US)\"\n }\n ]\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/segments/update/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "segments", "update", "" ] } }, "response": [] }, { "name": "Update dynamic segment", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{dynsegment_id}}\",\n \"name\": \"Updated dynamic segment\",\n \"segment\": [\n {\n \"condition\": \"and\",\n \"limit\": 0,\n \"list_id\": \"{{db_id}}\",\n \"percent_from\": 0,\n \"percent_to\": 99,\n \"queries\": [\n {\n \"compo\": \"default\",\n \"name\": \"statseg\",\n \"operator\": \"once\",\n \"type\": \"statseg\",\n \"value\": [\n {\n \"name\": \"segment_id\",\n \"value\": 1\n }\n ]\n },\n {\n \"compo\": \"default\",\n \"name\": \"statseg\",\n \"operator\": \"once\",\n \"type\": \"statseg\",\n \"value\": [\n {\n \"name\": \"segment_id\",\n \"value\": 2\n }\n ]\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/segments/update/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "segments", "update", "" ] } }, "response": [] }, { "name": "Get segment information", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{segment_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/segments/get/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "segments", "get", "" ] } }, "response": [] }, { "name": "Get segments list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"limit\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/segments/list/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "segments", "list", "" ] } }, "response": [] }, { "name": "Delete segment", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{segment_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/segments/delete/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "segments", "delete", "" ] } }, "response": [] }, { "name": "Get segment statistics", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{segment_id}}\",\n \"resource_id\": \"{{resource_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/segments/get_counters/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "segments", "get_counters", "" ] } }, "response": [] }, { "name": "Update statistics on segment", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"resource_id\": \"{{resource_id}}\",\n \"id\": \"{{segment_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/segments/refresh_counters", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "segments", "refresh_counters" ] } }, "response": [] } ], "description": "Create, update, and delete both static and dynamic audience segments. Retrieve segment lists, details, statistics, and refresh segment counters." }, { "name": "Managing profiles in static segment", "item": [ { "name": "Add profile", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"segment_id\": \"{{stsegment_id}}\",\n \"db_id\": \"{{db_id}}\",\n \"profile_id\": \"{{profile_id}}\",\n \"skip_triggers\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/profiles/segstatic/add", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "profiles", "segstatic", "add" ] } }, "response": [] }, { "name": "Remove profile", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"segment_id\": \"{{stsegment_id}}\",\n \"db_id\": \"{{db_id}}\",\n \"profile_id\": \"{{profile_id}}\",\n \"skip_triggers\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/profiles/segstatic/remove", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "profiles", "segstatic", "remove" ] } }, "response": [] }, { "name": "Get profile data in a static segment", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{stsegment_id}}\",\r\n \"from_id\": \"{{product_id}}\",\r\n \"from_db\": \"{{db_id}}\",\r\n \"count\": 25,\r\n \"fields\": [\r\n \"email\"\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/profiles/segstatic/list", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "profiles", "segstatic", "list" ] } }, "response": [] } ], "description": "Add or remove profiles from a static segment, and retrieve the list of profiles currently assigned to it." }, { "name": "Suppression lists", "item": [ { "name": "Suppression list actions", "item": [ { "name": "Check if email is suppressed", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"email\": \"john@example.com\",\r\n \"id\": \"{{suplist_id}}\" \r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/suppresses/email_check", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "suppresses", "email_check" ] } }, "response": [] }, { "name": "Add email to suppression list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"email\": \"john@example.com\",\r\n \"id\": \"{{suplist_id}}\" \r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/suppresses/email_add", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "suppresses", "email_add" ] } }, "response": [] }, { "name": "Add multiple emails to suppression list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"emails\": [\r\n \"example@example.com\",\r\n \"example1@example.com\",\r\n \"example2@example.com\"\r\n ],\r\n \"id\": \"{{suplist_id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/suppresses/emails_add", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "suppresses", "emails_add" ] } }, "response": [] }, { "name": "Remove email from suppression list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"email\": \"john@example.com\",\r\n \"id\": \"{{suplist_id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/suppresses/email_remove", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "suppresses", "email_remove" ] } }, "response": [] }, { "name": "Remove all emails from suppression list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{suplist_id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/suppresses/emails_remove", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "suppresses", "emails_remove" ] } }, "response": [] }, { "name": "Check if domain is suppressed", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"domain\": \"example.com\",\r\n \"id\": \"{{suplist_id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/suppresses/domain_check", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "suppresses", "domain_check" ] } }, "response": [] }, { "name": "Add domain to suppression list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"domain\": \"example.com\",\r\n \"id\": \"{{suplist_id}}\" \r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/suppresses/domain_add", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "suppresses", "domain_add" ] } }, "response": [] }, { "name": "Add multiple domains to suppression list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"domains\": [\r\n \"example.com\",\r\n \"example1.com\"\r\n ],\r\n \"id\": \"{{suplist_id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/suppresses/domains_add", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "suppresses", "domains_add" ] } }, "response": [] }, { "name": "Remove domain from suppression list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"domain\": \"example.com\",\r\n \"id\": \"{{suplist_id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/suppresses/domain_remove", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "suppresses", "domain_remove" ] } }, "response": [] }, { "name": "Remove all domains from suppression list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{suplist_id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/suppresses/domains_remove", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "suppresses", "domains_remove" ] } }, "response": [] }, { "name": "Check if phone number is suppressed", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{suplist_id}}\",\r\n \"value\": \"+79000000001\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/suppresses/phone_check", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "suppresses", "phone_check" ] } }, "response": [] }, { "name": "Add phone number to suppression list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{suplist_id}}\",\r\n \"value\": \"+79000000001\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/suppresses/phone_add", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "suppresses", "phone_add" ] } }, "response": [] }, { "name": "Add multiple phones to suppression list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{suplist_id}}\",\r\n \"values\": [\r\n \"+79000000001\",\r\n \"+79999999991\"\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/suppresses/phones_add", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "suppresses", "phones_add" ] } }, "response": [] }, { "name": "Remove phone number from suppression list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{suplist_id}}\",\r\n \"value\": \"+79000000001\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/suppresses/phone_remove", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "suppresses", "phone_remove" ] } }, "response": [] }, { "name": "Remove all phone numbers from suppression list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{suplist_id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/suppresses/phones_remove", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "suppresses", "phones_remove" ] } }, "response": [] } ], "description": "Add, remove, and check individual or bulk entries (emails, phone numbers, domains) against suppression lists to control message deliverability." }, { "name": "Create suppression list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"New suppression list\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/suppresses/add", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "suppresses", "add" ] } }, "response": [] }, { "name": "Update suppression list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{suplist_id}}\",\r\n \"name\": \"Updated suppression list\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/suppresses/update", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "suppresses", "update" ] } }, "response": [] }, { "name": "Get suppression list info", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{suplist_id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/suppresses/get", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "suppresses", "get" ] } }, "response": [] }, { "name": "Get the list of suppression lists", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"from_id\": 1,\n \"limit\": 2\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/suppresses/list", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "suppresses", "list" ] } }, "response": [] }, { "name": "Delete suppression list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{suplist_id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/suppresses/delete", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "suppresses", "delete" ] } }, "response": [] }, { "name": "Upload suppression list data to file", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{suplist_id}}\",\r\n \"type\": \"emails\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/suppresses/export", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "suppresses", "export" ] } }, "response": [] } ], "description": "Create, update, delete, and export suppression lists. Retrieve list details and upload suppression data to a file for compliance and deliverability management." }, { "name": "Templates", "item": [ { "name": "Get templates list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"limit\": 2\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/templates/list", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "templates", "list" ] } }, "response": [] }, { "name": "Add template", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"name\": \"New template\",\n \"descr\": \"Template description\",\n \"channels\": [\n {\n \"sid\": \"email\",\n \"fields\": {\n \"text\": \"Текстовая версия письма Unsubscribe: {{$.List.Unsubscribe}}\",\n \"html\": \"Hello, world! unsubscribe\",\n \"subject\": \"Тема письма\",\n \"from_email\": \"\",\n \"from_name\": \"\",\n \"replyto_email\": \"\",\n \"replyto_name\": \"\",\n \"is_not_inline\": true\n }\n }\n ],\n \"json_url\": \"https://altcraft.com/example/message.json\",\n \"ui_tags\": [\n \"tag_1\",\n \"tag_2\"\n ],\n \"groups\": [\n 1,\n 2\n ],\n \"is_draft\": false,\n \"is_confirm\": false,\n \"suppress_id\": \"{{suplist_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/templates/add", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "templates", "add" ] } }, "response": [] }, { "name": "Update template", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{template_id}}\",\n \"name\": \"Updated template\",\n \"descr\": \"Template used in Double Opt-In scenario\",\n \"channels\": [\n {\n \"sid\": \"push\",\n \"fields\": {\n \"title\": \"Welcome\",\n \"body\": \"Hello, world!\",\n \"icon\": \"https://example.com/images/icon.jpg\",\n \"click_url\": \"https://example.com\",\n \"custom_push_json_raw\": \"{}\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/templates/update", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "templates", "update" ] } }, "response": [] }, { "name": "Get template info", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{template_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/templates/get", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "templates", "get" ] } }, "response": [] }, { "name": "Delete template", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{template_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/templates/delete", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "templates", "delete" ] } }, "response": [] } ], "description": "Manage message templates used in messages. Create, retrieve, update, and delete templates across all communication channels." }, { "name": "Messages", "item": [ { "name": "Broadcast messages", "item": [ { "name": "Get broadcasts list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"limit\": 2\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/broadcasts/list", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "broadcasts", "list" ] } }, "response": [] }, { "name": "Get broadcast information", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{campaign_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/broadcasts/get", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "broadcasts", "get" ] } }, "response": [] }, { "name": "Create broadcast campaign", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"content\": [\n {\n \"from_email\": \"broadcast@altcraft.com\",\n \"from_name\": \"Victor\",\n \"message_id\": \"{{template_id}}\",\n \"replyto_email\": \"broadcast@altcraft.com\",\n \"replyto_name\": \"Victoria\",\n \"subject\": \"Hello\"\n }\n ],\n \"data_type\": \"list\",\n \"data_id\": \"{{db_id}}\",\n \"is_active\": true,\n \"limit\": 1,\n \"name\": \"New broadcast\",\n \"resource_id\": \"{{resource_id}}\",\n \"send_channel\": \"email\",\n \"start_schedule\": {\n \"start_hours\": [\n 1,\n 2,\n 3,\n 4\n ],\n \"start_mins\": [\n 1,\n 2,\n 3,\n 4\n ],\n \"start_mdays\": [\n 1\n ],\n \"start_months\": [\n 12\n ],\n \"start_wdays\": [],\n \"start_years\": [\n 2024\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/broadcasts/add", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "broadcasts", "add" ] } }, "response": [] }, { "name": "Update broadcast campaign", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"virtual_sender_id\": \"{{vsender_id}}\",\n \"content\": [\n {\n \"from_email\": \"example@example.com\",\n \"from_name\": \"Alexandra\",\n \"message_id\": \"{{template_id}}\",\n \"replyto_email\": \"example@example.com\",\n \"replyto_name\": \"Victoria\",\n \"subject\": \"Hi!\"\n }\n ],\n \"custom_tracking_domains\": [\n \"trk.example.com\",\n \"trk.example.org\"\n ],\n \"data_type\": \"list\",\n \"data_id\": \"{{db_id}}\",\n \"id\": \"{{campaign_id}}\",\n \"is_active\": true,\n \"limit\": 10,\n \"name\": \"Broadcast\",\n \"resource_id\": \"{{resource_id}}\",\n \"start_schedule\": {\n \"start_hours\": [\n 1,\n 2,\n 3,\n 4\n ],\n \"start_mdays\": [\n 1\n ],\n \"start_mins\": [\n 1,\n 2,\n 3,\n 4\n ],\n \"start_months\": [\n 12\n ],\n \"start_wdays\": [],\n \"start_years\": [\n 2024\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/broadcasts/update", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "broadcasts", "update" ] } }, "response": [] }, { "name": "Launch a broadcast campaign", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{campaign_id}}\",\n \"override_source_id\": 1,\n \"override_source_type\": \"list\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/broadcasts/start", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "broadcasts", "start" ] } }, "response": [] } ], "description": "Create, update, retrieve, list, and launch one-time broadcast messages sent to a defined audience." }, { "name": "Regular messages", "item": [ { "name": "Get regular campaigns list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"limit\": 2\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/regulars/list/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "regulars", "list", "" ] } }, "response": [] }, { "name": "Get regular campaign information", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{campaign_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/regulars/get", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "regulars", "get" ] } }, "response": [] }, { "name": "Create regular campaign", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"content\": [\n {\n \"from_email\": \"regular@altcraft.com\",\n \"from_name\": \"Paul\",\n \"message_id\": \"{{template_id}}\",\n \"replyto_email\": \"regular@altcraft.com\",\n \"replyto_name\": \"Roman\",\n \"subject\": \"Hello\"\n }\n ],\n \"data_id\": \"{{db_id}}\",\n \"data_type\": \"list\",\n \"is_active\": true,\n \"limit\": 1,\n \"name\": \"Regular campaign #1\",\n \"resource_id\": \"{{resource_id}}\",\n \"send_channel\": \"email\",\n \"start_schedule\": {\n \"start_hours\": [\n 1,\n 2,\n 3,\n 4\n ],\n \"start_mdays\": [\n 1\n ],\n \"start_mins\": [\n 1,\n 2,\n 3,\n 4\n ],\n \"start_months\": [\n 12\n ],\n \"start_wdays\": [],\n \"start_years\": [\n 2024\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/regulars/add/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "regulars", "add", "" ] } }, "response": [] }, { "name": "Update regular campaign", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"virtual_sender_id\": \"{{vsender_id}}\",\n \"content\": [\n {\n \"from_email\": \"regular@altcraft.com\",\n \"from_name\": \"Roman\",\n \"message_id\": \"{{template_id}}\",\n \"replyto_email\": \"regular@altcraft.com\",\n \"replyto_name\": \"Romana\",\n \"subject\": \"Hi!\"\n }\n ],\n \"custom_tracking_domains\": [\n \"trk.example.com\",\n \"trk.example.org\"\n ],\n \"data_id\": \"{{db_id}}\",\n \"data_type\": \"list\",\n \"id\": \"{{campaign_id}}\",\n \"is_active\": true,\n \"limit\": 1,\n \"name\": \"Regular campaign 1\",\n \"resource_id\": \"{{resource_id}}\",\n \"start_schedule\": {\n \"start_hours\": [\n 1,\n 2,\n 3,\n 4\n ],\n \"start_mdays\": [\n 1\n ],\n \"start_mins\": [\n 1,\n 2,\n 3,\n 4\n ],\n \"start_months\": [\n 12\n ],\n \"start_wdays\": [],\n \"start_years\": [\n 2024\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/regulars/update", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "regulars", "update" ] } }, "response": [] }, { "name": "Launch a regular campaign", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{campaign_id}}\",\n \"override_source_id\": 1,\n \"override_source_type\": \"list\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/regulars/start", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "regulars", "start" ] } }, "response": [] } ], "description": "Create, update, retrieve, list, and launch recurring regular messages that run on a defined schedule." }, { "name": "Trigger messages", "item": [ { "name": "Get trigger campaigns list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"limit\": 2\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/triggers/list/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "triggers", "list", "" ] } }, "response": [] }, { "name": "Get trigger campaign information", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{campaign_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/triggers/get", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "triggers", "get" ] } }, "response": [] }, { "name": "Create trigger campaign", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"name\": \"New trigger campaign №1\",\n \"content\": [\n {\n \"subject\": \"Maybe very important message\",\n \"from_email\": \"\",\n \"from_name\": \"James\",\n \"replyto_email\": \"\",\n \"replyto_name\": \"\",\n \"message_id\": \"{{template_id}}\"\n }\n ],\n \"trigger_type\": \"api_call\",\n \"send_channel\": \"email\",\n \"list_id\": \"{{db_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/triggers/add", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "triggers", "add" ] } }, "response": [] }, { "name": "Update trigger campaign", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{campaign_id}}\",\n \"name\": \"New trigger campaign update\",\n \"content\": [\n {\n \"subject\": \"Maybe not very important message\",\n \"from_email\": \"\",\n \"from_name\": \"Alex\",\n \"replyto_email\": \"\",\n \"replyto_name\": \"\",\n \"message_id\": \"{{template_id}}\"\n }\n ],\n \"trigger_type\": \"api_call\",\n \"list_id\": \"{{db_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/triggers/update/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "triggers", "update", "" ] } }, "response": [] }, { "name": "Clone a trigger campaign", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{campaign_id}}\",\n \"name\": \"Clone trigger campaign #1\",\n \"is_active\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/triggers/clone", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "triggers", "clone" ] } }, "response": [] }, { "name": "Trigger launch (API call)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{campaign_id}}\",\n \"matching\": \"profile_id\",\n \"profile_id\": \"{{profile_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/triggers/start/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "triggers", "start", "" ] } }, "response": [] }, { "name": "Trigger launch (API call) (apicontent)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{campaign_id}}\",\n \"matching\": \"profile_id\",\n \"profile_id\": \"{{profile_id}}\",\n \"content\": {\n \"data_lines\": [\n \"Channel A\",\n \"Channel B\"\n ],\n \"email_title\": \"New videos on your favorite channels\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/triggers/start/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "triggers", "start", "" ] } }, "response": [] }, { "name": "Trigger launch (API call) (attach files)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{campaign_id}}\",\n \"matching\": \"profile_id\",\n \"profile_id\": \"{{profile_id}}\",\n \"attach\": [\n {\n \"data\": \"data:text/csv;base64,5LuK5pel44GvCg==\",\n \"name\": \"日本.txt\"\n },\n {\n \"data\": \"data:text/csv;base64,SEVMTE8K\",\n \"name\": \"US.txt\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/triggers/start/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "triggers", "start", "" ] } }, "response": [] }, { "name": "Trigger launch (API call) (custom data for Action Hooks)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{campaign_id}}\",\n \"matching\": \"profile_id\",\n \"profile_id\": \"{{profile_id}}\",\n \"custom_data\": {\n \"sending_time\": \"12:31:12\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/triggers/start/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "triggers", "start", "" ] } }, "response": [] }, { "name": "Profile import + trigger campaign launch", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"trigger_id\": \"{{campaign_id}}\",\n \"matching\": \"email\",\n \"email\": \"example@example.com\",\n \"detect_geo\": true,\n \"data\": {\n \"_fname\": \"Olly\",\n \"_lname\": \"Lambert\",\n \"email\": \"example@example.com\",\n \"phones\": [\n \"+79000000000\"\n ],\n \"_bdate\": \"1990-02-22T21:00:00Z\",\n \"{{db_custom_field}}\": 101,\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email\": \"example@example.com\",\n \"resource_id\": \"{{resource_id}}\"\n },\n {\n \"channel\": \"phone\",\n \"phone\": \"+79000000000\",\n \"resource_id\": \"{{resource_id}}\"\n }\n ]\n },\n \"timeout\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 5\n },\n \"content\": {\n \"data_lines\": [\n \"Channel A\",\n \"Channel B\"\n ],\n \"email_title\": \"New videos on your favorite channels\"\n },\n \"attach\": [\n {\n \"data\": \"data:text/csv;base64,5LuK5pel44GvCg==\",\n \"name\": \"Attach.txt\"\n }\n ],\n \"custom_data\": {\n \"sending_time\": \"12:31:12\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/triggers/import_and_start/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "triggers", "import_and_start", "" ] } }, "response": [] }, { "name": "Task for bulk trigger launch", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{campaign_id}}\",\n \"format\": \"json\",\n \"matching\": \"email\",\n \"data\": [\n {\n \"email\": \"example1@example.com\"\n },\n {\n \"email\": \"example2@example.com\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/triggers/start_batch_task", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "triggers", "start_batch_task" ] } }, "response": [] }, { "name": "Task for bulk profiles import + trigger launch", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"matching\": \"email\",\n \"data\": [\n {\n \"data\": {\n \"_fname\": \"Victoria\",\n \"_lname\": \" Beckham\",\n \"email\": \"example1@example.com\",\n \"phones\": \"+79000000000\",\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email\": \"example2@example.com\",\n \"resource_id\": \"{{resource_id}}\"\n },\n {\n \"channel\": \"phone\",\n \"phone\": \"+79000005478\",\n \"resource_id\": \"{{resource_id}}\"\n }\n ]\n }\n },\n {\n \"data\": {\n \"_fname\": \"David\",\n \"_lname\": \" Beckham\",\n \"email\": \"example3@example.com\",\n \"phones\": \"+79000000001\",\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email\": \"example14@example.com\",\n \"resource_id\": \"{{resource_id}}\"\n },\n {\n \"channel\": \"phone\",\n \"phone\": \"+79000000000\",\n \"resource_id\": \"{{resource_id}}\"\n }\n ]\n }\n }\n ],\n \"trigger_id\": \"{{campaign_id}}\",\n \"timeout\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 5\n },\n \"content\": {\n \"page\": \"registration_form\"\n },\n \"attach\": [\n {\n \"data\": \"data:text/csv;base64,5LuK5pel44GvCg==\",\n \"name\": \"Attach.txt\"\n }\n ],\n \"custom_data\": {\n \"sending_time\": \"12:31:12\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/triggers/import_and_start_batch_task", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "triggers", "import_and_start_batch_task" ] } }, "response": [] }, { "name": "Bulk trigger launch", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"trigger_id\": \"{{campaign_id}}\",\n \"format\": \"json\",\n \"skip_triggers\": false,\n \"detect_geo\": true,\n \"matching\": \"email\",\n \"data\": [\n {\n \"_fname\": \"Lili\",\n \"_lname\": \"Collins\",\n \"email\": \"john@example.com\",\n \"phones\": \"+79000000000\",\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email\": \"example1@example.com\",\n \"priority\": 0,\n \"resource_id\": \"{{resource_id}}\",\n \"status\": 0\n }\n ]\n },\n {\n \"_fname\": \"Eva\",\n \"_lname\": \"Collins\",\n \"email\": \"example2@example.com\",\n \"phones\": \"+79000000001\",\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email\": \"example2@example.com\",\n \"priority\": 0,\n \"resource_id\": \"{{resource_id}}\",\n \"status\": 0\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/triggers/start_batch", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "triggers", "start_batch" ] } }, "response": [] }, { "name": "Bulk profiles import + trigger campaign launch", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"trigger_id\": \"{{campaign_id}}\",\n \"format\": \"json\",\n \"skip_triggers\": false,\n \"detect_geo\": true,\n \"matching\": \"email\",\n \"data\": [\n {\n \"_fname\": \"Lili\",\n \"_lname\": \"Collins\",\n \"email\": \"example1@example.com\",\n \"phones\": \"+79000000000\",\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email\": \"example1@example.com\",\n \"priority\": 0,\n \"resource_id\": \"{{resource_id}}\",\n \"status\": 0\n }\n ]\n },\n {\n \"_fname\": \"Eva\",\n \"_lname\": \"Collins\",\n \"email\": \"example2@example.com\",\n \"phones\": \"+79000000001\",\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email\": \"example2@example.com\",\n \"priority\": 0,\n \"resource_id\": \"{{resource_id}}\",\n \"status\": 0\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/triggers/import_and_start_batch", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "triggers", "import_and_start_batch" ] } }, "response": [] }, { "name": "Bulk trigger launch (triggers)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"trigger_id\": \"{{campaign_id}}\",\n \"format\": \"json\",\n \"skip_triggers\": false,\n \"detect_geo\": true,\n \"matching\": \"email\",\n \"data\": [\n {\n \"_fname\": \"Lili\",\n \"_lname\": \"Collins\",\n \"email\": \"john@example.com\",\n \"phones\": \"+79000000000\",\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email\": \"example1@example.com\",\n \"priority\": 0,\n \"resource_id\": \"{{resource_id}}\",\n \"status\": 0\n }\n ]\n },\n {\n \"_fname\": \"Eva\",\n \"_lname\": \"Collins\",\n \"email\": \"example2@example.com\",\n \"phones\": \"+79000000001\",\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email\": \"example2@example.com\",\n \"priority\": 0,\n \"resource_id\": \"{{resource_id}}\",\n \"status\": 0\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/triggers/start_batch", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "triggers", "start_batch" ] } }, "response": [] }, { "name": "Task for bulk trigger launch (triggers)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{campaign_id}}\",\n \"format\": \"json\",\n \"matching\": \"email\",\n \"data\": [\n {\n \"email\": \"example1@example.com\"\n },\n {\n \"email\": \"example2@example.com\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/triggers/start_batch_task", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "triggers", "start_batch_task" ] } }, "response": [] }, { "name": "Bulk profiles import + trigger launch (triggers)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"trigger_id\": \"{{campaign_id}}\",\n \"format\": \"json\",\n \"skip_triggers\": false,\n \"detect_geo\": true,\n \"matching\": \"email\",\n \"data\": [\n {\n \"_fname\": \"Lili\",\n \"_lname\": \"Collins\",\n \"email\": \"example1@example.com\",\n \"phones\": \"+79000000000\",\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email\": \"example1@example.com\",\n \"priority\": 0,\n \"resource_id\": \"{{resource_id}}\",\n \"status\": 0\n }\n ]\n },\n {\n \"_fname\": \"Eva\",\n \"_lname\": \"Collins\",\n \"email\": \"example2@example.com\",\n \"phones\": \"+79000000001\",\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email\": \"example2@example.com\",\n \"priority\": 0,\n \"resource_id\": \"{{resource_id}}\",\n \"status\": 0\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/triggers/import_and_start_batch", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "triggers", "import_and_start_batch" ] } }, "response": [] }, { "name": "Task for bulk profiles import + trigger launch (triggers)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"matching\": \"email\",\n \"data\": [\n {\n \"data\": {\n \"_fname\": \"Victoria\",\n \"_lname\": \" Beckham\",\n \"email\": \"example1@example.com\",\n \"phones\": \"+79000000000\",\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email\": \"example2@example.com\",\n \"resource_id\": \"{{resource_id}}\"\n },\n {\n \"channel\": \"phone\",\n \"phone\": \"+79000005478\",\n \"resource_id\": \"{{resource_id}}\"\n }\n ]\n }\n },\n {\n \"data\": {\n \"_fname\": \"David\",\n \"_lname\": \" Beckham\",\n \"email\": \"example3@example.com\",\n \"phones\": \"+79000000001\",\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email\": \"example14@example.com\",\n \"resource_id\": \"{{resource_id}}\"\n },\n {\n \"channel\": \"phone\",\n \"phone\": \"+79000000000\",\n \"resource_id\": \"{{resource_id}}\"\n }\n ]\n }\n }\n ],\n \"trigger_id\": \"{{campaign_id}}\",\n \"timeout\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 5\n },\n \"content\": {\n \"page\": \"registration_form\"\n },\n \"attach\": [\n {\n \"data\": \"data:text/csv;base64,5LuK5pel44GvCg==\",\n \"name\": \"Attach.txt\"\n }\n ],\n \"custom_data\": {\n \"sending_time\": \"12:31:12\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/triggers/import_and_start_batch_task", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "triggers", "import_and_start_batch_task" ] } }, "response": [] } ], "description": "Create, update, retrieve, clone, and launch trigger messages that fire in response to specific profile events or API calls. Supports single and bulk trigger launches, profile import with trigger launch, and batch task operations." }, { "name": "Activate campaign", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{campaign_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/activate/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "activate", "" ] } }, "response": [] }, { "name": "Deactivate campaign", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{campaign_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/deactivate", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "deactivate" ] } }, "response": [] }, { "name": "Get campaign list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"limit\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/list", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "list" ] } }, "response": [] }, { "name": "Get campaign information", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{campaign_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/get", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "get" ] } }, "response": [] }, { "name": "Get campaign log", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{campaign_id}}\",\n \"limit\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/log_v2", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "log_v2" ] } }, "response": [] }, { "name": "Clone campaign", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{campaign_id}}\",\n \"name\": \"Clone of any campaign\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/clone", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "clone" ] } }, "response": [] }, { "name": "Delete campaign", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{campaign_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/delete", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "delete" ] } }, "response": [] }, { "name": "Get campaign status", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{campaign_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/campaigns/get_status", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "campaigns", "get_status" ] } }, "response": [] } ], "description": "General message management endpoints. List, retrieve, clone, activate, deactivate, delete messages, check statuses, and access message logs. Parent folder for broadcast, regular, and trigger message sub-folders." }, { "name": "Scenarios", "item": [ { "name": "Engage profile in scenario", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{workflow_id}}\",\n \"matching\": \"profile_id\",\n \"profile_id\": \"{{profile_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/workflows/start", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "workflows", "start" ] } }, "response": [] }, { "name": "Engage profile in scenario (attach file)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{workflow_id}}\",\n \"matching\": \"profile_id\",\n \"profile_id\": \"{{profile_id}}\",\n \"attach\": [\n {\n \"data\": \"data:text/csv;base64,5LuK5pel44GvCg==\",\n \"name\": \"日本.txt\"\n },\n {\n \"data\": \"data:text/csv;base64,SEVMTE8K\",\n \"name\": \"US.txt\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/workflows/start", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "workflows", "start" ] } }, "response": [] }, { "name": "Import and engage profile in scenario", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"workflow_id\": \"{{workflow_id}}\",\n \"matching\": \"email\",\n \"email\": \"example001@example.com\",\n \"data\": {\n \"subscriptions\": [\n {\n \"email\": \"example001@example.com\",\n \"resource_id\": \"{{resource_id}}\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/workflows/import_and_start", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "workflows", "import_and_start" ] } }, "response": [] }, { "name": "Import and engage profile in scenario (apicontent)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"workflow_id\": \"{{workflow_id}}\",\n \"matching\": \"email\",\n \"email\": \"fdsa@example.com\",\n \"data\": {\n \"subscriptions\": [\n {\n \"email\": \"example001@example.com\",\n \"resource_id\": \"{{resource_id}}\"\n }\n ]\n },\n \"content\": {\n \"one\": \"My email = example001@example.com\",\n \"two\": \"Timestamp: 1595512477\",\n \"three\": \"Three\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/workflows/import_and_start", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "workflows", "import_and_start" ] } }, "response": [] }, { "name": "Batch import and engage profiles in a scenario", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"workflow_id\": \"{{workflow_id}}\",\n \"matching\": \"email\",\n \"data\": [\n {\n \"data\": {\n \"_fname\": \"Alisa\",\n \"_lname\": \"Lambert\",\n \"email\": \"profile590@example.com\",\n \"phones\": \"+79000000000\"\n }\n },\n {\n \"data\": {\n \"_fname\": \"Alex\",\n \"_lname\": \"Lambert\",\n \"email\": \"profile890@example.com\",\n \"phones\": \"+79000000000\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/workflows/import_and_start_batch", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "workflows", "import_and_start_batch" ] } }, "response": [] }, { "name": "Task for batch import and engaging profiles in the scenario", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"workflow_id\": \"{{workflow_id}}\",\n \"matching\": \"email\",\n \"data\": [\n {\n \"data\": {\n \"_fname\": \"Herbert\",\n \"_lname\": \"Lambert\",\n \"email\": \"zanitrevitteu1@example.com\",\n \"phones\": \"+79123456789\"\n }\n },\n {\n \"data\": {\n \"_fname\": \"Bert\",\n \"_lname\": \"Lambert\",\n \"email\": \"zanitrevitteu2@example.com\",\n \"phones\": \"+79123456780\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/workflows/import_and_start_batch_task", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "workflows", "import_and_start_batch_task" ] } }, "response": [] }, { "name": "Get scenarios list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"from_id\": \"{{workflow_id}}\",\n \"limit\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/workflows/list", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "workflows", "list" ] } }, "response": [] }, { "name": "Activate workflow", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"skip_profiles\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/workflows/activate", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "workflows", "activate" ] } }, "response": [] }, { "name": "Deactivate workflow", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"skip_profiles\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/workflows/deactivate", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "workflows", "deactivate" ] } }, "response": [] } ], "description": "Trigger and manage automation scenarios (workflows). Engage individual or batches of profiles in scenarios, import profiles and start workflows simultaneously, and activate or deactivate workflows." }, { "name": "Promocode", "item": [ { "name": "Import promo codes", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"codes\": [\n \"CODE-1\",\n \"CODE-2\"\n ],\n \"loyalty_id\": \"{{loyalty_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/promocodes/import", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "promocodes", "import" ] } }, "response": [] }, { "name": "Get promo code information", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"code\": \"CODE-1\",\n \"loyalty_id\": \"{{loyalty_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/promocodes/get", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "promocodes", "get" ] } }, "response": [] }, { "name": "Attach promo code", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"matching\": \"profile_id\",\n \"profile_id\": \"{{profile_id}}\",\n \"loyalty_id\": \"{{loyalty_id}}\",\n \"code\": \"CODE-1\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/promocodes/attach", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "promocodes", "attach" ] } }, "response": [] }, { "name": "Activate promo code", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"code\": \"CODE-1\",\n \"loyalty_id\": \"{{loyalty_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/promocodes/activate", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "promocodes", "activate" ] } }, "response": [] }, { "name": "Update promo code", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"activated\": true,\n \"code\": \"CODE-1\",\n \"expire_date\": \"2024-08-10T08:00:00Z\",\n \"loyalty_id\": \"{{loyalty_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/promocodes/update", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "promocodes", "update" ] } }, "response": [] }, { "name": "Detach promo code", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"code\": \"CODE-1\",\n \"db_id\": \"{{db_id}}\",\n \"loyalty_id\": \"{{loyalty_id}}\",\n \"matching\": \"profile_id\",\n \"profile_id\": \"{{profile_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/promocodes/detach", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "promocodes", "detach" ] } }, "response": [] }, { "name": "Get all promo codes", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"loyalty_id\": \"{{loyalty_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/promocodes/export_all", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "promocodes", "export_all" ] } }, "response": [] } ], "description": "Manage promotional codes. Import, attach, detach, activate, update, and retrieve promo codes, as well as export the full list of codes." }, { "name": "Goals", "item": [ { "name": "Goals and goal values registration (one goal)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"goal\": \"card\",\n \"pixel_id\": \"{{pixel_id}}\",\n \"value\": -25.5,\n \"matching\": \"profile_id\",\n \"profile_id\": \"{{profile_id}}\",\n \"referer\": \"api.example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/goals/register", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "goals", "register" ] } }, "response": [] }, { "name": "Goals and goal values registration (multiple goals)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"goals\": [\n {\n \"goal\": \"cart\",\n \"value\": 10.99\n },\n {\n \"goal\": \"two\",\n \"value\": -12.34\n }\n ],\n \"pixel_id\": \"{{pixel_id}}\",\n \"matching\": \"profile_id\",\n \"profile_id\": \"{{profile_id}}\",\n \"client_ip\": \"10.20.30.40\",\n \"referer\": \"api.example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/goals/register", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "goals", "register" ] } }, "response": [] }, { "name": "Goals and goal values registration (additional info)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"goals\": [\n {\n \"goal\": \"cart\",\n \"value\": 10.99\n },\n {\n \"goal\": \"two\",\n \"value\": -12.34\n }\n ],\n \"pixel_id\": \"{{pixel_id}}\",\n \"matching\": \"profile_id\",\n \"profile_id\": \"{{profile_id}}\",\n \"client_ip\": \"192.168.0.0\",\n \"referer\": \"api.example.com\",\n \"accept_language\": \"fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5\",\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36\",\n \"pixel_data\": {\n \"hello\": \"hi\",\n \"arr\": [\n 1,\n 2,\n 3\n ],\n \"int_val\": 56893,\n \"bool_val\": true,\n \"date_val\": \"2023-08-12\"\n },\n \"skip_triggers\": false,\n \"enrich_profile\": true,\n \"is_test\": true,\n \"vendor\": \"altcraft\",\n \"external_type\": \"event_pixel_test\",\n \"external_event_id\": \"qwerty123\",\n \"altcraft_client_id\": \"9f11d32d-2935-43d0-b8df-f4c3568095b2\",\n \"browser\": \"Chrome\",\n \"os\": \"Ubuntu\",\n \"device\": \"Desktop\",\n \"utm_content\": \"utm_content\",\n \"utm_medium\": \"utm_medium\",\n \"utm_source\": \"utm_source\",\n \"utm_campaign\": \"utm_campaign\",\n \"utm_term\": \"utm_term\",\n \"client_ip_v4\": \"198.16.74.224\",\n \"client_ip_v6\": \"fe80::5215:5556:d75f:806b\",\n \"net_ssid\": \"10.200.0.0\",\n \"net_mac_addr\": \"28:87:ba:c1:0d:5e\",\n \"net_gateway_ipv4\": \"10.200.0.1\",\n \"net_gateway_ipv6\": \"::ff\",\n \"loyalty_id\": \"{{loyalty_id}}\",\n \"promo_id\": \"66e0764a1c00d4f40fab6583\",\n \"endpoint_eid\": \"{{market_endpoint}}\",\n \"order_eid\": \"{{order_id}}\",\n \"product_eid\": \"{{product_id}}\",\n \"sku_eid\": \"{{sku_id}}\",\n \"region_eid\": \"{{market_region}}\",\n \"count_items\": 1,\n \"categories\": [\n \"{{market_category}}\"\n ],\n \"lat\": 55.244075,\n \"lon\": 19.379932,\n \"country\": \"RU\",\n \"region\": \"Ryazan\",\n \"city\": \"Ryazan\",\n \"address\": \"Pochtovaya street\",\n \"zip\": \"390000\",\n \"time_zone\": \"Europe/Moscow\",\n \"send_message_id\": \"{{smid}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/goals/register", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "goals", "register" ] } }, "response": [] } ], "description": "Register conversion goals and goal values for profiles. Supports single goal registration, multiple goals in one call, and attaching additional metadata." }, { "name": "Application's push", "item": [ { "name": "Add app push events", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"events\": 1,\n \"launch_id\": \"{{launch_id}}\",\n \"provider\": \"android-firebase\",\n \"subscription_id\": \"{{subscription_id}}\",\n \"uid\": \"uid123\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/pushes/post_events", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "pushes", "post_events" ] } }, "response": [] }, { "name": "Crypto post events", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"events\": [\n {\n \"event_id\": \"event_1\",\n \"profile_id\": \"{{profile_id}}\",\n \"data\": {\n \"key\": \"value\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/pushes/crypto_post_events", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "pushes", "crypto_post_events" ] } }, "response": [] } ], "description": "Send mobile push notification events to the platform, including standard and encrypted push event payloads." }, { "name": "Market", "item": [ { "name": "Orders", "item": [ { "name": "Import order and item statuses (product)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"external_id\": \"{{order_external_id}}\",\n \"matching\": \"email\",\n \"email\": \"john@example.com\",\n \"endpoint\": \"{{market_endpoint}}\",\n \"status\": \"delivered\",\n \"total_price\": \"1000\",\n \"currency\": \"{{market_currency}}\",\n \"lines\": [\n {\n \"external_id\": \"{{line_id}}\",\n \"product\": \"{{product_id}}\",\n \"base_price_per_item\": \"900\",\n \"min_price_per_item\": \"900\",\n \"final_price_per_item\": \"900\",\n \"count\": 1\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/market/orders/import", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "market", "orders", "import" ] } }, "response": [] }, { "name": "Import order and item statuses (SKU)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"external_id\": \"{{order_external_id}}\",\n \"matching\": \"email\",\n \"email\": \"john@example.com\",\n \"endpoint\": \"{{market_endpoint}}\",\n \"status\": \"delivered\",\n \"total_price\": \"1000\",\n \"currency\": \"{{market_currency}}\",\n \"lines\": [\n {\n \"external_id\": \"{{line_id}}\",\n \"sku\": \"{{sku_id}}\",\n \"base_price_per_item\": \"900\",\n \"min_price_per_item\": \"900\",\n \"final_price_per_item\": \"900\",\n \"count\": 1\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/market/orders/import", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "market", "orders", "import" ] } }, "response": [] }, { "name": "Delete order (internal ID)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{order_internal_id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/market/orders/delete", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "market", "orders", "delete" ] } }, "response": [] }, { "name": "Delete order (external ID)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"external_id\": \"{{order_external_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/market/orders/delete", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "market", "orders", "delete" ] } }, "response": [] }, { "name": "Update order line status", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"order_external_id\": \"{{order_external_id}}\",\n \"order_line_external_id\": \"{{line_id}}\",\n \"status_external_id\": \"delivered\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/market/orders/update_order_line_status", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "market", "orders", "update_order_line_status" ] } }, "response": [] }, { "name": "Get order status (external ID)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"external_id\": \"{{order_external_id}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/market/orders/get_status", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "market", "orders", "get_status" ] } }, "response": [] }, { "name": "Get order status (internal ID)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"id\": \"{{order_internal_id}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/market/orders/get_status", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "market", "orders", "get_status" ] } }, "response": [] }, { "name": "Get orders list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"limit\": 2\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/market/orders/list", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "market", "orders", "list" ] } }, "response": [] }, { "name": "Preorder calculation", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"external_id\": \"12\",\n \"matching\": \"email\",\n \"email\": \"example@example.com\",\n \"data\": {\n \"endpoint\": \"site\",\n \"status\": \"new\",\n \"delivery_cost\": \"0.00\",\n \"total_price\": \"139999.00\",\n \"currency\": \"RUB\",\n \"redeem_points\": [\n {\n \"points_currency_iid\": 1,\n \"amount\": 499\n }\n ],\n \"lines\": [\n {\n \"external_id\": \"line___ASTGRf\",\n \"product\": \"iphone17pmb256\",\n \"base_price_per_item\": \"139999.00\",\n \"min_price_per_item\": \"0.00\",\n \"final_price_per_item\": \"139999.00\",\n \"count\": 1,\n \"custom_fields\": {},\n \"currency\": \"RUB\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/market/orders/preorder", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "market", "orders", "preorder" ] } }, "response": [] }, { "name": "Preorder commit", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"external_id\": \"order_12345\",\n \"profile_id\": \"696e304f547840a7286619e0\",\n \"skip_triggers\": false,\n \"data\": {\n \"endpoint\": \"bot\",\n \"status\": \"confirmed\",\n \"currency\": \"RUB\",\n \"total_price\": \"2500.00\",\n \"final_total_price\": \"2150.00\",\n \"delivery_cost\": \"300.00\",\n \"create_time\": \"2026-02-18T13:01:05.141Z\",\n \"region\": \"region_moscow\",\n \"lines\": [\n {\n \"external_id\": \"line_1\",\n \"product\": \"popit\",\n \"base_price_per_item\": \"1500.00\",\n \"final_price_per_item\": \"1350.00\",\n \"count\": 1,\n \"requested_promotions\": [\n {\n \"type\": \"discount\",\n \"promotion\": {\n \"external_id\": \"promo_1\",\n \"name\": \"Summer Sale\"\n },\n \"amount\": \"150.00\"\n }\n ]\n }\n ],\n \"promocodes\": [\n {\n \"code\": \"HYDO-4728-DZGU\",\n \"pool_id\": 42\n }\n ],\n \"redeem_points\": [\n {\n \"points_currency_eid\": \"bonus1\",\n \"amount\": 100\n }\n ],\n \"requested_promotions\": [\n {\n \"type\": \"code_issue\",\n \"promotion\": {\n \"external_id\": \"welcome_promo\",\n \"name\": \"Welcome Gift\"\n }\n }\n ],\n \"custom_fields\": {\n \"source\": \"telegram_bot\",\n \"campaign\": \"spring_sale\"\n },\n \"tags\": [\n \"premium\",\n \"first_order\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/market/orders/preorder_commit", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "market", "orders", "preorder_commit" ] } }, "response": [] } ], "description": "Manage customer orders. Import order and item statuses, retrieve order lists and statuses, delete orders, update order line statuses, and handle preorder calculations and commits." }, { "name": "Products and SKU", "item": [ { "name": "Import products, SKUs and categories", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"name\": \"Apple iPhone 13\",\n \"external_id\": \"{{product_id}}\",\n \"price\": \"900\",\n \"pictures\": [\n \"https://example.com\",\n \"https://example.com\"\n ],\n \"currency\": \"{{market_currency}}\",\n \"count\": 20,\n \"is_available\": true,\n \"delivery\": true,\n \"sku\": [\n {\n \"name\": \"Apple iPhone 13 256GB\",\n \"external_id\": \"{{sku_id}}\",\n \"price\": \"1000\",\n \"count\": 10,\n \"is_available\": true,\n \"delivery\": true,\n \"currency\": \"{{market_currency}}\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/market/products/import", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "market", "products", "import" ] } }, "response": [] }, { "name": "Import SKUs and categories", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"categories\": [\n {\n \"external_id\": \"34rf13\",\n \"name\": \"Electronics\"\n }\n ],\n \"data\": [\n {\n \"name\": \"Apple iPhone 13 256GB\",\n \"external_id\": \"{{sku_id}}\",\n \"price\": \"1000\",\n \"product_external_id\": \"{{product_id}}\",\n \"pictures\": [\n \"https://example.com\",\n \"https://example.com\"\n ],\n \"count\": 10,\n \"is_available\": true,\n \"delivery\": true,\n \"currency\": \"{{market_currency}}\",\n \"categories\": [\n \"34rf13\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/market/sku/import", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "market", "sku", "import" ] } }, "response": [] }, { "name": "Get products list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"limit\": 2\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/market/products/list", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "market", "products", "list" ] } }, "response": [] }, { "name": "Get SKUs list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"limit\": 2\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/market/sku/list", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "market", "sku", "list" ] } }, "response": [] }, { "name": "Delete products", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n 1\n ],\n \"external_ids\": [\n \"product_123\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/market/products/delete", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "market", "products", "delete" ] } }, "response": [] }, { "name": "Delete SKUs", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n 1\n ],\n \"external_ids\": [\n \"sku_123\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/market/sku/delete", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "market", "sku", "delete" ] } }, "response": [] } ], "description": "Manage the product catalog. Import, list, and delete products and their associated SKUs and categories." } ], "description": "Top-level container for e-commerce endpoints. Includes sub-folders for managing products/SKUs and orders." }, { "name": "Analytic reports", "item": [ { "name": "Get summary report", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"data_group\": \"vendor\",\n \"data_id\": \"{{db_id}}\",\n \"data_type\": \"list\",\n \"date_from\": \"2024-04-04\",\n \"date_to\": \"2024-05-05\",\n \"format\": \"json\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/reports/summary", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "reports", "summary" ] } }, "response": [] }, { "name": "Get soft bounces report", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"campaign_id\": \"{{campaign_id}}\",\n \"date_from\": \"2024-04-26\",\n \"date_to\": \"2024-05-01\",\n \"format\": \"json\",\n \"top\": 2\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/reports/bounces", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "reports", "bounces" ] } }, "response": [] }, { "name": "Get undeliveries report", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"campaign_id\": \"{{campaign_id}}\",\n \"date_from\": \"2024-04-26\",\n \"date_to\": \"2024-05-01\",\n \"format\": \"json\",\n \"top\": 2\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/reports/undelivered", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "reports", "undelivered" ] } }, "response": [] } ], "description": "Retrieve message performance reports including summary statistics, soft bounce data, and undelivered message reports." }, { "name": "Senders", "item": [ { "name": "Virtual senders", "item": [], "description": "Manage virtual senders — logical sender identities that can be mapped to real sending infrastructure." }, { "name": "Get senders list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"limit\": 2\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/senders/list", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "senders", "list" ] } }, "response": [] } ], "description": "Retrieve the list of configured senders used for outgoing communications across different channels." }, { "name": "Miscellaneous", "item": [ { "name": "Upload file", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"data\": \"data:text/csv;base64,SEVMTE8K\",\n \"header\": \"US.csv\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/file_upload", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "file_upload" ] } }, "response": [] }, { "name": "Get message web version", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"send_message_id\": \"{{smid}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/webver/get", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "webver", "get" ] } }, "response": [] }, { "name": "Check task status", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"task_id\": \"task_b2f9fk6a-2479-4a63-b592-f15d4e3b69c5\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/tasks/status", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "tasks", "status" ] } }, "response": [] }, { "name": "Get dictionary values", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"devices\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/dictionary", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "dictionary" ] } }, "response": [] } ], "description": "Utility endpoints for general platform operations: file uploads, retrieving web versions of messages, checking async task statuses, and fetching dictionary values." }, { "name": "Matching types", "item": [ { "name": "Matching by email", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"matching\": \"email\", \n \"email\": \"example@example.com\",\n \"data\": {\n \"email\": \"example@example.com\",\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email\": \"example@example.com\", \n \"resource_id\": \"{{resource_id}}\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/profiles/import", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "profiles", "import" ] } }, "response": [] }, { "name": "Matching by phone", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"matching\": \"phone\", \n \"phone\": \"+79000000123\",\n \"data\": {\n \"phones\": [\n \"+79000000123\"\n ],\n \"subscriptions\": [\n {\n \"channel\": \"sms\",\n \"phone\": \"+79000000000\",\n \"resource_id\": \"{{resource_id}}\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/profiles/import", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "profiles", "import" ] } }, "response": [] }, { "name": "Matching by custom field", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"matching\": \"custom\",\n \"field_name\": \"{{db_custom_field}}\",\n \"field_value\": 100,\n \"data\": {\n \"email\": \"example@example.com\",\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email\": \"example@example.com\",\n \"resource_id\": \"{{resource_id}}\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/profiles/import", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "profiles", "import" ] } }, "response": [] }, { "name": "Matching by profile_id (only update!)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n\"db_id\": \"{{db_id}}\",\n \"matching\": \"profile_id\",\n \"profile_id\": \"{{profile_id}}\",\n \"data\": {\n \"email\": \"example@example.com\",\n \"subscriptions\": [\n {\n \"channel\": \"email\",\n \"email\": \"example@example.com\",\n \"resource_id\": \"{{resource_id}}\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/profiles/import", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "profiles", "import" ] } }, "response": [] } ], "description": "Examples of profile import requests using different matching strategies: by email, phone, profile ID, or a custom field." }, { "name": "External datatables", "item": [ { "name": "Template queries", "item": [ { "name": "Add template query", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Main Query\",\n \"shortname\": \"query1\",\n \"sql\": \"SELECT * FROM table\",\n \"connector_id\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/datatables/query_templates/add/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "datatables", "query_templates", "add", "" ] } }, "response": [] }, { "name": "Delete template query", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/datatables/query_templates/delete/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "datatables", "query_templates", "delete", "" ] } }, "response": [] }, { "name": "Update template query", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"name\": \"Main Query\",\n \"shortname\": \"query1\",\n \"sql\": \"SELECT * FROM table\",\n \"connector_id\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/datatables/query_templates/update/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "datatables", "query_templates", "update", "" ] } }, "response": [] }, { "name": "Get template query info", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/datatables/query_templates/get/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "datatables", "query_templates", "get", "" ] } }, "response": [] }, { "name": "Get template queries list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/datatables/query_templates/list/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "datatables", "query_templates", "list", "" ] } }, "response": [] } ], "description": "Create, update, delete, and retrieve queries used to pull external datatable data into message templates for personalization." }, { "name": "Segmentation queries", "item": [ { "name": "Add segmentation query", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Main Query\",\n \"shortname\": \"query1\",\n \"sql\": \"SELECT * FROM table\",\n \"connector_id\": 1,\n \"column\": \"price\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/datatables/query_segments/add/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "datatables", "query_segments", "add", "" ] } }, "response": [] }, { "name": "Delete segmentation query", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/datatables/query_segments/delete/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "datatables", "query_segments", "delete", "" ] } }, "response": [] }, { "name": "Update segmentation query", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"name\": \"Main Query\",\n \"shortname\": \"query1\",\n \"sql\": \"SELECT * FROM table\",\n \"connector_id\": 1,\n \"column\": \"price\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/datatables/query_segments/update/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "datatables", "query_segments", "update", "" ] } }, "response": [] }, { "name": "Get segmentation query info", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/datatables/query_segments/get/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "datatables", "query_segments", "get", "" ] } }, "response": [] }, { "name": "Get segmentation queries list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/datatables/query_segments/list/", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "datatables", "query_segments", "list", "" ] } }, "response": [] } ], "description": "Create, update, delete, and retrieve queries used to build dynamic audience segments from external datatable data." } ], "description": "Top-level container for external datatable query endpoints. Includes sub-folders for segmentation queries and template queries." }, { "name": "Loyalty", "item": [ { "name": "Get loyalty account balance", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"loyalty_program_id\": 123,\n \"points_currency_eid\": \"starts\",\n \"matching\": \"email\",\n \"email\": \"user@example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/loyalty/account/balance", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "loyalty", "account", "balance" ] } }, "response": [] }, { "name": "Get loyalty account transactions", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"loyalty_program_id\": 123,\n \"points_currency_eid\": \"bonus_points\",\n \"matching\": \"email\",\n \"email\": \"user@example.com\",\n \"limit\": 20\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/loyalty/account/transactions", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "loyalty", "account", "transactions" ] } }, "response": [] }, { "name": "Get expiring points", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"loyalty_program_id\": 123,\n \"points_currency_eid\": \"bonus_points\",\n \"matching\": \"email\",\n \"email\": \"user@example.com\",\n \"date_from\": \"2023-09-01T00:00:00Z\",\n \"date_to\": \"2023-09-30T23:59:59Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/loyalty/account/expiring_points", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "loyalty", "account", "expiring_points" ] } }, "response": [] }, { "name": "Get loyalty tiers", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"loyalty_program_id\": 123,\n \"tiers_group_id\": 10,\n \"matching\": \"email\",\n \"email\": \"user@example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/loyalty/account/tiers", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "loyalty", "account", "tiers" ] } }, "response": [] }, { "name": "Accrue points", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"loyalty_program_id\": 123,\n \"promotion_id\": \"PROMO123\",\n \"points_currency_eid\": \"stars\",\n \"amount\": \"100\",\n \"matching\": \"email\",\n \"email\": \"user@example.com\",\n \"is_temp\": false,\n \"transaction_eid\": \"uiuiuiiu-ouiihfs-sdfsdf\",\n \"external_data\": {\n \"order_id\": \"ORDER-123\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/loyalty/accrue_points", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "loyalty", "accrue_points" ] } }, "response": [] }, { "name": "Redeem points", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"loyalty_program_id\": 123,\n \"promotion_id\": \"PROMO123\",\n \"points_currency_eid\": \"stars\",\n \"amount\": \"100\",\n \"matching\": \"email\",\n \"email\": \"user@example.com\",\n \"is_temp\": false,\n \"transaction_eid\": \"uiuiuiiu-ouiihfs-sdfsdf\",\n \"external_data\": {\n \"order_id\": \"ORDER-123\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/loyalty/redeeme_points", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "loyalty", "redeeme_points" ] } }, "response": [] }, { "name": "Cancel transaction", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"transaction_id\": \"TRANS12345\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/loyalty/cancel_transaction", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "loyalty", "cancel_transaction" ] } }, "response": [] }, { "name": "Commit transaction", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"transaction_id\": \"TRANS12345\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/loyalty/commit_transaction", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "loyalty", "commit_transaction" ] } }, "response": [] }, { "name": "Delete loyalty member", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"loyalty_program_id\": 123,\n \"matching\": \"email\",\n \"email\": \"user@example.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/loyalty/delete_member", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "loyalty", "delete_member" ] } }, "response": [] }, { "name": "Register loyalty member", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"loyalty_program_id\": 123,\n \"matching\": \"email\",\n \"email\": \"user@example.com\",\n \"registration_date\": \"2024-09-01T12:34:56Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/loyalty/register_member", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "loyalty", "register_member" ] } }, "response": [] }, { "name": "Register loyalty members (batch)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"loyalty_program_id\": 123,\n \"matching\": \"email\",\n \"data\": [\n {\n \"email\": \"user1@example.com\",\n \"registration_date\": \"2024-09-01T12:34:56Z\"\n },\n {\n \"email\": \"user2@example.com\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/loyalty/register_member_batch", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "loyalty", "register_member_batch" ] } }, "response": [] }, { "name": "Register loyalty members (batch task)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"loyalty_program_id\": 123,\n \"matching\": \"email\",\n \"data\": [\n {\n \"email\": \"user1@example.com\",\n \"registration_date\": \"2024-09-01T12:34:56Z\"\n },\n {\n \"email\": \"user2@example.com\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/loyalty/register_member_batch_task", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "loyalty", "register_member_batch_task" ] } }, "response": [] }, { "name": "Rollback transaction", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"transaction_id\": \"TRANS12345\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/loyalty/rollback_transaction", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "loyalty", "rollback_transaction" ] } }, "response": [] }, { "name": "Export transactions", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"loyalty_program_id\": 123,\n \"points_currency_eid\": \"bonus_points\",\n \"date_from\": \"2023-09-01T00:00:00Z\",\n \"date_to\": \"2023-09-30T23:59:59Z\",\n \"from_id\": \"a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/loyalty/transactions_export", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "loyalty", "transactions_export" ] } }, "response": [] }, { "name": "Get trigger promotions", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"loyalty_program_id\": 123,\n \"limit\": 20,\n \"is_active\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/loyalty/trigger_promotions", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "loyalty", "trigger_promotions" ] } }, "response": [] } ], "description": "Manage loyalty program operations. Register members, accrue and redeem points, manage transactions (commit, cancel, rollback), retrieve account balances, expiring points, tiers, and trigger promotions." }, { "name": "Campaigns", "item": [ { "name": "Activate campaign", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"activate_date\": \"2025-04-01T18:45:00Z\",\n \"deactivate_date\": \"2025-05-01T18:45:00Z\",\n \"completed_date\": \"2025-05-01T18:45:00Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/scampaigns/activate", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "scampaigns", "activate" ] } }, "response": [] }, { "name": "Complete campaign", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 18\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/scampaigns/completed", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "scampaigns", "completed" ] } }, "response": [] }, { "name": "Deactivate campaign", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 18\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/scampaigns/deactivate", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "scampaigns", "deactivate" ] } }, "response": [] }, { "name": "Get campaign info", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 22,\n \"marketing_activities\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/scampaigns/get", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "scampaigns", "get" ] } }, "response": [] }, { "name": "Get campaign status", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 10\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/scampaigns/get_status", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "scampaigns", "get_status" ] } }, "response": [] }, { "name": "Get campaigns list", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}", "description": "API token" } ], "body": { "mode": "raw", "raw": "{\n \"limit\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/api/v1.1/scampaigns/list", "host": [ "{{url}}" ], "path": [ "api", "v1.1", "scampaigns", "list" ] } }, "response": [] } ], "description": "Manage campaigns — high-level message containers. List campaigns, retrieve details and status, and activate, deactivate, or complete them." } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "requests": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "requests": {}, "exec": [ "" ] } } ], "variable": [ { "key": "url", "value": "https://ru.altkraft.com" }, { "key": "token", "value": "abcdefghijklmnqrstuvwxyz" }, { "key": "resource_id", "value": "1" }, { "key": "db_id", "value": "1" }, { "key": "db_custom_field", "value": "100" }, { "key": "stsegment_id", "value": "1" }, { "key": "dynsegment_id", "value": "1" }, { "key": "segment_id", "value": "1" }, { "key": "suplist_id", "value": "1" }, { "key": "template_id", "value": "1" }, { "key": "campaign_id", "value": "1" }, { "key": "workflow_id", "value": "1" }, { "key": "pixel_id", "value": "1" }, { "key": "loyalty_id", "value": "1" }, { "key": "vsender_id", "value": "1" }, { "key": "profile_id", "value": "abcdefghijklmnqrstuvwxyz" }, { "key": "smid", "value": "abcdefghijklmnqrstuvwxyz" }, { "key": "subscription_id", "value": "abcdefghijklmnqrstuvwxyz" }, { "key": "rtoken", "value": "resource_token" }, { "key": "launch_id", "value": "launch_id" }, { "key": "product_id", "value": "product_external_id" }, { "key": "sku_id", "value": "sku_external_id" }, { "key": "order_external_id", "value": "order_external_id" }, { "key": "order_internal_id", "value": "1" }, { "key": "line_id", "value": "line_1" }, { "key": "market_endpoint", "value": "sales_channel_endpoint" }, { "key": "market_region", "value": "region_1" }, { "key": "market_category", "value": "category_1" }, { "key": "market_currency", "value": "RUB" }, { "key": "order_id", "value": "order_id" } ] }