{ "item": [ { "id": "b38710d1-c190-4fb7-a74b-abc871e215e2", "name": "Подписчики", "description": { "content": "Управление подписчиками (добавление, обновление, отписка, валидация)", "type": "text/plain" }, "item": [ { "id": "29fc9f7d-ab33-491b-9503-6030f57973c6", "name": "Добавление нового подписчика", "request": { "name": "Добавление подписчика (одного или массово)", "description": { "content": "Добавляет нового подписчика в указанный список (или списки).\n\n**Эндпоинт:** `POST https://mailganer.com/api/v2/emails/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n**Content-Type:** `application/json`\n\n### Обязательные поля\n| Поле | Тип | Описание |\n|---|---|---|\n| `email` | string | Имейл подписчика |\n| `source` | int / array / `\"all\"` | ID списка. `\"all\"` — во все списки; можно передать массив ID |\n\n### Необязательные поля\n| Поле | Тип | Описание |\n|---|---|---|\n| `phone` | string | Телефон |\n| `name`, `surname`, `patronymic` | string | ФИО |\n| `gender` | int | 1 — мужской, 2 — женский |\n| `birthday` | string | Дата рождения, формат `dd.mm.yyyy` |\n| `city` | string | Город |\n| `add_tag` / `delete_tag` | string / array | Добавить / удалить метку (≤ 140 символов) |\n| `add_category` / `delete_category` | string | Добавить / удалить категорию (≤ 250 символов) |\n| `user_vars` | object | Пользовательские переменные (`null` в значении — удалить его) |\n| `not_doi` / `need_activate` | bool | Управление DOI (требует активации поддержкой) |\n\n### Пример curl\n```bash\ncurl --location --request POST 'https://mailganer.com/api/v2/emails/' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"email\": \"test@example.com\",\n \"source\": 49767\n}'\n```\n\n### Примечания\n- Лимит: **500 запросов/мин**, иначе `429`.\n- Ошибка `400` «We have already sent a subscription confirmation email…» — повторное DOI-письмо доступно через 1 час.\n- Рекомендуется **v3** ([`/api/v3/emails/`](#operation/createSubscribersV3)) — детальный ответ с массивами `successful` / `failed`.\n\n\n### Массовое добавление\n\nДо 50 подписчиков за один запрос: тело — JSON-массив тех же объектов.\nНа странице «Попробовать» пример выбирается в списке примеров тела.\n\n#### Тело запроса\n\nМассив объектов; поля каждого объекта:\n\n| Поле | Тип | Обяз. | Описание |\n| --- | --- | --- | --- |\n| `email` | string | да | Имейл подписчика |\n| `source` | int / array / `\"all\"` | да | ID списка; можно передать несколько или `\"all\"` — во все списки |\n| `phone` | string | нет | Телефон |\n| `name` | string | нет | Имя |\n| `surname` | string | нет | Фамилия |\n| `patronymic` | string | нет | Отчество |\n| `gender` | int | нет | 1 — мужской, 2 — женский |\n| `birthday` | string | нет | Дата рождения, формат `dd.mm.yyyy` |\n| `city` | string | нет | Город |\n| `add_tag` | string / array | нет | Добавить метку (≤ 140 символов) |\n| `delete_tag` | string | нет | Удалить метку |\n| `user_vars` | object | нет | Пользовательские переменные |\n| `not_doi` | bool | нет | Отменить отправку письма подтверждения |\n| `need_activate` | bool | нет | Отправить письмо подтверждения |\n| `add_category` | string | нет | Добавить категорию подписки (≤ 250 символов) |\n| `delete_category` | string | нет | Удалить категорию подписки |\n\n#### Пример curl\n\n```bash\ncurl --location --request POST 'https://mailganer.com/api/v2/emails/' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '[\n {\"email\": \"test1@example.com\", \"source\": 51488, \"name\": \"Федор\"},\n {\"email\": \"test2@example.com\", \"source\": 51488, \"name\": \"Пётр\"}\n]'\n```\n\n#### Примечания\n\n- Максимум **50** имейлов за запрос.\n- Атомарность: если хотя бы в одном имейле есть ошибка, **ни один** имейл из пакета не будет добавлен.\n- В ответе по каждому имейлу возвращаются `id`, `mg_hash`, `in_base` (был ли уже в базе) и `email_status`.\n- Повторная отправка DOI-письма возможна через 1 час.\n- При `HTTP 503` необходимо повторить запрос с задержкой.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "emails", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"email\": \"test@example.com\",\n \"source\": 49767,\n \"phone\": \"+79123456789\",\n \"name\": \"Федор\",\n \"patronymic\": \"Федорович\",\n \"surname\": \"Федоров\",\n \"gender\": 1,\n \"birthday\": \"01.01.1988\",\n \"add_tag\": \"метка1\",\n \"user_vars\": {\n \"text\": \"Текст\",\n \"integer\": 12,\n \"date\": \"01.01.2024\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "17bf2371-a14d-49a8-b01a-ea404e23daad", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v2", "emails", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"test@example.com\",\n \"source\": 49767,\n \"phone\": \"+79123456789\",\n \"name\": \"Федор\",\n \"patronymic\": \"Федорович\",\n \"surname\": \"Федоров\",\n \"gender\": 1,\n \"birthday\": \"01.01.1988\",\n \"add_tag\": \"метка1\",\n \"user_vars\": {\n \"text\": \"Текст\",\n \"integer\": 12,\n \"date\": \"01.01.2024\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "key": "Server", "value": "nginx/1.16.1", "description": "" }, { "disabled": false, "key": "Date", "value": "Fri, 09 Dec 2022 09:45:22 GMT", "description": "" }, { "disabled": false, "key": "Transfer-Encoding", "value": "chunked", "description": "" }, { "disabled": false, "key": "Connection", "value": "close", "description": "" }, { "disabled": false, "key": "Vary", "value": "Accept, Accept-Language, Cookie, Origin", "description": "" }, { "disabled": false, "key": "X-Frame-Options", "value": "SAMEORIGIN", "description": "" }, { "disabled": false, "key": "Content-Language", "value": "ru", "description": "" }, { "disabled": false, "key": "Allow", "value": "GET, POST, HEAD, OPTIONS", "description": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 143788300,\n \"mg_hash\": \"0aa106143788300b392b80ecf023c57d75cc70272\",\n \"email\": \"test@example.com\",\n \"source\": 60958,\n \"email_status\": \"fixed\",\n \"corrected_email\": null,\n \"name\": \"Федор\",\n \"patronymic\": \"Федорович\",\n \"surname\": \"Федоров\",\n \"gender\": 1,\n \"birthday\": \"01.01.1988\",\n \"phone\": \"+79123456789\",\n \"city\": null,\n \"country\": null,\n \"is_valid\": false,\n \"doi_is_delivery\": false,\n \"doi_is_open\": false,\n \"doi_is_click\": false,\n \"user_vars\": null,\n \"bunce_log\": \"Global stop list email hash: 554d1a357108862d8de2356531c004a3baf9403\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9597e41b-9d82-4ae2-9bde-304e163b0c97", "name": "Error", "originalRequest": { "url": { "path": [ "api", "v2", "emails", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"test@example.com\",\n \"source\": 49767,\n \"phone\": \"+79123456789\",\n \"name\": \"Федор\",\n \"patronymic\": \"Федорович\",\n \"surname\": \"Федоров\",\n \"gender\": 1,\n \"birthday\": \"01.01.1988\",\n \"add_tag\": \"метка1\",\n \"user_vars\": {\n \"text\": \"Текст\",\n \"integer\": 12,\n \"date\": \"01.01.2024\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "disabled": false, "key": "Server", "value": "nginx/1.16.1", "description": "" }, { "disabled": false, "key": "Date", "value": "Fri, 09 Dec 2022 09:41:26 GMT", "description": "" }, { "disabled": false, "key": "Transfer-Encoding", "value": "chunked", "description": "" }, { "disabled": false, "key": "Connection", "value": "close", "description": "" }, { "disabled": false, "key": "Content-Language", "value": "ru", "description": "" }, { "disabled": false, "key": "Vary", "value": "Accept, Accept-Language, Cookie, Origin", "description": "" }, { "disabled": false, "key": "Allow", "value": "GET, POST, HEAD, OPTIONS", "description": "" }, { "disabled": false, "key": "X-Frame-Options", "value": "SAMEORIGIN", "description": "" }, { "disabled": false, "key": "WWW-Authenticate", "value": "CodeRequest", "description": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"invalid\",\n \"error\": {\n \"source\": [\n \"Not found site (source_id=497671) or site blocked\"\n ],\n \"birthday\": [\n \"Неправильный формат date. Используйте формат: DD.MM.YYYY\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7c69a57-e988-4933-90d6-e2f8277986cc", "name": "Error - Недопустимый токен", "originalRequest": { "url": { "path": [ "api", "v2", "emails", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"test@example.com\",\n \"source\": 49767,\n \"phone\": \"+79123456789\",\n \"name\": \"Федор\",\n \"patronymic\": \"Федорович\",\n \"surname\": \"Федоров\",\n \"gender\": 1,\n \"birthday\": \"01.01.1988\",\n \"add_tag\": \"метка1\",\n \"user_vars\": {\n \"text\": \"Текст\",\n \"integer\": 12,\n \"date\": \"01.01.2024\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "key": "Server", "value": "nginx/1.16.1", "description": "" }, { "disabled": false, "key": "Date", "value": "Fri, 09 Dec 2022 09:41:26 GMT", "description": "" }, { "disabled": false, "key": "Transfer-Encoding", "value": "chunked", "description": "" }, { "disabled": false, "key": "Connection", "value": "close", "description": "" }, { "disabled": false, "key": "Content-Language", "value": "ru", "description": "" }, { "disabled": false, "key": "Vary", "value": "Accept, Accept-Language, Cookie, Origin", "description": "" }, { "disabled": false, "key": "Allow", "value": "GET, POST, HEAD, OPTIONS", "description": "" }, { "disabled": false, "key": "X-Frame-Options", "value": "SAMEORIGIN", "description": "" }, { "disabled": false, "key": "WWW-Authenticate", "value": "CodeRequest", "description": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"error\": \"Недопустимый токен.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Массовое добавление подписчиков", "request": { "name": "Добавление подписчика (одного или массово)", "description": { "content": "Добавляет до 50 подписчиков за один запрос. Тело — JSON-массив объектов подписчиков.\n\n### Массовое добавление\n\nДо 50 подписчиков за один запрос: тело — JSON-массив тех же объектов.\nНа странице «Попробовать» пример выбирается в списке примеров тела.\n\n#### Тело запроса\n\nМассив объектов; поля каждого объекта:\n\n| Поле | Тип | Обяз. | Описание |\n| --- | --- | --- | --- |\n| `email` | string | да | Имейл подписчика |\n| `source` | int / array / `\"all\"` | да | ID списка; можно передать несколько или `\"all\"` — во все списки |\n| `phone` | string | нет | Телефон |\n| `name` | string | нет | Имя |\n| `surname` | string | нет | Фамилия |\n| `patronymic` | string | нет | Отчество |\n| `gender` | int | нет | 1 — мужской, 2 — женский |\n| `birthday` | string | нет | Дата рождения, формат `dd.mm.yyyy` |\n| `city` | string | нет | Город |\n| `add_tag` | string / array | нет | Добавить метку (≤ 140 символов) |\n| `delete_tag` | string | нет | Удалить метку |\n| `user_vars` | object | нет | Пользовательские переменные |\n| `not_doi` | bool | нет | Отменить отправку письма подтверждения |\n| `need_activate` | bool | нет | Отправить письмо подтверждения |\n| `add_category` | string | нет | Добавить категорию подписки (≤ 250 символов) |\n| `delete_category` | string | нет | Удалить категорию подписки |\n\n#### Пример curl\n\n```bash\ncurl --location --request POST 'https://mailganer.com/api/v2/emails/' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '[\n {\"email\": \"test1@example.com\", \"source\": 51488, \"name\": \"Федор\"},\n {\"email\": \"test2@example.com\", \"source\": 51488, \"name\": \"Пётр\"}\n]'\n```\n\n#### Примечания\n\n- Максимум **50** имейлов за запрос.\n- Атомарность: если хотя бы в одном имейле есть ошибка, **ни один** имейл из пакета не будет добавлен.\n- В ответе по каждому имейлу возвращаются `id`, `mg_hash`, `in_base` (был ли уже в базе) и `email_status`.\n- Повторная отправка DOI-письма возможна через 1 час.\n- При `HTTP 503` необходимо повторить запрос с задержкой.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "emails", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "[\n {\n \"email\": \"test1@example.com\",\n \"source\": 51488,\n \"name\": \"Федор\",\n \"user_vars\": {\n \"lastbuy\": \"01.01.2024\"\n }\n },\n {\n \"email\": \"test2@example.com\",\n \"source\": 51488,\n \"name\": \"Пётр\",\n \"user_vars\": {\n \"lastbuy\": \"01.01.2024\"\n }\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d2a3e577-b730-4d60-8262-e8f0a9485643", "name": "Получение информации о подписчиках (по имейлу и фильтрам)", "request": { "name": "Получение информации о подписчиках (по имейлу и фильтрам)", "description": { "content": "Возвращает информацию о подписчике(ах) с фильтрацией по query-параметрам.\n\n**Эндпоинт:** `GET https://mailganer.com/api/v2/emails/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n\n### Query-параметры\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `email` | string | нет | Имейл, о котором нужна информация; оставьте пустым, чтобы получить по всем подписчикам |\n| `source` | int | нет | ID списка; оставьте пустым, чтобы получить по всем спискам |\n| `start_date` | string | нет | Фильтр по дате создания подписчика (формат `YYYY-MM-DD`) |\n| `end_date` | string | нет | Фильтр по дате создания подписчика (формат `YYYY-MM-DD`) |\n| `updated_at_start` | string | нет | Фильтр по дате изменения подписчика (формат `YYYY-MM-DD`) |\n| `updated_at_end` | string | нет | Фильтр по дате изменения подписчика (формат `YYYY-MM-DD`) |\n| `last_activity_days` | int | нет | Передайте `1`, чтобы дополнительно вернуть в ответе поле активности подписчика |\n\n### Пример curl\n```bash\ncurl --location --request GET 'https://mailganer.com/api/v2/emails/?email=test@example.com&source=51488' \\\n--header 'Authorization: CodeRequest {{api_key}}'\n```\n\n### Примечания\n- При фильтрации по имейлу `count` всегда равен `1`.\n- Если параметры дат не указаны — возвращаются все подписчики.\n- Активностью считается последнее открытие рассылки или триггерного письма.\n- Поле активности рассчитывается только если передан `last_activity_days=1`.\n- Ответ постраничный: поля `next` / `previous` / `count` / `results`.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "emails", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "email", "value": "test@example.com", "description": "Имейл, о котором нужна информация; оставьте пустым, чтобы получить по всем подписчикам" }, { "disabled": false, "key": "source", "value": "51488", "description": "ID списка; оставьте пустым, чтобы получить по всем спискам" }, { "disabled": false, "key": "start_date", "value": "2026-01-01", "description": "Фильтр по дате создания подписчика (формат YYYY-MM-DD)" }, { "disabled": false, "key": "end_date", "value": "2026-12-31", "description": "Фильтр по дате создания подписчика (формат YYYY-MM-DD)" }, { "disabled": false, "key": "updated_at_start", "value": "2026-01-01", "description": "Фильтр по дате изменения подписчика (формат YYYY-MM-DD)" }, { "disabled": false, "key": "updated_at_end", "value": "2026-12-31", "description": "Фильтр по дате изменения подписчика (формат YYYY-MM-DD)" }, { "disabled": false, "key": "last_activity_days", "value": "1", "description": "Передайте 1, чтобы дополнительно вернуть в ответе поле активности подписчика" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e3ee3fc3-b5e4-4869-b754-43ad37d4aef7", "name": "Email найден", "originalRequest": { "url": { "path": [ "api", "v2", "emails", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "email", "value": "test@example.com" }, { "key": "source", "value": "51488" }, { "key": "start_date", "value": "2026-01-01" }, { "key": "end_date", "value": "2026-12-31" }, { "key": "updated_at_start", "value": "2026-01-01" }, { "key": "updated_at_end", "value": "2026-12-31" }, { "key": "last_activity_days", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "key": "Server", "value": "nginx/1.16.1", "description": "" }, { "disabled": false, "key": "Date", "value": "Thu, 15 Dec 2022 07:33:33 GMT", "description": "" }, { "disabled": false, "key": "Transfer-Encoding", "value": "chunked", "description": "" }, { "disabled": false, "key": "Connection", "value": "close", "description": "" }, { "disabled": false, "key": "Vary", "value": "Accept, Accept-Language, Cookie, Origin", "description": "" }, { "disabled": false, "key": "X-Frame-Options", "value": "SAMEORIGIN", "description": "" }, { "disabled": false, "key": "Content-Language", "value": "ru", "description": "" }, { "disabled": false, "key": "Allow", "value": "GET, POST, HEAD, OPTIONS", "description": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 115986334,\n \"mg_hash\": \"ae2f6611598633414be10fe73380863cb59afe7b8\",\n \"email\": \"vlad.tochonii@mailganer.ru\",\n \"source\": 57229,\n \"email_status\": \"active\",\n \"corrected_email\": null,\n \"name\": \"\",\n \"patronymic\": \"\",\n \"surname\": \"\",\n \"gender\": 0,\n \"birthday\": null,\n \"phone\": null,\n \"city\": \"\",\n \"country\": \"\",\n \"is_valid\": true,\n \"doi_is_delivery\": true,\n \"doi_is_open\": false,\n \"doi_is_click\": false,\n \"user_vars\": {\n \"nps\": \"ok\",\n \"test_date\": 1667520000\n },\n \"bunce_log\": null\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61888442-2015-4234-a013-1d6f0ce489c0", "name": "Ошибка (400) — неверный source", "originalRequest": { "url": { "path": [ "api", "v2", "emails", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "email", "value": "test@example.com" }, { "key": "source", "value": "51488" }, { "key": "start_date", "value": "2026-01-01" }, { "key": "end_date", "value": "2026-12-31" }, { "key": "updated_at_start", "value": "2026-01-01" }, { "key": "updated_at_end", "value": "2026-12-31" }, { "key": "last_activity_days", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"invalid\",\n \"error\": {\n \"source\": [\n \"Not found site (source_id=497671) or site blocked\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1dbddab8-ba43-4b99-ac3f-243c25031ebb", "name": "Обновление информации о подписчике по mg_hash", "request": { "name": "Обновление информации о подписчике по mg_hash", "description": { "content": "Обновляет информацию о подписчике, идентифицируя его по хэшу имейла (`mg_hash`) в URL.\n\n**Эндпоинт:** `PATCH https://mailganer.com/api/v2/emails/:email_hash/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n**Content-Type:** `application/json`\n\nПодписчик определяется по `mg_hash` в пути (path-переменная `email_hash`), поэтому передавать `email` и `source` в теле не требуется — в теле указываются только обновляемые поля.\n\n### Тело запроса\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `phone` | string | нет | Телефон |\n| `name` | string | нет | Имя |\n| `surname` | string | нет | Фамилия |\n| `patronymic` | string | нет | Отчество |\n| `gender` | int | нет | 1 — мужской, 2 — женский |\n| `birthday` | string | нет | Дата рождения, формат `dd.mm.yyyy` |\n| `city` | string | нет | Город |\n| `add_tag` | string / array | нет | Добавить метку |\n| `delete_tag` | string | нет | Удалить метку |\n| `user_vars` | object | нет | Пользовательские переменные (передайте `null` в значении, чтобы удалить переменную) |\n| `not_doi` | bool | нет | Отменить отправку письма подтверждения |\n| `need_activate` | bool | нет | Отправить письмо подтверждения |\n| `add_category` | string | нет | Добавить категорию подписки |\n| `delete_category` | string | нет | Удалить категорию подписки |\n\n### Пример curl\n```bash\ncurl --location --request PATCH 'https://mailganer.com/api/v2/emails/a05ad557332370764cd4f267a251f3b13289bcff/' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"birthday\": \"02.01.1990\"\n}'\n```\n\n### Примечания\n- Переменные (`user_vars`) обновляются только если явно переданы в запросе.\n- Чтобы удалить значение пользовательской переменной, передайте `null` — работает для всех типов переменных.\n- Альтернативные способы обновления: эндпоинт `/api/v2/emails/update/` (передача `email` + `source` в теле) или массовое обновление `/api/v2/emails/mass/`.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "emails", ":email_hash", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a05ad557332370764cd4f267a251f3b13289bcff", "key": "email_hash", "description": "(Required) Хэш имейла" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"birthday\": \"02.01.1990\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "26c512b9-c25b-414a-a06c-7eb9fbf991d9", "name": "Успех (200)", "originalRequest": { "url": { "path": [ "api", "v2", "emails", ":email_hash", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a05ad557332370764cd4f267a251f3b13289bcff", "key": "email_hash", "description": "(Required) Хэш имейла" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"birthday\": \"02.01.1990\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 45763880,\n \"mg_hash\": \"53158545763880e054b31ecbad2cf3265d4001d1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c89e579-afac-4096-9e0e-744be9fe237b", "name": "Ошибка (400)", "originalRequest": { "url": { "path": [ "api", "v2", "emails", ":email_hash", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a05ad557332370764cd4f267a251f3b13289bcff", "key": "email_hash", "description": "(Required) Хэш имейла" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"birthday\": \"02.01.1990\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"invalid\",\n \"error\": {\n \"source\": [\n \"Not found site or blocked\"\n ],\n \"birthday\": [\n \"Неправильный формат date. Используйте: DD.MM.YYYY\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8bc8c460-1b60-4474-bb44-1785e5fff9a8", "name": "Получение информации о подписчике по mg_hash", "request": { "name": "Получение информации о подписчике по mg_hash", "description": { "content": "Возвращает информацию о конкретном подписчике по хэшу имейла (`mg_hash`) в URL.\n\n**Эндпоинт:** `GET https://mailganer.com/api/v2/emails/:email_hash/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n\nПодписчик определяется по path-переменной `email_hash` (значение `mg_hash`). Query-параметры не требуются.\n\n### Пример curl\n```bash\ncurl --location --request GET 'https://mailganer.com/api/v2/emails/ae2f6611598633414be10fe73380863cb59afe7b8/' \\\n--header 'Authorization: CodeRequest {{api_key}}'\n```\n\n### Примечания\n- Возвращается тот же формат объекта подписчика, что и в способе 1 (поля `id`, `mg_hash`, `email`, `source`, `email_status`, `user_vars`, `tags`, `categories`, `created`, `modified` и др.).\n- Если подписчик по хэшу не найден — вернётся ошибка «Не найдено.».\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "emails", ":email_hash", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a05ad557332370764cd4f267a251f3b13289bcff", "key": "email_hash", "description": "(Required) Хэш имейла" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0ab5e3f1-74ab-4e69-818d-5e08a3ce22e3", "name": "Успех (200)", "originalRequest": { "url": { "path": [ "api", "v2", "emails", ":email_hash", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a05ad557332370764cd4f267a251f3b13289bcff", "key": "email_hash", "description": "(Required) Хэш имейла" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 321456817,\n \"mg_hash\": \"54ede83211718173f544604ebe5ad1867543b348185\",\n \"email\": \"test@gmail.com\",\n \"source\": 104363,\n \"email_status\": \"active\",\n \"corrected_email\": null,\n \"name\": \"\",\n \"patronymic\": \"\",\n \"surname\": \"\",\n \"gender\": 0,\n \"birthday\": null,\n \"phone\": null,\n \"city\": null,\n \"country\": null,\n \"is_valid\": false,\n \"doi_is_delivery\": false,\n \"doi_is_open\": false,\n \"doi_is_click\": false,\n \"user_vars\": {\n \"date_glob\": null,\n \"glob\": 66432\n },\n \"bunce_log\": null,\n \"tags\": [],\n \"categories\": [],\n \"created\": \"2026-03-03T16:06:29.724362\",\n \"modified\": \"2026-03-03T16:06:29.740263\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9c7ac401-e8b1-4d5f-9ca1-814822925959", "name": "Обновление информации о подписчике по имейлу", "request": { "name": "Обновление информации о подписчике по имейлу", "description": { "content": "Обновляет информацию о подписчике, идентифицируя его по паре `email` + `source` в теле запроса.\n\n**Эндпоинт:** `PATCH https://mailganer.com/api/v2/emails/update/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n**Content-Type:** `application/json`\n\n### Тело запроса\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `email` | string | да | Имейл подписчика |\n| `source` | int / array / `\"all\"` | да | ID списка; можно передать несколько `[49767,50145]` или `\"all\"` |\n| `phone` | string | нет | Телефон |\n| `name` | string | нет | Имя |\n| `surname` | string | нет | Фамилия |\n| `patronymic` | string | нет | Отчество |\n| `gender` | int | нет | 1 — мужской, 2 — женский |\n| `birthday` | string | нет | Дата рождения, формат `dd.mm.yyyy` |\n| `city` | string | нет | Город |\n| `add_tag` | string / array | нет | Добавить метку |\n| `delete_tag` | string | нет | Удалить метку |\n| `user_vars` | object | нет | Пользовательские переменные (передайте `null` в значении, чтобы удалить переменную) |\n| `not_doi` | bool | нет | Отменить отправку письма подтверждения |\n| `need_activate` | bool | нет | Отправить письмо подтверждения |\n| `add_category` | string | нет | Добавить категорию подписки |\n| `delete_category` | string | нет | Удалить категорию подписки |\n\n### Пример curl\n```bash\ncurl --location --request PATCH 'https://mailganer.com/api/v2/emails/update/' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"email\": \"test@example.com\",\n \"source\": \"51488\",\n \"birthday\": \"05.01.1990\"\n}'\n```\n\n### Примечания\n- Переменные (`user_vars`) обновляются только если явно переданы в запросе; значение `null` удаляет переменную (для всех типов).\n- Альтернативные способы: передача `mg_hash` в URL (`/api/v2/emails/:email_hash/`) или массовое обновление `/api/v2/emails/mass/`.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "emails", "update", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"email\": \"test@example.com\",\n \"source\": \"51488\",\n \"birthday\": \"05.01.1990\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4ba182e0-2078-4ee3-9474-727c25104406", "name": "Успех (200)", "originalRequest": { "url": { "path": [ "api", "v2", "emails", "update", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"email\": \"test@example.com\",\n \"source\": \"51488\",\n \"birthday\": \"05.01.1990\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 45763880,\n \"mg_hash\": \"53158545763880e054b31ecbad2cf3265d4001d1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86ef9280-3d71-4f6b-82d7-c57f86e16dd4", "name": "Ошибка (400)", "originalRequest": { "url": { "path": [ "api", "v2", "emails", "update", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"email\": \"test@example.com\",\n \"source\": \"51488\",\n \"birthday\": \"05.01.1990\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"invalid\",\n \"error\": {\n \"source\": [\n \"Not found site or blocked\"\n ],\n \"birthday\": [\n \"Неправильный формат date. Используйте: DD.MM.YYYY\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ec9462c6-4595-49f3-b2af-b88ec5497d7f", "name": "Отписка подписчика по mg_hash", "request": { "name": "Отписка подписчика по mg_hash", "description": { "content": "Отписывает подписчика, идентифицируя его по хэшу имейла (`mg_hash`) в URL. Это рабочий способ отписки.\n\n**Эндпоинт:** `POST https://mailganer.com/api/v2/emails/:email_hash/unsubscribe/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n\nПодписчик определяется по path-переменной `email_hash` (значение `mg_hash`). Тело запроса не требуется.\n\n### Пример curl\n```bash\ncurl --location --request POST 'https://mailganer.com/api/v2/emails/a05ad557332370764cd4f267a251f3b13289bcff/unsubscribe/' \\\n--header 'Authorization: CodeRequest {{api_key}}'\n```\n\n### Примечания\n- Успешный ответ: `{\"email_status\": \"unsubscribe\"}` — статус подписки меняется на «Отписался».\n- Если подписчик по хэшу не найден — вернётся ошибка `{\"status\": \"error\", \"error\": \"Не найдено.\"}`.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "emails", ":email_hash", "unsubscribe", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a05ad557332370764cd4f267a251f3b13289bcff", "key": "email_hash", "description": "(Required) Хэш имейла" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "71a14ea5-9fe9-4882-b833-16f01506ab0a", "name": "Успех (200)", "originalRequest": { "url": { "path": [ "api", "v2", "emails", ":email_hash", "unsubscribe", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a05ad557332370764cd4f267a251f3b13289bcff", "key": "email_hash", "description": "(Required) Хэш имейла" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"email_status\": \"unsubscribe\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "602ddd8b-953b-453b-9b01-be792447fcda", "name": "Ошибка (404)", "originalRequest": { "url": { "path": [ "api", "v2", "emails", ":email_hash", "unsubscribe", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a05ad557332370764cd4f267a251f3b13289bcff", "key": "email_hash", "description": "(Required) Хэш имейла" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"error\": \"Не найдено.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f7fdd420-a94c-4ee1-a5d7-bacf247c322e", "name": "Отписка подписчика по имейлу", "request": { "name": "Отписка подписчика по имейлу", "description": { "content": "Отписывает подписчика, идентифицируя его по паре `email` + `source` в теле запроса.\n\n**Эндпоинт:** `POST https://mailganer.com/api/v2/emails/unsubscribe/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n**Content-Type:** `application/json`\n\n### Тело запроса\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `email` | string | да | Имейл подписчика |\n| `source` | int / array / `\"all\"` | да | ID списка; можно передать несколько или `\"all\"` |\n\n### Пример curl\n```bash\ncurl --location --request POST 'https://mailganer.com/api/v2/emails/unsubscribe/' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"email\": \"test@example.com\",\n \"source\": \"51488\"\n}'\n```\n\n### Примечания\n- Успешный ответ: `{\"email_status\": \"unsubscribe\"}` — статус подписки меняется на «Отписался».\n- Если подписчик не найден — вернётся ошибка `{\"status\": \"error\", \"error\": \"Не найдено.\"}`.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "emails", "unsubscribe", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"email\": \"test@example.com\",\n \"source\": \"51488\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "601df5ea-b06a-4fef-8fe7-fff65411e7bf", "name": "Успех (200)", "originalRequest": { "url": { "path": [ "api", "v2", "emails", "unsubscribe", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"test@example.com\",\n \"source\": \"51488\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"email_status\": \"unsubscribe\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d2fee92-e8a1-43b7-ae69-0b43ec16bd4c", "name": "Ошибка (404)", "originalRequest": { "url": { "path": [ "api", "v2", "emails", "unsubscribe", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"test@example.com\",\n \"source\": \"51488\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"error\": \"Не найдено.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1d7e4689-b7a8-4fb8-bc01-b18b405093d6", "name": "Валидация подписчика", "request": { "name": "Валидация подписчика", "description": { "content": "Проверяет валидность имейла. Валидация тарифицируется отдельно.\n\n**Эндпоинт:** `POST https://mailganer.com/api/v2/emails/validate/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n**Content-Type:** `application/json`\n\n### Тело запроса\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `email` | string | ✔ | Имейл |\n| `source` | int | ✔ | ID списка |\n\n### Пример curl\n```bash\ncurl --location --request POST 'https://mailganer.com/api/v2/emails/validate/' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"email\": \"test@example.com\",\n \"source\": 49767\n}'\n```\n\n### Примечания\n- При слишком частых запросах по одному имейлу — ошибка «Email to many add method».\n- В ответе `is_valid` показывает результат проверки; `corrected_email` — исправленный имейл (если было исправление).\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "emails", "validate", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"email\": \"test@example.com\",\n \"source\": 49767\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "06ba4e05-cc06-475d-a5d2-dd750c72ea05", "name": "Успех (200)", "originalRequest": { "url": { "path": [ "api", "v2", "emails", "validate", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"test@example.com\",\n \"source\": 49767\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 305384342,\n \"mg_hash\": \"b9827434aeaa159e4c3a723a4a3e91d\",\n \"email\": \"test@internet.ru\",\n \"source\": 93455916,\n \"email_status\": \"wait_activated\",\n \"corrected_email\": \"test@internet.ru\",\n \"name\": \"\",\n \"patronymic\": \"\",\n \"surname\": \"\",\n \"gender\": 0,\n \"birthday\": null,\n \"phone\": null,\n \"city\": null,\n \"country\": null,\n \"is_valid\": true,\n \"doi_is_delivery\": false,\n \"doi_is_open\": false,\n \"doi_is_click\": false,\n \"user_vars\": {},\n \"bunce_log\": null,\n \"tags\": [],\n \"categories\": [],\n \"created\": \"2025-10-23T17:19:02.635703\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4286ecfd-4a5e-4538-b6ec-f293a404692f", "name": "Массовое обновление подписчиков", "request": { "name": "Массовое обновление подписчиков", "description": { "content": "Обновляет до 50 подписчиков за один запрос. Тело — JSON-массив объектов. Операция атомарна.\n\n**Эндпоинт:** `PATCH https://mailganer.com/api/v2/emails/mass/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n**Content-Type:** `application/json`\n\n### Тело запроса\nМассив объектов; поля каждого объекта:\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `email` | string | да | Имейл подписчика |\n| `source` | int / array / `\"all\"` | да | ID списка (узнать ID: https://mailganer.com/app/settings/); можно передать несколько или `\"all\"` |\n| `phone` | string | нет | Телефон |\n| `name` | string | нет | Имя |\n| `surname` | string | нет | Фамилия |\n| `patronymic` | string | нет | Отчество |\n| `gender` | int | нет | 1 — мужской, 2 — женский |\n| `birthday` | string | нет | Дата рождения, формат `dd.mm.yyyy` |\n| `city` | string | нет | Город |\n| `add_tag` | string / array | нет | Добавить метку |\n| `delete_tag` | string | нет | Удалить метку |\n| `user_vars` | object | нет | Пользовательские переменные; чтобы удалить значение переменной — передайте `null` |\n| `not_doi` | bool | нет | Отменяет отправку письма подтверждения; имейл добавляется в статусе «Активен» |\n| `need_activate` | bool | нет | Отправляет письмо подтверждения, даже если имейл в статусе «Запрошено подтверждение» |\n| `add_category` | string | нет | Добавить категорию подписки |\n| `delete_category` | string | нет | Удалить категорию подписки |\n| `email_status` | string | нет | Изменить статус. Значение `unsubscribe` меняет статус подписчика с «Активен» на «Отписался» |\n\n### Пример curl\n```bash\ncurl --location --request PATCH 'https://mailganer.com/api/v2/emails/mass/' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '[\n {\n \"email\": \"test@example.com\",\n \"source\": 49767,\n \"name\": \"Федор\",\n \"surname\": \"Федоров\"\n }\n]'\n```\n\n### Примечания\n- Максимум **50** имейлов за запрос.\n- Атомарность: если хотя бы в одном имейле есть ошибка, **ни один** имейл из пакета не будет обновлён.\n- `source` принимает: одиночный ID, массив ID или `\"all\"` (все списки).\n- В ответе по каждому имейлу возвращаются `id` и `mg_hash`.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "emails", "mass", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "[\n {\n \"email\": \"test@example.com\",\n \"source\": 49767,\n \"name\": \"Федор\",\n \"surname\": \"Федоров\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "730719ce-162d-40a5-a8d0-5601ee0517f4", "name": "Успех (200)", "originalRequest": { "url": { "path": [ "api", "v2", "emails", "mass", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "[\n {\n \"email\": \"test@example.com\",\n \"source\": 49767,\n \"name\": \"Федор\",\n \"surname\": \"Федоров\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 45764030,\n \"mg_hash\": \"100330457640309ee63894dced455d110aebcb2b\"\n },\n {\n \"id\": 45764025,\n \"mg_hash\": \"e031e245764025457cb340b96fd670419cf95bb2\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "768b44a6-2a30-45c8-9afc-81e4b3dd43a9", "name": "Ошибка (400)", "originalRequest": { "url": { "path": [ "api", "v2", "emails", "mass", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "[\n {\n \"email\": \"test@example.com\",\n \"source\": 49767,\n \"name\": \"Федор\",\n \"surname\": \"Федоров\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"invalid\",\n \"error\": [\n {},\n {\n \"source\": [\n \"Not found site (source_id=497672) or site blocked\"\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "036daa3f-baed-4e4c-9616-f9f7fe65d50a", "name": "Массовое добавление подписчиков (v3)", "request": { "name": "Массовое добавление подписчиков (v3)", "description": { "content": "Добавляет подписчиков пачкой и возвращает подробный ответ: по каждой записи видно, добавилась она или нет и почему.\n\n**Эндпоинт:** `POST https://mailganer.com/api/v3/emails/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n**Content-Type:** `application/json`\n\nТело запроса — массив объектов подписчиков. Одиночный объект без массива метод тоже принимает.\n\n### Лимиты\n\n- Не больше 2000 запросов в минуту на аккаунт, при превышении вернётся `429`.\n- Жёсткого ограничения на размер пачки нет, но разумный размер — до нескольких сотен записей: ответ содержит полную карточку каждого добавленного подписчика.\n\n### Особенности\n\n- Пустая строка в необязательном поле равнозначна тому, что поле не передано: сохранённое значение не затирается. Незнакомые ключи игнорируются.\n- Если в `source` передан массив или `\"all\"`, подписчик создаётся в каждом списке, но в ответе придёт одна запись — по последнему обработанному списку.\n- Даты в переменных: dd.mm.yyyy, dd-mm-yyyy, yyyy.mm.dd, yyyy-mm-dd; дата-время — те же форматы плюс ЧЧ:ММ или ЧЧ:ММ:СС. Минимальный год 1900. Логические переменные принимают да/true/yes и нет/false/no в любом регистре.\n- Повторная отправка того же имейла в тот же список ошибкой не считается: подписчик обновляется и приходит в `successful`.\n\n### Ответ\n\nОтвет всегда содержит три массива: `successful` (добавлены), `failed` (не добавлены, в `errors` причина по каждому параметру), `warnings` (добавлены, но часть данных не записалась — чаще всего переменная не заведена в списке).\n\n| Код | Когда |\n|---|---|\n| `201` | Все записи добавлены, ошибок и предупреждений нет |\n| `207` | Часть записей не добавлена (непустой `failed`) или есть предупреждения (непустой `warnings`) |\n| `401` | Ключ API не передан или неверен, тело ответа пустое |\n| `429` | Превышен лимит 2000 запросов в минуту |\n| `503` | Сервис временно не смог обработать запрос, повторите через небольшую паузу |\n\n### Предупреждения по переменным\n\n| Когда возникает | Текст |\n|---|---|\n| Переменной нет в списке | Переменная \"имя\" не найдена и была пропущена. |\n| В целочисленную переменную передано не целое число | Значение \"...\" не является целым числом и было пропущено. |\n| В числовую переменную передано не число | Значение \"...\" не является числом и было пропущено. |\n| Некорректная дата или год меньше 1900 | Значение \"...\" не является корректной датой и было пропущено. |\n| Некорректная дата-время | Значение \"...\" не является корректной датой/временем и было пропущено. |\n| Логическое значение не из списка да/true/yes/нет/false/no | Значение \"...\" не является логическим значением и было пропущено. |\n| Строка не является корректным JSON (JSON-переменная) | Значение \"...\" не является корректным JSON и было пропущено. |\n| В значении найден html, а html не включён | В значении переменной \"имя\" обнаружен html-код; значение не записано. |\n\n### Возможные ошибки\n\n- `400` We have already sent a subscription confirmation email to this email. Resending is possible in 1 hour. — слишком много запросов на реактивацию имейла, повтор через час.\n- Email to many add method — при частых запросах второй запрос на тот же имейл не дождался обработки первого.\n\n### Пример curl\n\n```bash\ncurl --location --request POST 'https://mailganer.com/api/v3/emails/' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '[\n {\"email\": \"test1@example.com\", \"source\": 49767},\n {\"email\": \"test2@example.com\", \"source\": 49767}\n]'\n```\n", "type": "text/plain" }, "url": { "path": [ "api", "v3", "emails", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "[\n {\n \"email\": \"test1@example.com\",\n \"source\": 49767,\n \"name\": \"Федор\",\n \"patronymic\": \"Федорович\",\n \"surname\": \"Федоров\",\n \"gender\": 1,\n \"birthday\": \"01.01.1988\",\n \"phone\": \"+79123456789\",\n \"add_tag\": \"клиент\",\n \"add_category\": \"новости\",\n \"user_vars\": {\n \"text\": \"Текст\",\n \"integer\": 12,\n \"float\": 12.5,\n \"date\": \"01.01.1971\",\n \"boolean\": true\n }\n },\n {\n \"email\": \"test2@example.com\",\n \"source\": [\n 49767,\n 50145\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "64deccd1-4f1c-4f2d-b50c-6bc466a124e8", "name": "Все записи добавлены", "originalRequest": { "url": { "path": [ "api", "v3", "emails", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"email\": \"test1@example.com\",\n \"source\": 49767,\n \"name\": \"Федор\",\n \"patronymic\": \"Федорович\",\n \"surname\": \"Федоров\",\n \"gender\": 1,\n \"birthday\": \"01.01.1988\",\n \"phone\": \"+79123456789\",\n \"add_tag\": \"клиент\",\n \"add_category\": \"новости\",\n \"user_vars\": {\n \"text\": \"Текст\",\n \"integer\": 12,\n \"float\": 12.5,\n \"date\": \"01.01.1971\",\n \"boolean\": true\n }\n },\n {\n \"email\": \"test2@example.com\",\n \"source\": [\n 49767,\n 50145\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"successful\": [\n {\n \"id\": 48744043,\n \"mg_hash\": \"6b36dc48744043ec34ab9613c7f165b3e60f54f4\",\n \"email\": \"test1@example.com\",\n \"source\": 49767,\n \"email_status\": \"wait_activated\",\n \"corrected_email\": \"test1@example.com\",\n \"name\": \"Федор\",\n \"patronymic\": \"Федорович\",\n \"surname\": \"Федоров\",\n \"gender\": 1,\n \"birthday\": \"01.01.1988\",\n \"phone\": \"79123456789\",\n \"city\": null,\n \"country\": null,\n \"is_valid\": false,\n \"doi_is_delivery\": false,\n \"doi_is_open\": false,\n \"doi_is_click\": false,\n \"user_vars\": {},\n \"bunce_log\": null,\n \"tags\": [\n \"клиент\"\n ],\n \"categories\": [\n \"новости\"\n ],\n \"created\": \"2026-07-28T12:59:39.399936\",\n \"modified\": \"2026-07-28T12:59:39.459810\"\n }\n ],\n \"failed\": [],\n \"warnings\": []\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a033a4de-43d4-4297-8812-f5b0dc8d1cc7", "name": "Часть записей не добавлена или есть предупреждения", "originalRequest": { "url": { "path": [ "api", "v3", "emails", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"email\": \"test1@example.com\",\n \"source\": 49767,\n \"name\": \"Федор\",\n \"patronymic\": \"Федорович\",\n \"surname\": \"Федоров\",\n \"gender\": 1,\n \"birthday\": \"01.01.1988\",\n \"phone\": \"+79123456789\",\n \"add_tag\": \"клиент\",\n \"add_category\": \"новости\",\n \"user_vars\": {\n \"text\": \"Текст\",\n \"integer\": 12,\n \"float\": 12.5,\n \"date\": \"01.01.1971\",\n \"boolean\": true\n }\n },\n {\n \"email\": \"test2@example.com\",\n \"source\": [\n 49767,\n 50145\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"successful\": [\n {\n \"id\": 48744045,\n \"mg_hash\": \"07f361487440459e09f923bf5d29b1fdf65bdd1d\",\n \"email\": \"test1@example.com\",\n \"source\": 49767,\n \"email_status\": \"wait_activated\",\n \"corrected_email\": \"test1@example.com\",\n \"name\": \"\",\n \"patronymic\": \"\",\n \"surname\": \"\",\n \"gender\": 0,\n \"birthday\": null,\n \"phone\": null,\n \"city\": null,\n \"country\": null,\n \"is_valid\": false,\n \"doi_is_delivery\": false,\n \"doi_is_open\": false,\n \"doi_is_click\": false,\n \"user_vars\": {},\n \"bunce_log\": null,\n \"tags\": [],\n \"categories\": [],\n \"created\": \"2026-07-28T12:59:39.399936\",\n \"modified\": \"2026-07-28T12:59:39.459810\"\n }\n ],\n \"failed\": [\n {\n \"email\": \"not-an-email\",\n \"errors\": {\n \"email\": [\n \"Введите корректный адрес электронной почты. Указан невалидный not-an-email\"\n ]\n }\n },\n {\n \"email\": \"test3@example.com\",\n \"errors\": {\n \"source\": [\n \"Not found site (source=[99999999]) or site blocked\"\n ]\n }\n },\n {\n \"email\": \"test4@example.com\",\n \"errors\": {\n \"source\": [\n \"Это поле обязательно.\"\n ]\n }\n }\n ],\n \"warnings\": []\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a25b240-22ed-4218-af9a-78700af4e61b", "name": "Ключ API не передан или неверен, тело пустое", "originalRequest": { "url": { "path": [ "api", "v3", "emails", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"email\": \"test1@example.com\",\n \"source\": 49767,\n \"name\": \"Федор\",\n \"patronymic\": \"Федорович\",\n \"surname\": \"Федоров\",\n \"gender\": 1,\n \"birthday\": \"01.01.1988\",\n \"phone\": \"+79123456789\",\n \"add_tag\": \"клиент\",\n \"add_category\": \"новости\",\n \"user_vars\": {\n \"text\": \"Текст\",\n \"integer\": 12,\n \"float\": 12.5,\n \"date\": \"01.01.1971\",\n \"boolean\": true\n }\n },\n {\n \"email\": \"test2@example.com\",\n \"source\": [\n 49767,\n 50145\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "28c5d3bc-02d9-4fbd-83c5-8a7528bfedbe", "name": "Превышен лимит 2000 запросов в минуту", "originalRequest": { "url": { "path": [ "api", "v3", "emails", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"email\": \"test1@example.com\",\n \"source\": 49767,\n \"name\": \"Федор\",\n \"patronymic\": \"Федорович\",\n \"surname\": \"Федоров\",\n \"gender\": 1,\n \"birthday\": \"01.01.1988\",\n \"phone\": \"+79123456789\",\n \"add_tag\": \"клиент\",\n \"add_category\": \"новости\",\n \"user_vars\": {\n \"text\": \"Текст\",\n \"integer\": 12,\n \"float\": 12.5,\n \"date\": \"01.01.1971\",\n \"boolean\": true\n }\n },\n {\n \"email\": \"test2@example.com\",\n \"source\": [\n 49767,\n 50145\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "10f8203a-3448-4463-87ed-de79537c44d0", "name": "Сервис временно недоступен, повторите запрос позже", "originalRequest": { "url": { "path": [ "api", "v3", "emails", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"email\": \"test1@example.com\",\n \"source\": 49767,\n \"name\": \"Федор\",\n \"patronymic\": \"Федорович\",\n \"surname\": \"Федоров\",\n \"gender\": 1,\n \"birthday\": \"01.01.1988\",\n \"phone\": \"+79123456789\",\n \"add_tag\": \"клиент\",\n \"add_category\": \"новости\",\n \"user_vars\": {\n \"text\": \"Текст\",\n \"integer\": 12,\n \"float\": 12.5,\n \"date\": \"01.01.1971\",\n \"boolean\": true\n }\n },\n {\n \"email\": \"test2@example.com\",\n \"source\": [\n 49767,\n 50145\n ]\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "5421ae3a-767c-4eb4-b0e1-ff33de7dea77", "name": "Списки", "description": { "content": "Работа со списками рассылки и их настройками", "type": "text/plain" }, "item": [ { "id": "73f0f4c0-d55a-43b4-85fe-a97758208125", "name": "Создать список", "request": { "name": "Создать список", "description": { "content": "Создаёт новый список рассылки.\n\n**Эндпоинт:** `POST https://mailganer.com/api/v2/sites/` \n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}` \n**Content-Type:** `application/json`\n\n### Тело запроса\n\n| Поле | Тип | Обяз. | Описание |\n| --- | --- | --- | --- |\n| `domain` | string | да | Название списка |\n\n### Пример curl\n\n``` bash\ncurl --location --request POST 'https://mailganer.com/api/v2/sites/' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"domain\": \"test2\"\n}'\n\n ```\n\n### Примечания\n\n- В ответе возвращается объект созданного списка, включая его `id`.\n \n- Поле `domain` не должно содержать недопустимые символы (например `<`, `>`).\n \n- Комбинация полей `domain` и `user` должна быть уникальной (иначе `non_field_errors`).\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sites", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"domain\": \"test2\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c55ba5e4-58e3-421b-ba5f-83239c6a420c", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v2", "sites", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"domain\": \"test2\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "key": "Server", "value": "nginx/1.16.1", "description": "" }, { "disabled": false, "key": "Date", "value": "Fri, 09 Dec 2022 10:29:04 GMT", "description": "" }, { "disabled": false, "key": "Transfer-Encoding", "value": "chunked", "description": "" }, { "disabled": false, "key": "Connection", "value": "close", "description": "" }, { "disabled": false, "key": "Content-Language", "value": "ru", "description": "" }, { "disabled": false, "key": "Vary", "value": "Accept, Accept-Language, Cookie, Origin", "description": "" }, { "disabled": false, "key": "Location", "value": "", "description": "" }, { "disabled": false, "key": "Allow", "value": "GET, POST, HEAD, OPTIONS", "description": "" }, { "disabled": false, "key": "X-Frame-Options", "value": "SAMEORIGIN", "description": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 60968,\n \"domain\": \"test8\",\n \"domain_ext\": \"\",\n \"url\": \"\",\n \"logo\": null,\n \"user\": 10912,\n \"source_type\": 3,\n \"source\": 1,\n \"active\": true,\n \"click_domain\": \"click.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3619dc0-8cfb-4b26-b02a-f1732de94f68", "name": "Ошибка (4xx)", "originalRequest": { "url": { "path": [ "api", "v2", "sites", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"domain\": \"test2\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"invalid\",\n \"error\": {\n \"domain\": [\n \"Содержит недопустимые символы: <, >\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8427a2e3-617b-41b1-9fa8-466a2cb7e7d7", "name": "Error - Недопустимый токен", "originalRequest": { "url": { "path": [ "api", "v2", "sites", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"domain\": \"test2\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "key": "Server", "value": "nginx/1.16.1", "description": "" }, { "disabled": false, "key": "Date", "value": "Fri, 09 Dec 2022 10:28:28 GMT", "description": "" }, { "disabled": false, "key": "Transfer-Encoding", "value": "chunked", "description": "" }, { "disabled": false, "key": "Connection", "value": "close", "description": "" }, { "disabled": false, "key": "Content-Language", "value": "ru", "description": "" }, { "disabled": false, "key": "Vary", "value": "Accept, Accept-Language, Cookie, Origin", "description": "" }, { "disabled": false, "key": "Allow", "value": "GET, POST, HEAD, OPTIONS", "description": "" }, { "disabled": false, "key": "X-Frame-Options", "value": "SAMEORIGIN", "description": "" }, { "disabled": false, "key": "WWW-Authenticate", "value": "CodeRequest", "description": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"error\": \"Недопустимый токен.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e1305d3d-3c36-4599-824b-1b544c54e71e", "name": "Получить массив списков", "request": { "name": "Получить массив списков", "description": { "content": "Возвращает постраничный массив списков рассылки аккаунта.\n\n**Эндпоинт:** `GET https://mailganer.com/api/v2/sites/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n\n### Query-параметры\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `simple` | bool | нет | Если `true`, возвращаются только основные поля (`id` и `domain`). По умолчанию `false` |\n\n### Пример curl\n```bash\ncurl --location --request GET 'https://mailganer.com/api/v2/sites/' \\\n--header 'Authorization: CodeRequest {{api_key}}'\n```\n\n### Примечания\n- Ответ постраничный: поля `count`, `next`, `previous`, `results`.\n- Стандартный элемент `results` содержит: `id`, `domain`, `domain_ext`, `logo`, `user`, `click_domain`, `count_emails`, `count_emails_active`.\n- При `simple=true` элемент `results` содержит только `id` и `domain`.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sites", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "simple", "value": "true", "description": "Если true — вернуть только id и domain (по умолчанию false)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "fdae9533-ea0a-419e-9b84-a939eddd0831", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v2", "sites", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "simple", "value": "true" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "key": "Server", "value": "nginx/1.16.1", "description": "" }, { "disabled": false, "key": "Date", "value": "Fri, 09 Dec 2022 10:30:55 GMT", "description": "" }, { "disabled": false, "key": "Transfer-Encoding", "value": "chunked", "description": "" }, { "disabled": false, "key": "Connection", "value": "close", "description": "" }, { "disabled": false, "key": "Vary", "value": "Accept, Accept-Language, Cookie, Origin", "description": "" }, { "disabled": false, "key": "X-Frame-Options", "value": "SAMEORIGIN", "description": "" }, { "disabled": false, "key": "Content-Language", "value": "ru", "description": "" }, { "disabled": false, "key": "Allow", "value": "GET, POST, HEAD, OPTIONS", "description": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 60968,\n \"domain\": \"mailagner.com\",\n \"domain_ext\": \"\",\n \"url\": \"\",\n \"logo\": null,\n \"user\": 10912,\n \"source_type\": 3,\n \"source\": 1,\n \"active\": true,\n \"click_domain\": \"click.mailagner.com\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "241ac55a-5629-4a3e-9ed9-850b7d942b91", "name": "Проверка верификации домена", "request": { "name": "Проверка верификации домена", "description": { "content": "Проверяет статус верификации домена списка (SPF, DMARC, DKIM).\n\n**Эндпоинт:** `GET https://mailganer.com/api/v2/sites/verify_domain/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n\n### Query-параметры\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `domain` | string | да | Домен, который необходимо проверить |\n\n### Пример curl\n```bash\ncurl --location --request GET 'https://mailganer.com/api/v2/sites/verify_domain/?domain=mailganer.com' \\\n--header 'Authorization: CodeRequest {{api_key}}'\n```\n\n### Примечания\n- Ответ содержит булевы поля: `verification_status` (общий статус верификации), `spf_status`, `dmarc_status`, `dkim_status`.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sites", "verify_domain", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "domain", "value": "mailganer.com", "description": "Домен, который необходимо проверить" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e0e2c8b7-2c2f-4882-83a1-efa74945c38a", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v2", "sites", "verify_domain", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "domain", "value": "mailganer.com" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "key": "Server", "value": "nginx/1.16.1", "description": "" }, { "disabled": false, "key": "Date", "value": "Mon, 23 Jan 2023 07:46:39 GMT", "description": "" }, { "disabled": false, "key": "Transfer-Encoding", "value": "chunked", "description": "" }, { "disabled": false, "key": "Connection", "value": "close", "description": "" }, { "disabled": false, "key": "Vary", "value": "Accept, Accept-Language, Cookie, Origin", "description": "" }, { "disabled": false, "key": "X-Frame-Options", "value": "SAMEORIGIN", "description": "" }, { "disabled": false, "key": "Content-Language", "value": "ru", "description": "" }, { "disabled": false, "key": "Allow", "value": "GET, HEAD, OPTIONS", "description": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"verification_status\": true,\n \"spf_status\": true,\n \"dmarc_status\": true,\n \"dkim_status\": true\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9263242f-b987-4f16-a5af-214d6ea18673", "name": "Задать ссылку на webhook", "request": { "name": "Задать ссылку на webhook", "description": { "content": "Задаёт (или обновляет) URL webhook для списка и параметры его работы.\n\n**Эндпоинт:** `POST https://mailganer.com/api/v2/sites/set_webhook`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n**Content-Type:** `application/json`\n\n### Тело запроса\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `id` | string | да | ID списка (можно узнать в настройках списка: https://mailganer.com/app/settings/) |\n| `url` | string | да | URL, на который отправляются события (webhook) |\n| `is_active` | bool | нет | Включает/отключает отправку событий на webhook |\n| `is_use_auth_key` | bool | нет | Включает/отключает отправку ключа авторизации в заголовке `Authorization` |\n| `is_enable_retry` | bool | нет | Включает/отключает повторы, если URL хука недоступен |\n\n### Пример curl\n```bash\ncurl --location --request POST 'https://mailganer.com/api/v2/sites/set_webhook' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"id\": 1008,\n \"url\": \"https://webhook.site/example\",\n \"is_active\": true,\n \"is_use_auth_key\": true,\n \"is_enable_retry\": false\n}'\n```\n\n### Примечания\n- Повторы (`is_enable_retry`) выполняются тремя попытками при ошибке эндпоинта: через 5 секунд, 1 час и 24 часа.\n- Активировать webhook также можно в настройках списка на вкладке «Интеграции».\n- При `is_use_auth_key=true` ключ авторизации передаётся в заголовке `Authorization`.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "sites", "set_webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"id\": 1008,\n \"url\": \"https://webhook.site/example\",\n \"is_active\": true,\n \"is_use_auth_key\": true,\n \"is_enable_retry\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "11028c70-0dda-41e4-8012-fa60c49a693d", "name": "Успех (200)", "originalRequest": { "url": { "path": [ "api", "v2", "sites", "set_webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": 1008,\n \"url\": \"https://webhook.site/example\",\n \"is_active\": true,\n \"is_use_auth_key\": true,\n \"is_enable_retry\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1008,\n \"is_active\": true,\n \"url\": \"https://webhook.site/b27b31cd-1fc9-48df-be47-4e2678546ca241b\",\n \"is_use_auth_key\": true,\n \"is_enable_retry\": false\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "e68b713a-efac-43a4-903a-19182101bab8", "name": "Сегменты", "description": { "content": "Создание и получение сегментов подписчиков", "type": "text/plain" }, "item": [ { "id": "ada5be12-22d8-4e73-8876-d6c06e215e05", "name": "Создать сегмент", "request": { "name": "Создать сегмент", "description": { "content": "Создаёт сегмент подписчиков по заданным условиям.\n\n**Эндпоинт:** `POST https://mailganer.com/api/v2/segments/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n**Content-Type:** `application/json`\n\n### Тело запроса\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `title` | string | да | Название сегмента |\n| `conditions` | array | да | Массив условий сегментации |\n| `conditions[].condition` | int | да | Тип условия (например, `6` — «Метка», `5` — «Список») |\n| `conditions[].type_value` | int | да | Тип значения (`4` — «Равна одной из», `5` — «Не равна одной из») |\n| `conditions[].value` | array | да | Значения условия |\n\n### Пример curl\n```bash\ncurl --location --request POST 'https://mailganer.com/api/v2/segments/' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"title\": \"Тест API\",\n \"conditions\": [\n {\n \"condition\": 6,\n \"type_value\": 4,\n \"value\": [\"Тег\"]\n },\n {\n \"condition\": 5,\n \"type_value\": 4,\n \"value\": [\"51822\"]\n }\n ]\n}'\n```\n\n### Примечания\n- В ответе возвращаются `status`, `segment_url` (ссылка на созданный сегмент) и `segment_id`.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "segments", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"title\": \"Тест API\",\n \"conditions\": [\n {\n \"condition\": 6, // Тип условия \"Метка\"\n \"type_value\": 4, // Тип значения \"Равна одной из\" (5 — \"Не равна одной из\")\n \"value\": [\"Тег\"]\n },\n {\n \"condition\": 5, // Тип условия \"Список\"\n \"type_value\": 4,\n \"value\": [\"51822\"]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "185e45a4-9cc6-4d7d-a124-828722b4904b", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v2", "segments", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"Тест API\",\n \"conditions\": [\n {\n \"condition\": 6, // Тип условия \"Метка\"\n \"type_value\": 4, // Тип значения \"Равна одной из\" (5 — \"Не равна одной из\")\n \"value\": [\"Тег\"]\n },\n {\n \"condition\": 5, // Тип условия \"Список\"\n \"type_value\": 4,\n \"value\": [\"51822\"]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"segment_url\": \"https://mailganer.com/app/segment/edit/19254/\",\n \"segment_id\": 19254\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9c76081d-1258-4bff-b7bd-2357e3a37db3", "name": "Получить массив сегментов", "request": { "name": "Получить массив сегментов", "description": { "content": "Возвращает постраничный массив сегментов аккаунта.\n\n**Эндпоинт:** `GET https://mailganer.com/api/v2/segments/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n\n### Пример curl\n```bash\ncurl --location --request GET 'https://mailganer.com/api/v2/segments/' \\\n--header 'Authorization: CodeRequest {{api_key}}'\n```\n\n### Примечания\n- Ответ постраничный: поля `count`, `next`, `previous`, `results`; переход по страницам — через `next`/`previous` (параметр `page`).\n- Элемент `results` содержит: `title`, `id`, `cnt_email`, `cnt_active_email`, `created`.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "segments", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1e7ef04d-a1fb-4be9-8e61-e39f21c61f0a", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v2", "segments", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "key": "Server", "value": "nginx/1.16.1", "description": "" }, { "disabled": false, "key": "Date", "value": "Fri, 09 Dec 2022 10:33:00 GMT", "description": "" }, { "disabled": false, "key": "Transfer-Encoding", "value": "chunked", "description": "" }, { "disabled": false, "key": "Connection", "value": "close", "description": "" }, { "disabled": false, "key": "Vary", "value": "Accept, Accept-Language, Cookie, Origin", "description": "" }, { "disabled": false, "key": "X-Frame-Options", "value": "SAMEORIGIN", "description": "" }, { "disabled": false, "key": "Content-Language", "value": "ru", "description": "" }, { "disabled": false, "key": "Allow", "value": "GET, POST, HEAD, OPTIONS", "description": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 2,\n \"next\": \"https://mailganer.com/api/v2/segments/?page=2\",\n \"previous\": null,\n \"results\": [\n {\n \"title\": \"Название сегмента\",\n \"id\": 1831,\n \"cnt_email\": 478,\n \"cnt_active_email\": 478,\n \"created\": \"2017-05-27T17:35:04.713572\"\n },\n {\n \"title\": \"Название сегмента 2\",\n \"id\": 1832,\n \"cnt_email\": 478,\n \"cnt_active_email\": 478,\n \"created\": \"2017-05-27T17:35:04.713572\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e4945b2-a3f2-495a-b3dd-7fdb255b579d", "name": "Получить информацию о сегменте", "request": { "name": "Получить информацию о сегменте", "description": { "content": "Возвращает информацию об одном сегменте по его ID.\n\n**Эндпоинт:** `GET https://mailganer.com/api/v2/segments/:segment_id`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n\n### Path-параметры\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `segment_id` | int | да | ID сегмента |\n\n### Пример curl\n```bash\ncurl --location --request GET 'https://mailganer.com/api/v2/segments/12345' \\\n--header 'Authorization: CodeRequest {{api_key}}'\n```\n\n### Примечания\n- Ответ содержит: `title`, `id`, `cnt_email`, `cnt_active_email`, `created`.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "segments", ":segment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "12345", "key": "segment_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a3b078dd-d92c-4bf8-a70a-84d207ccaa61", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v2", "segments", ":segment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "12345", "key": "segment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "key": "Server", "value": "nginx/1.16.1", "description": "" }, { "disabled": false, "key": "Date", "value": "Fri, 09 Dec 2022 10:35:58 GMT", "description": "" }, { "disabled": false, "key": "Transfer-Encoding", "value": "chunked", "description": "" }, { "disabled": false, "key": "Connection", "value": "close", "description": "" }, { "disabled": false, "key": "Vary", "value": "Accept, Accept-Language, Cookie, Origin", "description": "" }, { "disabled": false, "key": "X-Frame-Options", "value": "SAMEORIGIN", "description": "" }, { "disabled": false, "key": "Content-Language", "value": "ru", "description": "" }, { "disabled": false, "key": "Allow", "value": "GET, HEAD, OPTIONS", "description": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"title\": \"Название сегмента\",\n \"id\": 12345,\n \"cnt_email\": 1,\n \"cnt_active_email\": 1,\n \"created\": \"2022-12-05T11:26:44.465956\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f664dfd6-0fee-4457-a908-a786582e76d6", "name": "Отправка триггера на сегмент", "request": { "name": "Отправка триггера на сегмент", "description": { "content": "Запускает отправку триггерного письма подписчикам указанного сегмента.\n\n**Эндпоинт:** `POST https://mailganer.com/api/v2/segments/:segment_id/send_trigger/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n**Content-Type:** `application/json`\n\n### Path-параметры\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `segment_id` | int | да | ID сегмента, по которому запускается триггер |\n\n### Тело запроса\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `trigger_id` | int | да | ID триггера, который необходимо отправить |\n\n### Пример curl\n```bash\ncurl --location --request POST 'https://mailganer.com/api/v2/segments/12345/send_trigger/' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"trigger_id\": 34521\n}'\n```\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "segments", ":segment_id", "send_trigger", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "in culpa sint", "key": "segment_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"trigger_id\": 34521\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0711b89a-7d60-41bc-bede-92a2935b6d52", "name": "Не переданы обязательные поля", "originalRequest": { "url": { "path": [ "api", "v2", "segments", ":segment_id", "send_trigger", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "in culpa sint", "key": "segment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"trigger_id\": 34521\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"invalid\",\n \"error\": {\n \"trigger_id\": [\n \"Это поле обязательно.\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "640e05bc-f7c2-4c9a-b8b8-1b0b53d651a9", "name": "Ключ API не передан или неверен", "originalRequest": { "url": { "path": [ "api", "v2", "segments", ":segment_id", "send_trigger", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "in culpa sint", "key": "segment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"trigger_id\": 34521\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9ca980f3-1091-4cc9-a5c4-e77c14c80f12", "name": "Триггер запущен на сегмент", "originalRequest": { "url": { "path": [ "api", "v2", "segments", ":segment_id", "send_trigger", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "in culpa sint", "key": "segment_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"trigger_id\": 34521\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f1aa0cde-4ac3-40fa-9264-0d565a341b67", "name": "Переменные", "description": { "content": "Пользовательские переменные подписчиков", "type": "text/plain" }, "item": [ { "id": "886d0c17-2a5a-4914-9afa-7e85c682441f", "name": "Добавление пользовательской переменной", "request": { "name": "Добавление пользовательской переменной", "description": { "content": "Добавляет пользовательскую переменную в указанный список.\n\n**Эндпоинт:** `POST https://mailganer.com/api/v2/user_vars/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n**Content-Type:** `application/json`\n\n### Тело запроса\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `source` | Целое число | ✔ | ID списка, в который добавляется переменная |\n| `title` | Строка | ✔ | Название переменной |\n| `type` | Целое число | ✔ | Тип переменной (допустимые значения — в таблице ниже) |\n| `name` | Строка | — | Имя переменной. Если не задано, формируется автоматически и возвращается в ответе |\n\n### Пример curl\n```bash\ncurl --location 'https://mailganer.com/api/v2/user_vars/' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"source\": 1,\n \"title\": \"Название переменной\",\n \"type\": 0\n}'\n```\n\n### Примечания\n- Значения поля `type`:\n\n | id типа | Тип переменной | Пример |\n |---|---|---|\n | 0 | Строка | Текст |\n | 1 | Целое число | 12 |\n | 2 | Вещественное число | 1.5 |\n | 3 | Дата | 22.07.2021 |\n | 4 | Дата и время | 22.07.2021 16:03:00 |\n | 6 | Логический тип | true или false |\n | 8 | Json-массив | {\"a\": 1, \"b\": \"два\", \"c\": [1, 2]} |\n- Ответ содержит поля: `source` (ID списка), `title` (название), `name` (имя переменной), `type` (тип), `type_text` (тип текстом).\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "user_vars", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"source\": 1,\n \"title\": \"Название переменной\",\n \"type\": 0,\n \"name\": \"my_var\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1014d31a-1cce-40c4-a83e-a2c2d03bea90", "name": "Не переданы обязательные поля", "originalRequest": { "url": { "path": [ "api", "v2", "user_vars", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source\": 1,\n \"title\": \"Название переменной\",\n \"type\": 0,\n \"name\": \"my_var\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"invalid\",\n \"error\": {\n \"type\": [\n \"Это поле обязательно.\"\n ],\n \"title\": [\n \"Это поле обязательно.\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0642fe8-5fec-4cdd-9def-6cd053adb8c3", "name": "Ключ API не передан или неверен", "originalRequest": { "url": { "path": [ "api", "v2", "user_vars", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source\": 1,\n \"title\": \"Название переменной\",\n \"type\": 0,\n \"name\": \"my_var\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ce079afa-1108-4cb5-89a5-956861c2c7dc", "name": "Переменная создана", "originalRequest": { "url": { "path": [ "api", "v2", "user_vars", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source\": 1,\n \"title\": \"Название переменной\",\n \"type\": 0,\n \"name\": \"my_var\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"source\": 49204058,\n \"title\": \"anim Excepteur sit nostrud\",\n \"name\": \"aliquip esse ullamco\",\n \"type\": 23541851,\n \"type_text\": \"sit eu dolor esse\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "04331dab-a3a2-49e3-9ac7-d20d4ddfcfcb", "name": "Получить список пользовательских переменных", "request": { "name": "Получить список пользовательских переменных", "description": { "content": "Возвращает список пользовательских переменных списка (или всех списков).\n\n**Эндпоинт:** `GET https://mailganer.com/api/v2/user_vars/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n\n### Query-параметры\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `source` | Целое число | — | ID списка. Если не указан — возвращаются переменные всех списков |\n\n### Пример curl\n```bash\ncurl --location 'https://mailganer.com/api/v2/user_vars/?source=1' \\\n--header 'Authorization: CodeRequest {{api_key}}'\n```\n\n### Примечания\n- Ответ постраничный: `count` (количество переменных), `next` / `previous` (ссылки на соседние страницы, `null` — если страницы нет), `results` (массив переменных).\n- Поля объекта в `results`: `source` (ID списка), `title` (название), `name` (системное имя для подстановки в шаблонах), `type` (тип), `is_global` (`false` — локальная, `true` — глобальная переменная).\n- По умолчанию API отдаёт по 25 записей на страницу.\n- Значения поля `type`:\n\n | id типа | Тип переменной | Пример |\n |---|---|---|\n | 0 | Строка | Текст |\n | 1 | Целое число | 12 |\n | 2 | Вещественное число | 1.5 |\n | 3 | Дата | 22.07.2021 |\n | 4 | Дата и время | 22.07.2021 16:03:00 |\n | 6 | Логический тип | true или false |\n | 8 | Json-массив | {\"a\": 1, \"b\": \"два\", \"c\": [1, 2]} |\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "user_vars", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "source", "value": "1", "description": "ID списка. Если не указан — переменные всех списков" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "3420ca13-cc25-4fde-98af-1adc4241688f", "name": "Успех (200)", "originalRequest": { "url": { "path": [ "api", "v2", "user_vars", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "source", "value": "1" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 11,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"source\": \"1\",\n \"title\": \"Телефон\",\n \"name\": \"phone\",\n \"type\": 0,\n \"is_global\": false\n },\n {\n \"source\": \"1\",\n \"title\": \"Имя\",\n \"name\": \"name\",\n \"type\": 0,\n \"is_global\": false\n },\n {\n \"source\": \"1\",\n \"title\": \"Фамилия\",\n \"name\": \"lastname\",\n \"type\": 0,\n \"is_global\": false\n },\n {\n \"source\": \"1\",\n \"title\": \"Отчество\",\n \"name\": \"patronymic\",\n \"type\": 0,\n \"is_global\": false\n },\n {\n \"source\": \"1\",\n \"title\": \"Дата рождения\",\n \"name\": \"birthday\",\n \"type\": 3,\n \"is_global\": false\n },\n {\n \"source\": \"1\",\n \"title\": \"Пол\",\n \"name\": \"gender\",\n \"type\": 0,\n \"is_global\": false\n },\n {\n \"source\": \"1\",\n \"title\": \"Страна\",\n \"name\": \"country\",\n \"type\": 0,\n \"is_global\": false\n },\n {\n \"source\": \"1\",\n \"title\": \"Город\",\n \"name\": \"city\",\n \"type\": 0,\n \"is_global\": false\n },\n {\n \"source\": \"1\",\n \"title\": \"Дата подписки\",\n \"name\": \"subscribe_date\",\n \"type\": 3,\n \"is_global\": false\n },\n {\n \"source\": 1,\n \"title\": \"float\",\n \"name\": \"float\",\n \"type\": 2,\n \"type_text\": \"Вещественное число\"\n },\n {\n \"source\": 1,\n \"title\": \"datetime\",\n \"name\": \"datetime\",\n \"type\": 4,\n \"type_text\": \"Дата и время\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "138b55b0-81b2-4a4c-acac-3f94ed810dc9", "name": "Теги", "description": { "content": "Управление тегами подписчиков", "type": "text/plain" }, "item": [ { "id": "59374bb9-5c99-4c61-928f-747dfafe0deb", "name": "Добавление тега", "request": { "name": "Добавление тега", "description": { "content": "Добавляет новый тег.\n\n**Эндпоинт:** `POST https://mailganer.com/api/v2/tags/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n**Content-Type:** `application/json`\n\n### Тело запроса\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `name` | Строка | ✔ | Имя тега. Длина не более 140 символов |\n\n### Пример curl\n```bash\ncurl --location 'https://mailganer.com/api/v2/tags/' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"name\": \"название_тега\"\n}'\n```\n\n### Примечания\n- Ответ содержит поля: `id` (идентификатор тега), `name` (имя тега).\n- Возможные ошибки:\n - `400 — The selected tag name is already in use` — тег с таким названием уже есть в системе.\n - `400 — The tag name must not exceed 140 characters` — длина `name` более 140 символов.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "tags", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"название_тега\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fc9ae9d2-4421-4a29-a4b0-8132cec721f6", "name": "Успех (200)", "originalRequest": { "url": { "path": [ "api", "v2", "tags", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"название_тега\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 28174,\n \"name\": \"название_тега\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4eb3e812-1fe4-4294-9e41-5fdbc6c31297", "name": "Получить список тегов", "request": { "name": "Получить список тегов", "description": { "content": "Возвращает список тегов.\n\n**Эндпоинт:** `GET https://mailganer.com/api/v2/tags/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n\n### Пример curl\n```bash\ncurl --location 'https://mailganer.com/api/v2/tags/' \\\n--header 'Authorization: CodeRequest {{api_key}}'\n```\n\n### Примечания\n- Ответ постраничный: `count` (количество тегов), `next` / `previous` (ссылки на соседние страницы), `results` (массив тегов).\n- Поля объекта в `results`: `id` (идентификатор тега), `name` (название тега).\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "tags", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c288a476-73f8-4eb8-bdb7-d493f106d9d2", "name": "Успех (200)", "originalRequest": { "url": { "path": [ "api", "v2", "tags", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 4,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 28174,\n \"name\": \"название_тега2\"\n },\n {\n \"id\": 28173,\n \"name\": \"название_тега\"\n },\n {\n \"id\": 28172,\n \"name\": \"test\"\n },\n {\n \"id\": 28171,\n \"name\": \"тест\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "6f13575e-4645-426e-9923-6ccb565c8bcb", "name": "Рассылки", "description": { "content": "Создание, отправка и статистика рассылок", "type": "text/plain" }, "item": [ { "id": "23f6bef3-94e6-480e-a6bb-bafd267e5d85", "name": "Создание рассылки", "request": { "name": "Создание рассылки", "description": { "content": "Создаёт черновик рассылки — возвращает ссылку на редактирование и `public_id`.\n\n**Эндпоинт:** `POST https://mailganer.com/api/v1/mailing/create/`\n**Авторизация:** `noauth` — API-ключ передаётся в теле запроса в поле `api_key`\n**Content-Type:** `multipart/form-data` (form-data)\n\n### Тело запроса (form-data)\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `api_key` | string | ✔ | Ключ API из профиля |\n| `name` | string | | Название рассылки, максимум 150 символов |\n| `html-content` | string | | Вёрстка рассылки |\n| `template_id` | string | | UID шаблона со страницы `https://mailganer.com/app/custom-templates/` |\n| `amp-html-content` | string | | Вёрстка AMP-рассылки |\n| `zip-content` | string | | Ссылка на архив с вёрсткой |\n| `amp-zip-content` | string | | Ссылка на архив с AMP-вёрсткой |\n| `theme` | string | | Тема рассылки |\n| `from_name` | string | | Имя отправителя |\n| `from_email` | string | | Имейл отправителя |\n| `segment_id` | int | | ID сегмента |\n| `utm_campaign` | string | | Если не передано — формируется как `{{year}}{{month}}{{day}}_{{public_id}}` (год, месяц, день отправки и ID рассылки) |\n| `utm_source` | string | | Если не передано — `\"mailganer\"` |\n| `utm_medium` | string | | Если не передано — `\"email\"` |\n| `user_utms` | JSON-строка | | Кастомные UTM-метки, формат `{\"param1\":\"value1\",\"param2\":\"value2\"}` |\n| `variables` | JSON-строка | | Динамические переменные, формат `{\"var1\":\"value1\",\"var2\":123}`; имеют приоритет над переменными подписчика |\n\n### Пример curl\n```bash\ncurl --location 'https://mailganer.com/api/v1/mailing/create/' \\\n--form 'api_key=\"XXX\"' \\\n--form 'name=\"Новая рассылка\"' \\\n--form 'theme=\"Theme\"' \\\n--form 'from_email=\"info@example.com\"' \\\n--form 'from_name=\"info@example.com\"' \\\n--form 'utm_campaign=\"summer_sale\"' \\\n--form 'utm_source=\"newsletter\"' \\\n--form 'utm_medium=\"email\"' \\\n--form 'user_utms=\"{\\\"promo\\\":\\\"summer2025\\\",\\\"location\\\":\\\"europe\\\"}\"' \\\n--form 'zip-content=\"https://cdn.mailganer.com/mailing-template/demo.zip\"'\n```\n\n### Примечания\n- В вёрстке письма можно одновременно использовать переменные из запроса (`variables`) и переменные подписчика (например `{{name}}`); значение, не обязательное для хранения в Mailganer (например `delivery_address`), можно передать в запросе и подставить как `{{delivery_address}}`.\n- При передаче вёрстки в `html-content` заменить символы: `&`→`%26`, `\"`→`%22`, `\\`→`%27`, `<`→`%3C`, `>`→`%3E`.\n- Архив в `zip-content` — только `.zip`; размер архива должен быть более 7 Мб; внутри обязателен html-файл.\n- Поля ответа: `status` (1 — успех, -1 — нет), `status_text` (`success`/`error`), `public_id`, `step1_url`, `error`.\n- Возможные значения `error`: `Invalid api key`; `Invalid http method`; `Invalid url`; `file недоступен`; `Zip-files only is allowed`; `Filesize must be more than 7 Mb`; `HTML template file not found`; `email the sender is not confirmed`; `segment_id does not exists`; `Invalid JSON decoded variables: No JSON object could be decoded`; `HTML and JavaScript are not allowed in variables for security reasons`.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "mailing", "create", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "api_key", "value": "{{api_key}}", "type": "text", "description": "(Required) Ключ API из профиля" }, { "key": "name", "value": "Новая рассылка", "type": "text", "description": "Название рассылки" }, { "key": "theme", "value": "Тема письма", "type": "text", "description": "Тема рассылки" }, { "key": "from_email", "value": "info@example.com", "type": "text", "description": "Имейл отправителя" }, { "key": "from_name", "value": "Mailganer", "type": "text", "description": "Имя отправителя" }, { "key": "segment_id", "value": "123456", "type": "text", "description": "ID сегмента" }, { "key": "html-content", "value": "Привет!", "type": "text", "description": "Вёрстка рассылки" } ] } }, "response": [ { "id": "63ae60b3-1491-4156-bd61-08b0fdd1f04d", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "mailing", "create", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Ключ API из профиля", "type": "text/plain" }, "key": "api_key", "value": "your_api_key", "type": "text" }, { "description": { "content": "Название рассылки", "type": "text/plain" }, "key": "name", "value": "Новая рассылка", "type": "text" }, { "description": { "content": "Тема рассылки", "type": "text/plain" }, "key": "theme", "value": "Тема письма", "type": "text" }, { "description": { "content": "Имейл отправителя", "type": "text/plain" }, "key": "from_email", "value": "info@example.com", "type": "text" }, { "description": { "content": "Имя отправителя", "type": "text/plain" }, "key": "from_name", "value": "Mailganer", "type": "text" }, { "description": { "content": "ID сегмента", "type": "text/plain" }, "key": "segment_id", "value": "123456", "type": "text" }, { "description": { "content": "Вёрстка рассылки", "type": "text/plain" }, "key": "html-content", "value": "Привет!", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 1,\n \"step1_url\": \"https://mailganer.com/app/mailing/step1/155959878052/\",\n \"status_text\": \"success\",\n \"public_id\": 155959878052\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6ba90a32-55fd-421c-b201-e64b3063b823", "name": "Отправка рассылки", "request": { "name": "Отправка рассылки", "description": { "content": "Отправляет рассылку — сразу или в запланированное время.\n\n**Эндпоинт:** `POST https://mailganer.com/api/v2/mailing/send/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n**Content-Type:** `application/json`\n\n### Тело запроса\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `public_id` | int | ✔ | ID рассылки |\n| `datetime_send` | string | | Дата/время отправки в формате `DD.MM.YYYY HH:MM`, например `16.02.2024 17:00` |\n| `is_chunked` | bool | | Включить распределённую отправку. Для сегментов больше 5 000 получателей. Недоступно при A/Б тестировании темы письма |\n| `chunk_size` | int | | Количество подписчиков в одной отправке. Значения вне допустимого диапазона система может скорректировать самостоятельно |\n| `chunk_timeout` | int | | Перерыв между отправками. Разрешённые значения: `15`, `30`, `60`, `90` минут |\n\n### Пример curl\n```bash\ncurl --location 'https://mailganer.com/api/v2/mailing/send/' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"public_id\": 155959878052,\n \"datetime_send\": \"16.02.2024 17:00\"\n}'\n```\n\n### Примечания\n- Параметры `chunk_size` и `chunk_timeout` требуют `is_chunked=True` (иначе ошибка `Parameters 'chunk_size' and 'chunk_timeout' require 'is_chunked=True'`).\n- Поля ответа: `статус` (`success`), `status_text` (`Mailing has been sent for moderation` или `Mailing has been sent`), `error`.\n- Возможные значения ошибок (`error` / `status_text`): `Mailing has been sent` (рассылка отправлена); `Mailing is delivered` (рассылка доставлена); `Mailing has an invalid status for sending` (невалидный статус для отправки); `Mailing subject is empty` (тема пустая); `Change default subject name` (дефолтная тема); `Mailing content is empty` (контент пустой); `Sender email not verified` (email отправителя не верифицирован); `Must define unsubscribe link in mailing content` (нет ссылки на отписку); `Not activate tariff` (тариф не активирован); `Tariff limit exceeded` (превышен тарифный лимит); `Parameters 'chunk_size' and 'chunk_timeout' require 'is_chunked=True'`.\n- Возможные ошибки уровня запроса: `invalid http method` (метод не POST); `invalid post values` (не задана обязательная переменная); `invalid api key` (неправильный апи-ключ).\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "mailing", "send", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"public_id\": 155959878052,\n \"datetime_send\": \"16.02.2024 17:00\",\n \"is_chunked\": true,\n \"chunk_size\": 5000,\n \"chunk_timeout\": 30\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9feb7e61-3bb4-4e6c-88b7-ab3b4af03a58", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v2", "mailing", "send", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"public_id\": 155959878052,\n \"datetime_send\": \"16.02.2024 17:00\",\n \"is_chunked\": true,\n \"chunk_size\": 5000,\n \"chunk_timeout\": 30\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"статус\": \"success\",\n \"status_text\": \"Mailing has been sent for moderation\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f5d1e03b-3c4e-4dea-8f7e-44f85b5e298d", "name": "Получение информации о рассылке", "request": { "name": "Получение информации о рассылке", "description": { "content": "Возвращает подробную информацию о конкретной рассылке.\n\n**Эндпоинт:** `GET https://mailganer.com/api/v2/mailing/:public_id`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n\n### Path-параметры\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `public_id` | int | ✔ | ID рассылки |\n\n### Пример curl\n```bash\ncurl --location 'https://mailganer.com/api/v2/mailing/166775985258' \\\n--header 'Authorization: CodeRequest {{api_key}}'\n```\n\n### Примечания\nПоля ответа (json):\n- `public_id` (int) — ID рассылки\n- `datetime_send` (string) — время отправки (datetime)\n- `send` (string) — время отправки\n- `name` (string) — название рассылки\n- `subject` (string) — тема рассылки\n- `subject2` (string) — вторая тема рассылки (актуально для А/Б-тестов)\n- `segment_name` (string) — название сегмента\n- `segment_id` (int) — ID сегмента\n- `from_name` (string) — имя отправителя\n- `from_email` (string) — имейл отправителя\n- `utm_campaign` (string) — значение URL-параметра utm_campaign\n- `utm_source` (string) — значение URL-параметра utm_source\n- `utm_medium` (string) — значение URL-параметра utm_medium\n- `text` (string) — HTML-контент письма в виде строки\n- `count_spam` (int) — количество жалоб на спам\n- `count_unsubscribe` (int) — количество отписок\n- `count_click` (int) — количество кликов\n- `count_open` (int) — количество открытий\n- `count_delivery` (int) — количество доставленных писем\n- `count_sent` (int) — количество отправленных писем\n- `webversion` (string) — ссылка на вебверсию письма\n- `user_utms` (array) — пользовательские переменные\n- `preheader` (string) — прехедер письма\n- `clickmap` (string) — ссылка на карту кликов\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "mailing", ":public_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "in culpa sint", "key": "public_id", "description": "(Required) public_id рассылки вы можете увидеть в личном кабинете, открыв эту рассылку в браузере" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6df7b3ee-d69e-4ef7-8170-b9d981f780e2", "name": "Получение информации о рассылке", "originalRequest": { "url": { "path": [ "api", "v2", "mailing", ":public_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "in culpa sint", "key": "public_id", "description": "(Required) public_id рассылки вы можете увидеть в личном кабинете, открыв эту рассылку в браузере" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"public_id\": 166775985258,\n \"datetime_send\": \"07.11.2022 03:37\",\n \"send\": \"2022-11-07T03:37:02.141548\",\n \"name\": \"Mailing Name\",\n \"subject\": \"Email subject\",\n \"segment_name\": \"Segment Name\",\n \"segment_id\": 7502,\n \"from_name\": \"Sender Name\",\n \"from_email\": \"info@mailganer.com\",\n \"utm_campaign\": \"166775985258\",\n \"utm_source\": \"mailganer\",\n \"utm_medium\": \"email\",\n \"text\": \"HTML Content\",\n \"count_spam\": 1,\n \"count_unsubscribe\": 14,\n \"count_click\": 448,\n \"count_open\": 1489,\n \"count_delivery\": 13348,\n \"webversion\": \"https://click.mailganer.com/webversion/166775985258/\",\n \"user_utms\": {\n \"custom_param_1\": \"{{custom_param_1}}\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df58ee76-da56-42ee-b2a2-98f440b3f138", "name": "Получить список рассылок", "request": { "name": "Получить список рассылок", "description": { "content": "Возвращает список рассылок за указанный период.\n\n**Эндпоинт:** `GET https://mailganer.com/api/v2/mailing/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n\n### Query-параметры\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `start_date` | date | | Дата начала периода, за который возвращать список рассылок |\n| `end_date` | date | | Дата окончания периода, за который возвращать список рассылок |\n\n### Пример curl\n```bash\ncurl --location 'https://mailganer.com/api/v2/mailing/?start_date=2024-04-01&end_date=2024-04-13' \\\n--header 'Authorization: CodeRequest {{api_key}}'\n```\n\n### Примечания\nПоля ответа (json):\n- `count` (int) — количество пользователей\n- `next` (url) — ссылка на следующую страницу\n- `previous` (url) — ссылка на предыдущую страницу\n- `results` (json-массив) — список рассылок\n\nСодержимое массива `results`:\n- `datetime_send` (дата и время) — планируемое время отправки\n- `send` (дата и время) — время начала отправки\n- `count_sent` (int) — получателей в рассылке\n- `count_delivery` (int) — доставленных писем\n- `count_spam` (int) — жалоб на спам\n- `count_unsubscribe` (int) — отписались\n- `count_click` (int) — кликнули в рассылке\n- `count_open` (int) — открыли\n- `public_id` (int) — ID рассылки\n- `Created` (дата и время) — дата создания рассылки\n- `name` (string) — название рассылки\n- `subject` (string) — тема рассылки\n- `subject2` (string) — вторая тема рассылки\n- `preheader` (string) — прехедер\n- `segment_name` (string) — название сегмента\n- `segment_id` (int) — ID сегмента\n- `excluding_segments` (int) — ID исключающего сегмента\n- `from_name` (string) — имя отправителя\n- `from_email` (string) — email отправителя\n- `text` — HTML-код верстки письма\n- `webversion` (url) — веб-версия письма\n- `clickmap` (url) — карта кликов\n- `status_str` (string) — статус рассылки\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "mailing", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "start_date", "value": "2024-04-01", "description": "Дата начала периода, за который возвращать список рассылок" }, { "disabled": false, "key": "end_date", "value": "2024-04-13", "description": "Дата окончания периода, за который возвращать список рассылок" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9ee79430-3a73-4f82-b51c-d11a33d2dfb4", "name": "Ошибка", "originalRequest": { "url": { "path": [ "api", "v2", "mailing", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start_date", "value": "2024-04-01" }, { "key": "end_date", "value": "2024-04-13" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "key": "Server", "value": "nginx/1.16.1", "description": "" }, { "disabled": false, "key": "Date", "value": "Thu, 03 Aug 2023 16:14:45 GMT", "description": "" }, { "disabled": false, "key": "Transfer-Encoding", "value": "chunked", "description": "" }, { "disabled": false, "key": "Connection", "value": "close", "description": "" }, { "disabled": false, "key": "Content-Language", "value": "ru", "description": "" }, { "disabled": false, "key": "Vary", "value": "Accept, Accept-Language, Cookie, Origin", "description": "" }, { "disabled": false, "key": "Allow", "value": "GET, HEAD, OPTIONS", "description": "" }, { "disabled": false, "key": "X-Frame-Options", "value": "SAMEORIGIN", "description": "" }, { "disabled": false, "key": "WWW-Authenticate", "value": "CodeRequest", "description": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"error\": \"Учетные данные не были предоставлены.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "070dfaae-6bc8-4400-b6bd-81a75931a0af", "name": "Статистика по рассылке", "request": { "name": "Статистика по рассылке", "description": { "content": "Возвращает статистику по рассылке — в разрезе дней и суммарно за период.\n\n**Эндпоинт:** `GET https://mailganer.com/api/v2/mailing/:public_id/stat/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n\n### Path-параметры\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `public_id` | int | ✔ | ID рассылки |\n\n### Query-параметры\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `start_date` | string | | Дата начала в формате `YYYY-MM-DD` |\n| `end_date` | string | | Дата конца в формате `YYYY-MM-DD` |\n\n### Пример curl\n```bash\ncurl --location 'https://mailganer.com/api/v2/mailing/459562475965/stat/?start_date=2023-12-11&end_date=2023-12-13' \\\n--header 'Authorization: CodeRequest {{api_key}}'\n```\n\n### Примечания\n- Если параметры не указаны — возвращается общая статистика по рассылке за каждый день, а также суммарная статистика за весь период.\n- Если один из параметров `start_date`/`end_date` не указан — возвращается общая статистика за каждый день плюс суммарная за весь период.\n- Если указаны обе даты — возвращаются данные за указанный период (включая последний день) в разрезе дней плюс суммарная за период статистика.\n\nПоля ответа (json):\n- `count_sent` — отправлено\n- `count_delivery` — доставлено\n- `count_spam` — пожаловались на спам\n- `count_unsubscribe` — отписались\n- `count_click` — кликнули\n- `count_open` — открыли\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "mailing", ":public_id", "stat", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "start_date", "value": "2023-12-11", "description": "Дата начала в формате YYYY-MM-DD" }, { "disabled": false, "key": "end_date", "value": "2023-12-13", "description": "Дата конца в формате YYYY-MM-DD" } ], "variable": [ { "disabled": false, "type": "any", "value": "in culpa sint", "key": "public_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9507c1a9-1305-4425-af96-79f356eef215", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v2", "mailing", ":public_id", "stat", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start_date", "value": "2023-12-11" }, { "key": "end_date", "value": "2023-12-13" } ], "variable": [ { "disabled": false, "type": "any", "value": "in culpa sint", "key": "public_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"2024-06-14\": {\n \"count_sent\": 4907,\n \"count_delivery\": 3683,\n \"count_spam\": 0,\n \"count_unsubscribe\": 0,\n \"count_click\": 0,\n \"count_open\": 0\n }\n },\n {\n \"2024-06-15\": {\n \"count_sent\": 4907,\n \"count_delivery\": 3683,\n \"count_spam\": 0,\n \"count_unsubscribe\": 0,\n \"count_click\": 0,\n \"count_open\": 0\n }\n },\n {\n \"2024-06-16\": {\n \"count_sent\": 4907,\n \"count_delivery\": 3683,\n \"count_spam\": 0,\n \"count_unsubscribe\": 0,\n \"count_click\": 0,\n \"count_open\": 0\n }\n },\n {\n \"2024-06-17\": {\n \"count_sent\": 4907,\n \"count_delivery\": 3683,\n \"count_spam\": 0,\n \"count_unsubscribe\": 0,\n \"count_click\": 0,\n \"count_open\": 0\n }\n },\n {\n \"2024-06-18\": {\n \"count_sent\": 4907,\n \"count_delivery\": 3683,\n \"count_spam\": 0,\n \"count_unsubscribe\": 0,\n \"count_click\": 0,\n \"count_open\": 0\n }\n },\n {\n \"summary\": {\n \"count_sent\": 4907,\n \"count_delivery\": 3683,\n \"count_spam\": 0,\n \"count_unsubscribe\": 1,\n \"count_click\": 47,\n \"count_open\": 265\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a900fd11-e0a1-4524-8d02-64b35e50007c", "name": "Триггеры", "description": { "content": "Триггерные механики, их отправка и статистика", "type": "text/plain" }, "item": [ { "id": "15922f24-20ed-4d36-a3f7-deeb69e4f04c", "name": "Отправка триггера", "request": { "name": "Отправка триггера", "description": { "content": "Отправляет триггерное письмо (или SMS) конкретному подписчику по его имейлу.\n\n**Эндпоинт:** `POST https://mailganer.com/api/v2/triggers/:trigger_id/send/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n**Content-Type:** `application/json`\n\n### Path-параметры\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `trigger_id` | int | Да | ID триггера |\n\n### Тело запроса\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `email` | string | Да | Имейл получателя |\n| `phone` | string | Нет | Телефон получателя (для SMS-триггера) |\n| `trigger_content` | string | Нет | Своё содержимое письма (UTF-8), переопределяет контент из кабинета |\n| `trigger_theme` | string | Нет | Своя тема письма (UTF-8), переопределяет тему из кабинета |\n| `ignore_wait` | bool | Нет | Отправить, несмотря на статус «ожидает подтверждения» |\n| `ignore_unsubscribed` | bool | Нет | Отправить, несмотря на статус «отписан» |\n| `ignore_spam` | bool | Нет | Отправить, несмотря на жалобу на спам |\n| `doi_ok` | bool | Нет | Добавить подписчика как «Активный» перед отправкой |\n| `send_now` | bool | Нет | Игнорировать настройку отложенной отправки |\n| `variables` | array/object | Нет | Переменные шаблона письма (одномерные и многомерные массивы) |\n| `update_variables` | bool | Нет | Обновить переменные подписчика (требует активации) |\n| `sender_email` | string | Нет | Свой адрес отправителя (требует `sender_name`) |\n| `sender_name` | string | Нет | Имя отправителя в поле From |\n\n### Пример curl\n```bash\ncurl --location 'https://mailganer.com/api/v2/triggers/1111/send/' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"email\": \"test@example.com\"\n}'\n```\n\n### Примечания\n- Рекомендуемая частота вызовов — **не более 300 в минуту**.\n- `variables` поддерживает одномерные и многомерные массивы; язык шаблонов — Django-подобный синтаксис с операторами `{% for %}`, `{% if %}`.\n- Нельзя размещать `{% for %}` или `{% if %}` между тегами `` и `
`.\n- `sender_email` принимается только если отправитель существует в аккаунте и подтверждён (верифицирован).\n- По умолчанию `doi_ok`, `ignore_unsubscribed`, `ignore_spam`, `update_variables` отключены — активация через поддержку.\n- Ответ: `status` (1 — отправлено, -1 — ошибка, 0 — системная ошибка), `status_text` (`success`/`error`), `result` (уникальный ID отправки для запроса статистики), `error` (описание ошибки).\n- Возможные ошибки: `Invalid post values` (нет обязательного параметра), `Invalid email value` (некорректный имейл), `Error api key` (неверный ключ), `Not activate tariff` (тариф не активен), `Tariff limit exceeded` (исчерпан лимит), `Not found trigger api call` (у триггера нет события API), `Sender email is not activated` (отправитель не подтверждён), `Trigger not active` (триггер отключён), `Not in condition for` (подписчик не проходит условия).\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "triggers", ":trigger_id", "send", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "trigger_id", "description": "(Required) ID триггера" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"email\": \"test@example.com\",\n \"doi_ok\": true,\n \"ignore_unsubscribed\": true,\n \"ignore_spam\": true,\n \"sender_name\": \"Mailganer\",\n \"sender_email\": \"info@mailganer.com\",\n \"variables\": {\n \"order_id\": 1234,\n \"first_name\": \"Test\",\n \"delivery_address\": \"Москва, Красная площадь, Кремль\",\n \"goods\": [\n {\n \"link\": \"https://domain.ru/products/11021\",\n \"title\": \"Туфли1\",\n \"cost\": \"39500\"\n },\n {\n \"link\": \"https://domain.ru/products/11022\",\n \"title\": \"Туфли2\",\n \"cost\": \"39500\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "eb366125-2396-4550-8efe-01ea16d6219c", "name": "Успешная отправка", "originalRequest": { "url": { "path": [ "api", "v2", "triggers", ":trigger_id", "send", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "trigger_id", "description": "(Required) ID триггера" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"test@example.com\",\n \"doi_ok\": true,\n \"ignore_unsubscribed\": true,\n \"ignore_spam\": true,\n \"sender_name\": \"Mailganer\",\n \"sender_email\": \"info@mailganer.com\",\n \"variables\": {\n \"order_id\": 1234,\n \"first_name\": \"Test\",\n \"delivery_address\": \"Москва, Красная площадь, Кремль\",\n \"goods\": [\n {\n \"link\": \"https://domain.ru/products/11021\",\n \"title\": \"Туфли1\",\n \"cost\": \"39500\"\n },\n {\n \"link\": \"https://domain.ru/products/11022\",\n \"title\": \"Туфли2\",\n \"cost\": \"39500\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 1,\n \"updated_variables\": [],\n \"status_text\": \"Success. Complete on 0.453127 sec.\",\n \"result\": 191015674\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c64bc0a8-d600-4d63-a9e9-72746d0d21db", "name": "Статистика триггера", "request": { "name": "Статистика триггера", "description": { "content": "Возвращает статистику по триггеру: суммарную или в разрезе дней за период.\n\n**Эндпоинт:** `GET https://mailganer.com/api/v2/triggers/:trigger_id/stat/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n\n### Path-параметры\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `trigger_id` | int | Да | ID триггера |\n\n### Query-параметры\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `start_date` | string | Нет | Дата начала в формате `YYYY-MM-DD` |\n| `end_date` | string | Нет | Дата конца в формате `YYYY-MM-DD` |\n\n### Пример curl\n```bash\ncurl --location 'https://mailganer.com/api/v2/triggers/1111/stat/?start_date=2022-08-01&end_date=2023-08-03' \\\n--header 'Authorization: CodeRequest {{api_key}}'\n```\n\n### Примечания\n- Без параметров дат — возвращается суммарная статистика по триггеру (объект `summary`).\n- Если передан только один из параметров (`start_date` или `end_date`) — также возвращается суммарная статистика.\n- Если переданы оба параметра — данные за указанный период (включая последний день) в разрезе дней плюс блок `summary`.\n- Поля статистики: `delivered` (доставлено), `clicked` (клики), `opened` (открытия), `not_available` (недоступно), `unsubscribed` (отписки), `spammed` (жалобы на спам), `sent` (отправлено).\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "triggers", ":trigger_id", "stat", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "start_date", "value": "2022-08-01", "description": "Дата начала в формате YYYY-MM-DD" }, { "disabled": false, "key": "end_date", "value": "2023-08-03", "description": "Дата конца в формате YYYY-MM-DD" } ], "variable": [ { "disabled": false, "type": "any", "value": "1111", "key": "trigger_id", "description": "(Required) ID триггера" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4d441519-edb5-4440-a4ab-9f8bc890bc87", "name": "С датой", "originalRequest": { "url": { "path": [ "api", "v2", "triggers", ":trigger_id", "stat", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start_date", "value": "2022-08-01" }, { "key": "end_date", "value": "2023-08-03" } ], "variable": [ { "disabled": false, "type": "any", "value": "1111", "key": "trigger_id", "description": "(Required) ID триггера" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"2023-08-01\": {\n \"delivered\": 338,\n \"clicked\": 13,\n \"opened\": 60,\n \"not_available\": 4,\n \"unsubscribed\": 1,\n \"spammed\": 0,\n \"sent\": 344\n },\n \"2023-08-02\": {\n \"delivered\": 315,\n \"clicked\": 12,\n \"opened\": 54,\n \"not_available\": 0,\n \"unsubscribed\": 2,\n \"spammed\": 0,\n \"sent\": 316\n },\n \"2023-08-03\": {\n \"delivered\": 369,\n \"clicked\": 13,\n \"opened\": 57,\n \"not_available\": 0,\n \"unsubscribed\": 0,\n \"spammed\": 0,\n \"sent\": 369\n },\n \"summary\": {\n \"delivered\": 1022,\n \"clicked\": 38,\n \"opened\": 171,\n \"not_available\": 4,\n \"unsubscribed\": 3,\n \"spammed\": 0,\n \"sent\": 1029\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19187e22-d3b3-474e-8fd2-6996a9e0ec3c", "name": "Ошибка авторизации", "originalRequest": { "url": { "path": [ "api", "v2", "triggers", ":trigger_id", "stat", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start_date", "value": "2022-08-01" }, { "key": "end_date", "value": "2023-08-03" } ], "variable": [ { "disabled": false, "type": "any", "value": "1111", "key": "trigger_id", "description": "(Required) ID триггера" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "key": "Server", "value": "nginx/1.16.1", "description": "" }, { "disabled": false, "key": "Date", "value": "Thu, 03 Aug 2023 11:46:30 GMT", "description": "" }, { "disabled": false, "key": "Transfer-Encoding", "value": "chunked", "description": "" }, { "disabled": false, "key": "Connection", "value": "close", "description": "" }, { "disabled": false, "key": "Content-Language", "value": "ru", "description": "" }, { "disabled": false, "key": "Vary", "value": "Accept, Accept-Language, Cookie, Origin", "description": "" }, { "disabled": false, "key": "Allow", "value": "POST, OPTIONS", "description": "" }, { "disabled": false, "key": "X-Frame-Options", "value": "SAMEORIGIN", "description": "" }, { "disabled": false, "key": "WWW-Authenticate", "value": "CodeRequest", "description": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"error\": \"Недопустимый токен.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30ab9c42-f59e-4890-a530-bb29f0acc852", "name": "Триггер не найден", "originalRequest": { "url": { "path": [ "api", "v2", "triggers", ":trigger_id", "stat", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start_date", "value": "2022-08-01" }, { "key": "end_date", "value": "2023-08-03" } ], "variable": [ { "disabled": false, "type": "any", "value": "1111", "key": "trigger_id", "description": "(Required) ID триггера" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "disabled": false, "key": "Server", "value": "nginx/1.16.1", "description": "" }, { "disabled": false, "key": "Date", "value": "Thu, 03 Aug 2023 11:47:29 GMT", "description": "" }, { "disabled": false, "key": "Transfer-Encoding", "value": "chunked", "description": "" }, { "disabled": false, "key": "Connection", "value": "close", "description": "" }, { "disabled": false, "key": "Vary", "value": "Accept, Accept-Language, Cookie, Origin", "description": "" }, { "disabled": false, "key": "X-Frame-Options", "value": "SAMEORIGIN", "description": "" }, { "disabled": false, "key": "Content-Language", "value": "ru", "description": "" }, { "disabled": false, "key": "Allow", "value": "GET, HEAD, OPTIONS", "description": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"error\": \"Не найдено.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b108a53b-a6cb-43d6-9f0e-0a2c76d8b502", "name": "Получение статистики по отправке триггера", "request": { "name": "Получение статистики по отправке триггера", "description": { "content": "Возвращает статусы доставки по списку ID отправок триггера (пакетно).\n\n**Эндпоинт:** `POST https://mailganer.com/api/v1/trigger/id_stat/`\n**Авторизация:** без авторизации (noauth); API-ключ передаётся в теле запроса в поле `api_key`\n**Content-Type:** `application/json`\n\n### Тело запроса\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `api_key` | string | Да | API-ключ (см. https://mailganer.com/app/profile/settings/api/) |\n| `id_list` | array | Да | Список ID отправок для пакетного получения статусов |\n\n### Пример curl\n```bash\ncurl --location 'https://mailganer.com/api/v1/trigger/id_stat/' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"api_key\": \"{{api_key}}\",\n \"id_list\": [123, 456]\n}'\n```\n\n### Примечания\n- Максимум **100 ID** в одном запросе.\n- Ответ: `status` (1 — успех, -1 — ошибка), `status_text` (`success`, `error` или `throttling`), `result` (массив статусов), `error` (описание ошибки, если есть).\n- Элемент `result`: `id` (ID отправки), `status` — одно из: `Доставлено`, `Не доставлено`, `Открыл`, `Кликнул`, `Пользователь считает спамом`.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "trigger", "id_stat", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"api_key\": \"{{api_key}}\",\n \"id_list\": [\n 123,\n 456\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "94b7b36d-f7bf-48fd-a945-6a6d68f2ab90", "name": "Успех", "originalRequest": { "url": { "path": [ "api", "v1", "trigger", "id_stat", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_key\": \"your_api_key\",\n \"id_list\": [\n 123,\n 456\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 1,\n \"status_text\": \"success\",\n \"result\": [\n {\n \"id\": \"123\",\n \"status\": \"Доставлено\"\n },\n {\n \"id\": \"456\",\n \"status\": \"Не доставлено\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "44194e71-2abe-4989-919c-1ca597ac4906", "name": "Получить список триггеров", "request": { "name": "Получить список триггеров", "description": { "content": "Возвращает список триггеров аккаунта (с пагинацией).\n\n**Эндпоинт:** `GET https://mailganer.com/api/v2/triggers/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n\n### Пример curl\n```bash\ncurl --location 'https://mailganer.com/api/v2/triggers/' \\\n--header 'Authorization: CodeRequest {{api_key}}'\n```\n\n### Примечания\n- Ответ постраничный: `count` (количество триггеров), `next` (ссылка на следующую страницу), `previous` (ссылка на предыдущую страницу), `results` (массив триггеров).\n- Элемент `results`: `id` (идентификатор триггера), `name` (название, может быть `null`), `sites` (списки, с которыми связан триггер).\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "triggers", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "3ba3556b-38a5-4735-ae69-ab6f0ef422cc", "name": "Список триггеров", "originalRequest": { "url": { "path": [ "api", "v2", "triggers", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 2,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 1,\n \"name\": \"Тестовый триггер\",\n \"sites\": [\n 32424,\n 1234,\n 13231\n ]\n },\n {\n \"id\": 4,\n \"name\": null,\n \"sites\": [\n 9199\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ae282226-298a-4386-aa17-4f566e1f6e1c", "name": "Получить информацию о триггере", "request": { "name": "Получить информацию о триггере", "description": { "content": "Возвращает подробную информацию (метаданные) о триггере.\n\n**Эндпоинт:** `GET https://mailganer.com/api/v2/triggers/:trigger_id/meta/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n\n### Path-параметры\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `trigger_id` | int | Да | ID триггера |\n\n### Пример curl\n```bash\ncurl --location 'https://mailganer.com/api/v2/triggers/1111/meta/' \\\n--header 'Authorization: CodeRequest {{api_key}}'\n```\n\n### Примечания\n- Возвращаемые поля: `name` (название, ≤250), `group` (группа, ≤250), `topic` (тема письма), `sites` (ID связанных списков), `sites_names` (названия списков), `event` (тип события, ≤100), `sender_name` (≤255), `sender_email` (≤255), `utm_campaign` / `utm_source` / `utm_medium` (≤150), `user_utms` (пользовательские UTM, ≤255), `webversion` (ссылка на веб-версию, ≤255), `html_code` (HTML-контент письма), `created` (дата создания, `DD.MM.YYYY HH:MM`), `first_letter_date` (дата первой отправки), `last_activate_date` (дата последней активации), `type` (канал: Email, SMS, Viber), `active` (статус активности True/False).\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "triggers", ":trigger_id", "meta", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "trigger_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "69effbea-57a2-401b-83cb-8fc6d92a81ef", "name": "Успешный ответ", "originalRequest": { "url": { "path": [ "api", "v2", "triggers", ":trigger_id", "meta", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "trigger_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "key": "Server", "value": "nginx/1.16.1", "description": "" }, { "disabled": false, "key": "Date", "value": "Wed, 28 Feb 2024 13:20:15 GMT", "description": "" }, { "disabled": false, "key": "Transfer-Encoding", "value": "chunked", "description": "" }, { "disabled": false, "key": "Connection", "value": "close", "description": "" }, { "disabled": false, "key": "Vary", "value": "Accept-Language, Cookie, Origin", "description": "" }, { "disabled": false, "key": "X-Frame-Options", "value": "SAMEORIGIN", "description": "" }, { "disabled": false, "key": "Content-Language", "value": "ru", "description": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"Trigger 1\",\n \"group\": null,\n \"topic\": \"Спасибо, что подписались на нас\",\n \"sites\": [\n 12345\n ],\n \"sites_names\": [\n \"mailganer.com\"\n ],\n \"event\": \"Подписчик подтвердил подписку\",\n \"sender_name\": \"Mailganer\",\n \"sender_email\": \"info@mailganer.com\",\n \"utm_campaign\": \"\",\n \"utm_source\": \"\",\n \"utm_medium\": \"\",\n \"user_utms\": \"custom_utm1=value1&custom_utm2=value2\",\n \"webversion\": \"https://mailganer.com/app/trigger/webversion/XXXXXXXXXXX/\",\n \"html_code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5df4150d-704f-4c28-972a-dbfb019ddfd4", "name": "Ошибка авторизации", "originalRequest": { "url": { "path": [ "api", "v2", "triggers", ":trigger_id", "meta", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "trigger_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "key": "Server", "value": "nginx/1.16.1", "description": "" }, { "disabled": false, "key": "Date", "value": "Wed, 28 Feb 2024 13:20:15 GMT", "description": "" }, { "disabled": false, "key": "Transfer-Encoding", "value": "chunked", "description": "" }, { "disabled": false, "key": "Connection", "value": "close", "description": "" }, { "disabled": false, "key": "Vary", "value": "Accept-Language, Cookie, Origin", "description": "" }, { "disabled": false, "key": "X-Frame-Options", "value": "SAMEORIGIN", "description": "" }, { "disabled": false, "key": "Content-Language", "value": "ru", "description": "" }, { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0e670887-8a15-4820-94d2-4e42c71c5106", "name": "Создание триггера", "request": { "name": "Создание триггера", "description": { "content": "Создаёт новый триггер в аккаунте.\n\n**Эндпоинт:** `POST https://mailganer.com/api/v2/triggers/create/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n**Content-Type:** `application/json`\n\n### Тело запроса\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `name` | string | Да* | Название триггера (≤250 символов) |\n| `theme` | string | Нет | Тема письма триггера (≤250 символов) |\n| `sites` | array | Нет | Список ID списков (сегментов) |\n| `html-content` | string | Нет | HTML-вёрстка письма триггера |\n| `zip-content` | string | Нет | Ссылка на архив с вёрсткой (.zip) |\n\n\\* В старой документации поле было необязательным, но без `name` API возвращает ошибку `400` «Это поле обязательно».\n\n### Пример curl\n```bash\ncurl --location 'https://mailganer.com/api/v2/triggers/create/' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"name\": \"Новый триггер\",\n \"theme\": \"Новый триггер\",\n \"sites\": [94321],\n \"html-content\": \"

Привет, это пример HTML-содержимого письма.

\",\n \"zip-content\": \"\"\n}'\n```\n\n### Примечания\n- При использовании `html-content` спецсимволы экранируются: `&`→`%26`, `\"`→`%22`, `\\`→`%27`, `<`→`%3C`, `>`→`%3E`.\n- Ответ: `status` (`1`/`success` или `invalid`), `status_text` (`success`/`invalid`), `trigger_id` (ID созданного триггера), `step1_url` (ссылка на страницу редактирования), `error` (объект с ошибками при `invalid`).\n- Возможные ошибки: неверный API-ключ; недопустимый HTTP-метод; неверная ссылка `zip-content`; архив недоступен; формат не `.zip`; превышен размер архива; в архиве нет HTML-шаблона; неподтверждённый адрес отправителя; несуществующий ID сегмента; превышение длины `name` (250) или `theme` (250).\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "triggers", "create", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Новый триггер\",\n \"theme\": \"Новый триггер\",\n \"sites\": [\n 94321\n ],\n \"html-content\": \"

Привет, это пример HTML-содержимого письма.

\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bc0e11ec-fbeb-49c4-adc8-5fec58165fab", "name": "Успешное создание", "originalRequest": { "url": { "path": [ "api", "v2", "triggers", "create", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Новый триггер\",\n \"theme\": \"Новый триггер\",\n \"sites\": [\n 94321\n ],\n \"html-content\": \"

Привет, это пример HTML-содержимого письма.

\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 1,\n \"step1_url\": \"https://mailganer.com/app/trigger/step1/53223/\",\n \"status_text\": \"success\",\n \"trigger_id\": 16434\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bdcf806-6e78-459a-a71d-e595e958af7d", "name": "Ошибка валидации", "originalRequest": { "url": { "path": [ "api", "v2", "triggers", "create", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Новый триггер\",\n \"theme\": \"Новый триггер\",\n \"sites\": [\n 94321\n ],\n \"html-content\": \"

Привет, это пример HTML-содержимого письма.

\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"invalid\",\n \"error\": {\n \"name\": [\n \"Это поле обязательно.\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f0f8c58b-6c6c-4de1-9d2f-914a0999121c", "name": "История имейлов по триггеру", "request": { "name": "История имейлов по триггеру", "description": { "content": "Возвращает историю отправленных имейлов по триггеру (с пагинацией).\n\n**Эндпоинт:** `GET https://mailganer.com/api/v2/triggers/:trigger_id/emails/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n\n### Path-параметры\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `trigger_id` | int | Да | ID триггера |\n\n### Query-параметры\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `start_date` | string | Нет | Дата начала в формате `YYYY-MM-DD` |\n| `end_date` | string | Нет | Дата конца в формате `YYYY-MM-DD` |\n\n### Пример curl\n```bash\ncurl --location 'https://mailganer.com/api/v2/triggers/1111/emails/?start_date=2024-08-01&end_date=2024-08-03' \\\n--header 'Authorization: CodeRequest {{api_key}}'\n```\n\n### Примечания\n- Без параметров дат — возвращаются все имейлы за всю историю.\n- Если передан только один из параметров дат — фильтр игнорируется, возвращаются все имейлы.\n- Оба параметра (`start_date` и `end_date`) должны передаваться вместе для фильтрации по периоду.\n- Ответ постраничный: `count` (всего имейлов), `next` (ссылка на следующую страницу), `previous` (ссылка на предыдущую страницу), `results` (массив имейлов).\n- Элемент `results`: `id` (ID отправки), `queue_date` (время постановки в очередь), `sended` (время отправки, `null` если не отправлено), `email` (имейл подписчика), `email_id` (идентификатор имейла), `mg_hash` (уникальный хэш подписчика), `source_id` (ID списка), `status` (0 — в очереди, 1 — отправлено, 2 — доставлено, -1 — отменено, -2 — не доставлено, -3 — отписался), `action` (действие: Не открыл / Открыл / Кликнул / Отписался).\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "triggers", ":trigger_id", "emails", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "start_date", "value": "2024-08-01", "description": "Дата начала в формате YYYY-MM-DD" }, { "disabled": false, "key": "end_date", "value": "2024-08-03", "description": "Дата конца в формате YYYY-MM-DD" } ], "variable": [ { "disabled": false, "type": "any", "value": "in culpa sint", "key": "trigger_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "211fae66-6362-4dd5-96f7-8035cde305f6", "name": "История имейлов", "originalRequest": { "url": { "path": [ "api", "v2", "triggers", ":trigger_id", "emails", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "start_date", "value": "2024-08-01" }, { "key": "end_date", "value": "2024-08-03" } ], "variable": [ { "disabled": false, "type": "any", "value": "in culpa sint", "key": "trigger_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 562458,\n \"next\": \"https://mailganer.com/api/v2/triggers/1111/emails/?end_date=2024-08-30&page=2&start_date=2024-08-01\",\n \"previous\": null,\n \"results\": [\n {\n \"id\": 213250918,\n \"queue_date\": \"2024-08-30T10:21:48.397765\",\n \"sended\": null,\n \"email\": \"example1@mail.com\",\n \"email_id\": \"1234567890\",\n \"mg_hash\": \"XXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"source_id\": \"12345\",\n \"status\": 0,\n \"action\": \"Не открыл\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4b36027c-d34f-4c6d-a302-8c6d4f55f1c7", "name": "Товарные рекомендации", "description": { "content": "Передача заказов и RFM-сегментов для товарных рекомендаций", "type": "text/plain" }, "item": [ { "id": "c6347b2e-3ac9-4b63-b0aa-efc0aaf2de12", "name": "Передача оформленных заказов", "request": { "name": "Передача оформленных заказов", "description": { "content": "Передаёт оформленные заказы в Mailganer для запуска триггеров с товарными рекомендациями.\n\n**Эндпоинт:** `POST https://mailganer.com/api/v1/recomend/orders/`\n**Авторизация:** без заголовка (noauth) — `api_key` передаётся в теле запроса (v1)\n**Content-Type:** `application/json`\n\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `api_key` | string | да | API-ключ (из настроек профиля) |\n| `source_id` | int | да | ID списка |\n| `orders` | array | да | Данные о заказах |\n| `orders[].id` | string | — | Номер заказа |\n| `orders[].status` | string | — | Статус заказа (например, «Новый») |\n| `orders[].channel` | string | — | Канал заказа (website / app / callcenter / offline) |\n| `orders[].date` | string | — | Дата заказа, Unix-timestamp |\n| `orders[].email` | string | — | Имейл покупателя |\n| `orders[].value.total` | float | — | Сумма заказа |\n| `orders[].items` | array | — | Товары заказа |\n| `orders[].items[].id` | int | — | ID товара |\n| `orders[].items[].price` | float | — | Цена товара |\n| `orders[].items[].quantity` | float | — | Количество |\n| `orders[].items[].categories` | array | — | ID категорий товара |\n\n### Поля ответа\n| Поле | Тип | Описание |\n|---|---|---|\n| `status` | int | `1` — триггер отправлен, `-1` — ошибка |\n| `status_text` | string | `success` или `error` |\n| `error` | string | Описание ошибки (при наличии) |\n\n### Пример curl\n```bash\ncurl --location --request POST 'https://mailganer.com/api/v1/recomend/orders/' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"api_key\": \"XXX\",\n \"source_id\": \"50883\",\n \"orders\": [\n {\n \"id\": \"12345\",\n \"status\": \"Новый\",\n \"channel\": \"domain.com\",\n \"date\": \"1619155834\",\n \"email\": \"email@domain.com\",\n \"value\": { \"total\": 0.0 },\n \"items\": [\n { \"id\": 0, \"price\": 0.0, \"quantity\": 0.0, \"categories\": [1, 2, 3] }\n ]\n }\n ]\n}'\n```\n\n### Примечания\n- Метод **v1**: авторизация не через заголовок — `api_key` передаётся в теле запроса.\n- Ответ: `status` = `1` (триггер отправлен) или `-1` (ошибка); `status_text` = `success` / `error`; при ошибке добавляется поле `error`.\n- Вёрстка письма-триггера с блоком рекомендаций описана в отдельной инструкции (см. «Триггеры с товарными рекомендациями»).\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "recomend", "orders", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"api_key\": \"{{api_key}}\",\n \"source_id\": \"50883\",\n \"orders\": [\n {\n \"id\": \"12345\",\n \"status\": \"Новый\",\n \"channel\": \"website\",\n \"date\": \"1619155834\",\n \"email\": \"email@domain.com\",\n \"value\": {\n \"total\": 1500\n },\n \"items\": [\n {\n \"id\": 101,\n \"price\": 1500,\n \"quantity\": 1,\n \"categories\": [\n 1,\n 2\n ]\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cad5a947-c467-4b87-a186-364e073a9d12", "name": "Success — триггер отправлен", "originalRequest": { "url": { "path": [ "api", "v1", "recomend", "orders", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"api_key\": \"your_api_key\",\n \"source_id\": \"50883\",\n \"orders\": [\n {\n \"id\": \"12345\",\n \"status\": \"Новый\",\n \"channel\": \"website\",\n \"date\": \"1619155834\",\n \"email\": \"email@domain.com\",\n \"value\": {\n \"total\": 1500\n },\n \"items\": [\n {\n \"id\": 101,\n \"price\": 1500,\n \"quantity\": 1,\n \"categories\": [\n 1,\n 2\n ]\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 1,\n \"status_text\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9ceb8c0f-fe6c-4857-946e-8783adbb4592", "name": "Триггеры с товарными рекомендациями", "request": { "name": "Триггеры с товарными рекомендациями", "description": { "content": "Инструкция по подготовке вёрстки письма-триггера с блоком товарных рекомендаций.\n\n**Эндпоинт:** отдельного HTTP-эндпоинта у этой страницы нет — это руководство по вёрстке. Данные о заказах/покупках передаются методами «Передача оформленных заказов» (`POST https://mailganer.com/api/v1/recomend/orders/`) и «Передача RFM-сегмента» (`POST https://mailganer.com/api/v2/recomend/orders/`); данная страница описывает, как сверстать HTML-шаблон, в который движок подставит товары. URL запроса указывает на саму страницу документации.\n**Авторизация:** —\n\n### Переменные товара (`product`)\n| Переменная | Описание |\n|---|---|\n| `{{ product.id }}` | ID товара |\n| `{{ product.name }}` | Название |\n| `{{ product.description }}` | Описание |\n| `{{ product.barcode }}` | Штрихкод |\n| `{{ product.price }}` | Цена (формат «10 500») |\n| `{{ product.oldprice }}` | Старая цена (до скидки) |\n| `{{ product.currency }}` | Валюта |\n| `{{ product.url }}` | Ссылка на товар |\n| `{{ product.image_url }}` | Ссылка на изображение |\n| `{{ product.brand }}` | Бренд |\n| `{{ product.amount }}` | Количество |\n\n### Массивы и служебные переменные цикла\n| Переменная | Описание |\n|---|---|\n| `s_products` | Товары-источники (причина рекомендации, например из корзины / просмотренные) |\n| `r_products` | Рекомендованные товары |\n| `{{ forloop.first }}` | Первая итерация цикла |\n| `{{ forloop.last }}` | Последняя итерация цикла |\n| `{{ forloop.counter }}` | Номер текущей итерации |\n\n### Пример вёрстки\n```html\n\n \n ...\n

Товары в корзине

\n\n {% for product in s_products %}\n
\n

\n

{{ product.name }}, {{ product.amount }} шт., {{ product.price }} руб.

\n
\n {% endfor %}\n\n

Рекомендуем посмотреть

\n\n {% for product in r_products %}\n
\n

\n

{{ product.name }}, {{ product.price }} руб.

\n
\n {% endfor %}\n ...\n \n\n```\n\n### Примечания\n- **Важно:** не вставляйте операторы `{% for %}` или `{% if %}` между тегами `` и `
` — иначе операторы автоматически переносятся перед `` и вёрстка ломается.\n- Нужны два цикла: один — по товарам-причинам рекомендации (`s_products`), второй — по рекомендованным товарам (`r_products`).\n- Условный вывод (например, старой цены) — через `{% if product.oldprice %}...{% endif %}`.\n", "type": "text/plain" }, "url": { "path": [ "documentation", "recomend-layout-guide" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0d769f65-40d6-425a-a688-c17aca132cef", "name": "Передача RFM-сегмента", "request": { "name": "Передача RFM-сегмента", "description": { "content": "Передаёт данные о покупках для расчёта RFM-сегмента подписчиков.\n\n**Эндпоинт:** `POST https://mailganer.com/api/v2/recomend/orders/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n**Content-Type:** `application/json`\n\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `source_id` | int | да | ID списка |\n| `orders` | array | да | Данные о заказах |\n| `orders[].product_id` | string | да | Номер заказа |\n| `orders[].date` | date | да | Дата покупки (формат `ДД.ММ.ГГГГ`) |\n| `orders[].email` | string | да | Имейл покупателя |\n| `orders[].amount` | int | да | Стоимость покупки |\n\n### Пример curl\n```bash\ncurl --location --request POST 'https://mailganer.com/api/v2/recomend/orders/' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"source_id\": \"9345100\",\n \"orders\": [\n {\n \"product_id\": \"35463453\",\n \"date\": \"01.03.2024\",\n \"email\": \"test@gmail.com\",\n \"amount\": 4564\n }\n ]\n}'\n```\n\n### Примечания\n- Метод **v2**: авторизация через заголовок `Authorization: CodeRequest {{api_key}}`.\n- `api_key` в теле запроса **не передаётся** (в отличие от v1-метода «Передача оформленных заказов»).\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "recomend", "orders", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"source_id\": 9345100,\n \"orders\": [\n {\n \"product_id\": \"35463453\",\n \"date\": \"01.03.2024\",\n \"email\": \"test@example.com\",\n \"amount\": 4564\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9d1df093-8aae-4f99-8507-9b7211effc7a", "name": "Не переданы заказы", "originalRequest": { "url": { "path": [ "api", "v2", "recomend", "orders", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source_id\": 9345100,\n \"orders\": [\n {\n \"product_id\": \"35463453\",\n \"date\": \"01.03.2024\",\n \"email\": \"test@example.com\",\n \"amount\": 4564\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": -1,\n \"status_text\": \"error\",\n \"error\": \"Orders blank\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d19af48-627a-4d12-84cd-e12565a9a8c3", "name": "Ключ API не передан или неверен", "originalRequest": { "url": { "path": [ "api", "v2", "recomend", "orders", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source_id\": 9345100,\n \"orders\": [\n {\n \"product_id\": \"35463453\",\n \"date\": \"01.03.2024\",\n \"email\": \"test@example.com\",\n \"amount\": 4564\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b40f35fd-da84-4836-ac05-d10b8cae6cfc", "name": "Данные о заказах приняты", "originalRequest": { "url": { "path": [ "api", "v2", "recomend", "orders", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source_id\": 9345100,\n \"orders\": [\n {\n \"product_id\": \"35463453\",\n \"date\": \"01.03.2024\",\n \"email\": \"test@example.com\",\n \"amount\": 4564\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "3f36ad10-102e-452a-a2a9-715e53115637", "name": "Пользователи", "description": { "content": "Управление пользователями аккаунта и балансом", "type": "text/plain" }, "item": [ { "id": "95986431-bece-4d3a-99d6-8f563a584dfb", "name": "Создать пользователя", "request": { "name": "Создать пользователя", "description": { "content": "Создаёт нового пользователя (личный кабинет) в системе Mailganer.\n\n**Эндпоинт:** `POST https://mailganer.com/api/v2/users/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n**Content-Type:** `application/json`\n\n### Параметры запроса\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `first_name` | string | да | Имя пользователя |\n| `email` | string | да | Имейл пользователя |\n| `phone` | string | нет | Телефон |\n\n### Параметры ответа\n| Поле | Тип | Описание |\n|---|---|---|\n| `id` | integer | ID пользователя |\n| `username` | string | Логин для авторизации |\n| `fullname` | string | Полное имя пользователя |\n| `email` | string | Имейл |\n| `phone` | string | Телефон |\n| `code_request` | string | Токен доступа к API |\n| `autologin` | string | Код автологина (авторизация на сайте) |\n\n### Пример curl\n```bash\ncurl --location --request POST 'https://mailganer.com/api/v2/users/' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"first_name\": \"Федор\",\n \"email\": \"test@example.com\",\n \"phone\": \"+79123456789\"\n}'\n```\n\n### Примечания\n- Данная группа методов по умолчанию отключена. Для получения доступа обратитесь на api@mailganer.com.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "users", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"first_name\": \"Федор\",\n \"email\": \"test@example.com\",\n \"phone\": \"+79123456789\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cebde8f5-7b44-449b-a7b5-5910ffac0638", "name": "Ключ API не передан или неверен", "originalRequest": { "url": { "path": [ "api", "v2", "users", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"Федор\",\n \"email\": \"test@example.com\",\n \"phone\": \"+79123456789\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9093e982-83fc-41b5-80b7-4fdb5cb46c32", "name": "Группа методов не включена для аккаунта", "originalRequest": { "url": { "path": [ "api", "v2", "users", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"Федор\",\n \"email\": \"test@example.com\",\n \"phone\": \"+79123456789\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"error\": \"У вас нет прав для выполнения этой операции.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6be9eed3-f7c8-4154-836f-637c994c0aa7", "name": "Пользователь создан", "originalRequest": { "url": { "path": [ "api", "v2", "users", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"Федор\",\n \"email\": \"test@example.com\",\n \"phone\": \"+79123456789\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": -10344089,\n \"username\": \"mollit consectetur\",\n \"avatar\": \"aliquip est adipisicing ullam\",\n \"fullname\": \"et ad incididunt consequat id\",\n \"email\": \"adipisicing exercitation sunt velit\",\n \"phone\": \"Ut magna quis dolore\",\n \"code_request\": \"eu dolor\",\n \"autologin\": \"Excepteur Ut in\",\n \"is_access_api_doi\": false,\n \"balance\": \"eiusmod proident nulla\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5a412eb0-f17c-438d-92f1-5603f21ad95d", "name": "Получить список пользователей", "request": { "name": "Получить список пользователей", "description": { "content": "Возвращает список пользователей.\n\n**Эндпоинт:** `GET https://mailganer.com/api/v2/users/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n\n### Пример curl\n```bash\ncurl --location --request GET 'https://mailganer.com/api/v2/users/' \\\n--header 'Authorization: CodeRequest {{api_key}}'\n```\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "users", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7388979a-e699-4ca1-af5c-a164e7f4c95e", "name": "Список пользователей", "originalRequest": { "url": { "path": [ "api", "v2", "users", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 21614,\n \"username\": \"client@example.com\",\n \"avatar\": \"https://secure.gravatar.com/avatar/00000000000000000000000000000000.jpg\",\n \"fullname\": \"Иван Петров\",\n \"email\": \"client@example.com\",\n \"phone\": \"79123456789\",\n \"code_request\": \"ваш_ключ_api\",\n \"autologin\": \"код_автологина\",\n \"is_access_api_doi\": false,\n \"balance\": \"0.0\",\n \"smtp_api_keys\": []\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6dd931a-d011-4a6e-9e07-7b319efebbda", "name": "Ключ API не передан или неверен", "originalRequest": { "url": { "path": [ "api", "v2", "users", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f0d3f142-2b15-4ab2-a0ba-8f2c15c2f336", "name": "Получить ссылку на пополнение баланса", "request": { "name": "Получить ссылку на пополнение баланса", "description": { "content": "Возвращает ссылку на оплату для пополнения баланса пользователя.\n\n**Эндпоинт:** `POST https://mailganer.com/api/v2/pay/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n**Content-Type:** `application/json`\n\n### Параметры запроса\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `id` | integer | да | ID пользователя |\n| `summ` | integer | да | Сумма пополнения |\n| `payment_type` | string | да | Тип оплаты: `card` или `invoice` |\n| `requisites` | array | нет | Реквизиты; обязателен при `payment_type=invoice` |\n\n#### Поля объекта `requisites` (при `payment_type=invoice`)\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `inn` | string | да | ИНН |\n| `bic` | string | да | БИК |\n| `rs` | string | да | Расчётный счёт |\n| `kpp` | string | да | КПП |\n| `name_org` | string | да | Название организации |\n| `address_org` | string | да | Адрес организации |\n\n### Параметры ответа\n| Поле | Тип | Описание |\n|---|---|---|\n| `url` | string | Ссылка на оплату |\n\n### Пример curl\n```bash\ncurl --location --request POST 'https://mailganer.com/api/v2/pay/' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"id\": 12345,\n \"summ\": 1000,\n \"payment_type\": \"card\"\n}'\n```\n\n### Примечания\n- Данная группа методов по умолчанию отключена. Для получения доступа обратитесь на api@mailganer.com.\n- Для оплаты по счёту (`payment_type=invoice`) необходимо передать массив `requisites` со всеми полями реквизитов.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "pay", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"summ\": 1000,\n \"payment_type\": \"card\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f5475972-d422-4f7e-9fff-aef2e95cdcf4", "name": "Оплата по счету", "originalRequest": { "url": { "path": [ "api", "v2", "pay", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"summ\": 1000,\n \"payment_type\": \"card\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"url\": \"https://mailganer.com/app/finance/invoices/print/hash\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa0e8389-28a6-47e6-b1ed-31a4d05de66e", "name": "Изменить пользователя", "request": { "name": "Изменить пользователя", "description": { "content": "Изменяет параметры пользователя по его ID.\n\n**Эндпоинт:** `PATCH https://mailganer.com/api/v2/users/:id/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n**Content-Type:** `application/json`\n\n### Path-параметры\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `id` | integer | да | ID пользователя |\n\n### Параметры запроса\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `is_access_api_doi` | boolean | нет | Флаг доступа к API DOI (поле присутствует в запросе) |\n\n### Пример curl\n```bash\ncurl --location --request PATCH 'https://mailganer.com/api/v2/users/:id/' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"is_access_api_doi\": true\n}'\n```\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "users", ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID пользователя" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"is_access_api_doi\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "35b16a0d-1749-4392-bd23-7a34f4221a72", "name": "Ключ API не передан или неверен", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID пользователя" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"is_access_api_doi\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "71bab1ed-1db9-432d-aec3-5bc59d1542a6", "name": "Пользователь обновлён", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID пользователя" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"is_access_api_doi\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "265248ac-5a50-45cc-9fd9-d10acf19d208", "name": "Получить информацию о пользователе", "request": { "name": "Получить информацию о пользователе", "description": { "content": "Возвращает информацию о пользователе по его ID.\n\n**Эндпоинт:** `GET https://mailganer.com/api/v2/users/:id/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n\n### Path-параметры\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `id` | integer | да | ID пользователя |\n\n### Пример curl\n```bash\ncurl --location --request GET 'https://mailganer.com/api/v2/users/:id/' \\\n--header 'Authorization: CodeRequest {{api_key}}'\n```\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "users", ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID пользователя" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "519fa72e-b988-4856-abcf-61cbf1546618", "name": "Пользователь", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID пользователя" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 21614,\n \"username\": \"client@example.com\",\n \"avatar\": \"https://secure.gravatar.com/avatar/00000000000000000000000000000000.jpg\",\n \"fullname\": \"Иван Петров\",\n \"email\": \"client@example.com\",\n \"phone\": \"79123456789\",\n \"code_request\": \"ваш_ключ_api\",\n \"autologin\": \"код_автологина\",\n \"is_access_api_doi\": false,\n \"balance\": \"0.0\",\n \"smtp_api_keys\": []\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbdd2a37-d65b-4b06-8b11-a60b9a88d079", "name": "Ключ API не передан или неверен", "originalRequest": { "url": { "path": [ "api", "v2", "users", ":id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID пользователя" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4c7979e3-ae25-4bc0-8885-bc4440bc5768", "name": "Получение токена другого пользователя", "request": { "name": "Получение токена другого пользователя", "description": { "content": "Возвращает API-токен и ID пользователя по логину и паролю (получение токена другого пользователя).\n\n**Эндпоинт:** `POST https://mailganer.com/api/auth/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n**Content-Type:** `application/json`\n\n### Параметры запроса\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `username` | string (email) | да | Логин (имейл) |\n| `password` | string | да | Пароль |\n\n### Параметры ответа\n| Поле | Тип | Описание |\n|---|---|---|\n| `api_key` | string | Токен доступа к API |\n| `id` | integer | ID пользователя |\n\n### Пример curl\n```bash\ncurl --location --request POST 'https://mailganer.com/api/auth/' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"username\": \"test@mailganer.com\",\n \"password\": \"cb61c634\"\n}'\n```\n\n### Примечания\n- Данная группа методов по умолчанию отключена. Для получения доступа обратитесь на api@mailganer.com.\n- Метод доступен по двум адресам: `POST https://mailganer.com/api/auth/` и `POST https://mailganer.com/api/v2/auth/`.\n", "type": "text/plain" }, "url": { "path": [ "api", "auth", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"username\": \"test@mailganer.com\",\n \"password\": \"cb61c634\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e03a4be6-6795-4b9e-95a9-066e5ebb54f2", "name": "Не переданы обязательные поля", "originalRequest": { "url": { "path": [ "api", "auth", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"username\": \"test@mailganer.com\",\n \"password\": \"cb61c634\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"invalid\",\n \"error\": {\n \"username\": [\n \"Это поле обязательно.\"\n ],\n \"password\": [\n \"Это поле обязательно.\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "280549ed-d5e6-41b4-a2ef-4e1a7af09be7", "name": "Ключ API не передан или неверен", "originalRequest": { "url": { "path": [ "api", "auth", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"username\": \"test@mailganer.com\",\n \"password\": \"cb61c634\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0740a77b-0562-4dad-89f0-be13015678e8", "name": "Токен пользователя", "originalRequest": { "url": { "path": [ "api", "auth", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"username\": \"test@mailganer.com\",\n \"password\": \"cb61c634\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"api_key\": \"minim ad consectetur\",\n \"id\": -78259893\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e5bee10c-654b-4fa0-b819-df9d5ccaa8d3", "name": "Получить баланс", "request": { "name": "Получить баланс", "description": { "content": "Возвращает баланс личного кабинета Mailganer.\n\n**Эндпоинт:** `GET https://mailganer.com/api/v2/users/get_balance/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n\n### Параметры запроса\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `api_key` | string | да | API-ключ от личного кабинета Mailganer |\n\n### Параметры ответа\n| Поле | Тип | Описание |\n|---|---|---|\n| `balance` | integer | Баланс личного кабинета |\n\n### Пример curl\n```bash\ncurl --location --request GET 'https://mailganer.com/api/v2/users/get_balance/' \\\n--header 'Authorization: CodeRequest 54654768d9897654456wergdd5' \\\n--form 'api_key=\"54654768d9897654456wergdd5\"'\n```\n\n### Примечания\n- Данная группа методов по умолчанию отключена. Для получения доступа обратитесь на api@mailganer.com.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "users", "get_balance", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "42af18f2-693f-4004-a11d-74c20955ad87", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v2", "users", "get_balance", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"balance\": 3457\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "456d268e-a811-4da5-93bc-b0f4efad5680", "name": "Шаблоны", "description": { "content": "Получение HTML-вёрстки шаблонов", "type": "text/plain" }, "item": [ { "id": "82be197b-c6fd-4cde-9adc-cb0750b1b7de", "name": "Создание шаблона", "request": { "name": "Создание шаблона", "description": { "content": "Создаёт HTML-шаблон письма в разделе «Шаблоны» личного кабинета. Вёрстка передаётся текстом, шаблон сразу доступен для редактирования в личном кабинете и для выбора при создании рассылки.\n\n**Эндпоинт:** `POST https://mailganer.com/api/v2/template/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n**Content-Type:** `application/json`\n\n### Параметры тела\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `name` | Строка | ✅ | Название шаблона, не больше 250 символов |\n| `html` | Строка | ✅ | HTML-вёрстка письма. Размер не больше максимального размера письма для аккаунта, по умолчанию 2048 Кб |\n| `group_id` | Число | — | ID группы шаблонов. Если не передан, шаблон создаётся без группы |\n\n### Пример curl\n```bash\ncurl --location 'https://mailganer.com/api/v2/template/' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--data-raw '{\n \"name\": \"Письмо о доставке\",\n \"html\": \"
Здравствуйте, {{ name }}!
Отписаться\",\n \"group_id\": 641\n}'\n```\n\n### Примечания\n- В ответе возвращается `template_id`. Его можно передать в метод создания рассылки в параметре `template_id`.\n- `edit_url` — ссылка на редактирование шаблона в личном кабинете.\n- Лимит: не больше 60 запросов в час на аккаунт.\n- Возможные ошибки:\n - `400 Bad Request` — не передано обязательное поле (`status: invalid`, в `error` перечислены поля).\n - `401 Unauthorized` — не предоставлен или неверный ключ API.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "template", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"Письмо о доставке\",\n \"html\": \"
Здравствуйте, {{ name }}!
Отписаться\",\n \"group_id\": 641\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8de11860-5da5-4395-9c90-120df81ab9b8", "name": "Шаблон создан", "originalRequest": { "url": { "path": [ "api", "v2", "template", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Письмо о доставке\",\n \"html\": \"
Здравствуйте, {{ name }}!
Отписаться\",\n \"group_id\": 641\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"template_id\": \"3e28f835-b2e6-43f1-9e82-f263a4a4a4fb\",\n \"edit_url\": \"https://mailganer.com/app/custom-template/3e28f835-b2e6-43f1-9e82-f263a4a4a4fb/\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3420a3e8-0a7d-4740-9a17-1148386e4ea9", "name": "Не переданы обязательные поля", "originalRequest": { "url": { "path": [ "api", "v2", "template", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Письмо о доставке\",\n \"html\": \"
Здравствуйте, {{ name }}!
Отписаться\",\n \"group_id\": 641\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"invalid\",\n \"error\": {\n \"html\": [\n \"Это поле обязательно.\"\n ],\n \"name\": [\n \"Это поле обязательно.\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6e8405f1-6b64-466f-810f-9a9073c3df58", "name": "Получение HTML-вёрстки шаблона", "request": { "name": "Получение HTML-вёрстки шаблона", "description": { "content": "Возвращает HTML-вёрстку шаблона по его ID.\n\n**Эндпоинт:** `GET https://mailganer.com/api/v2/template/:template_id/`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n\n### Параметры пути\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `template_id` | Строка (UID) | — | ID шаблона. Оставьте пустым, чтобы получить ID и названия всех шаблонов |\n\n### Пример curl\n```bash\ncurl --location 'https://mailganer.com/api/v2/template/4f848a39-136b-42e7-9ba8-e4b4a9dadbe2/' \\\n--header 'Authorization: CodeRequest {{api_key}}'\n```\n\n### Примечания\n- ID шаблона можно взять из URL при просмотре шаблона в разделе «Шаблоны» (https://mailganer.com/app/custom-templates/). Пример URL: `https://mailganer.com/app/custom-template/4f848a39-136b-42e7-9ba8-e4b4a9dadbe2/`, где `4f848a39-136b-42e7-9ba8-e4b4a9dadbe2` — искомый UID шаблона.\n- Успешный ответ (200) содержит поле `text` с HTML-вёрсткой шаблона.\n- Возможные ошибки:\n - `401 Unauthorized` — не предоставлен или неверный ключ API от личного кабинета.\n - `403 Forbidden` — у пользователя нет доступа к запрашиваемому шаблону.\n - `404 Not Found` — шаблон с указанным ID не найден.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "template", ":template_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "in culpa sint", "key": "template_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "74567a03-13d0-4c5f-95a0-7ac20be17f94", "name": "Успех (200)", "originalRequest": { "url": { "path": [ "api", "v2", "template", ":template_id", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "in culpa sint", "key": "template_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"text\": \"...\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "86f263ca-b3c8-4dac-999f-ab4ac389a41f", "name": "Отчёты", "description": { "content": "Формирование, статус и скачивание отчётов", "type": "text/plain" }, "item": [ { "id": "5ab128a5-1f76-4125-b0f0-98abb445b813", "name": "Создать задачу на формирование отчёта", "request": { "name": "Создать задачу на формирование отчёта", "description": { "content": "Запускает асинхронную задачу на формирование файла с данными аккаунта (выгрузка списка/сегмента или отчёт по рассылке).\n\n**Эндпоинт:** `POST https://mailganer.com/api/v2/tasks/emails_report`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n**Content-Type:** `application/json`\n\n### Параметры тела\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `file_type` | string | Да | Формат файла: `csv` или `xlsx` |\n| `site_id` | int | Нет* | ID списка — выгрузить всех подписчиков списка |\n| `segment_id` | int | Нет* | ID сегмента — выгрузить подписчиков сегмента |\n| `mailing_id` | int | Нет* | ID рассылки (требует `mailing_report_type`) |\n| `mailing_report_type` | string | Нет | Тип отчёта по рассылке: `general_mailing_report` — общий отчёт, `clicks` — отчёт по кликам |\n| `start_date` | string | Нет | Фильтр по дате от (дата создания подписчика), формат `YYYY-MM-DD` |\n| `end_date` | string | Нет | Фильтр по дате до (дата создания подписчика), формат `YYYY-MM-DD` |\n\n\\* Нужно передать ровно **одну** группу: `site_id`, `segment_id` или `mailing_id`.\n\n### Пример curl\n```bash\ncurl --location --request POST 'https://mailganer.com/api/v2/tasks/emails_report' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"mailing_id\": 177022020521,\n \"mailing_report_type\": \"general_mailing_report\",\n \"file_type\": \"csv\"\n}'\n```\n\n### Примечания\n- Метод запускает асинхронную задачу; в ответе возвращается `task_id`, `state` и `task_type`.\n- Параметры `site_id`, `segment_id` и `mailing_id` взаимоисключающие — их нельзя комбинировать (иначе ошибка `Request cannot contain parameters from different report types...`).\n- Для `mailing_id` обязателен `mailing_report_type` (иначе `mailing_id is required for mailing_report_type parameter`).\n- Фильтры по датам (`start_date`/`end_date`) применяются к дате создания подписчика; для отчётов по рассылке игнорируются.\n- Для использования метода в аккаунте должно быть включено ограничение доступа к API по IP-адресам (иначе `403`).\n- **Порядок работы с отчётами:** 1) создать задачу этим методом → получить `task_id`; 2) опрашивать статус `GET /api/v2/tasks/:task_id`, пока `state` не станет `COMPLETED`; 3) скачать файл `GET /api/v2/tasks/:task_id/download_file`.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "tasks", "emails_report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"mailing_id\": 177022020521,\n \"mailing_report_type\": \"general_mailing_report\",\n \"file_type\": \"csv\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "883f71df-aa24-4630-8b20-fdd129c61d6e", "name": "Success — задача создана", "originalRequest": { "url": { "path": [ "api", "v2", "tasks", "emails_report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mailing_id\": 177022020521,\n \"mailing_report_type\": \"general_mailing_report\",\n \"file_type\": \"csv\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"task_id\": \"c8549c22-21f9-467b-9c74-870c34523432a048b\",\n \"state\": \"IN_PROGRESS\",\n \"task_type\": \"DOWNLOAD_MAILING_REPORT\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e76e7d82-3a26-42c2-8bda-4c623ec5cf9d", "name": "Получение статуса задачи", "request": { "name": "Получение статуса задачи", "description": { "content": "Возвращает текущий статус задачи на формирование отчёта по её идентификатору.\n\n**Эндпоинт:** `GET https://mailganer.com/api/v2/tasks/:task_id`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n\n### Параметры пути\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `task_id` | string | Да | UUID задачи, полученный при её создании |\n\n### Пример curl\n```bash\ncurl --location --request GET 'https://mailganer.com/api/v2/tasks/:task_id' \\\n--header 'Authorization: CodeRequest {{api_key}}'\n```\n\n### Примечания\n- Поля ответа: `id` — UUID задачи; `state` — статус; `task_type` — тип отчёта (`DOWNLOAD_SITE_EMAILS`, `DOWNLOAD_SEGMENT`, `DOWNLOAD_MAILING_REPORT` и т.п.).\n- Значения `state`: `IN_PROGRESS` — выполняется; `COMPLETED` — успешно завершена, файл готов к скачиванию; `FAILED` — ошибка формирования.\n- Опрашивайте метод, пока `state` не станет `COMPLETED`, затем скачайте файл через `GET /api/v2/tasks/:task_id/download_file`.\n- Если задача не найдена — ответ с ошибкой `Task by id=... not found`.\n- Для использования метода в аккаунте должно быть включено ограничение доступа к API по IP-адресам (иначе `403`).\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "in culpa sint", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5140548e-eec1-4aca-b820-abb1c7911d34", "name": "Success — выполняется", "originalRequest": { "url": { "path": [ "api", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "in culpa sint", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a39929f4-dac8-4f5d-8d02-82c945623856\",\n \"state\": \"IN_PROGRESS\",\n \"task_type\": \"DOWNLOAD_MAILING_REPORT\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bace4799-47bf-41a2-be41-927dec878cf3", "name": "Error — задача не найдена", "originalRequest": { "url": { "path": [ "api", "v2", "tasks", ":task_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "in culpa sint", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"error\": \"Task by id=8959d954-9baf-4491-a1b3-46adf787c064 not found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bc4e40e3-f716-41d7-b102-99548d47997f", "name": "Скачивание готового файла", "request": { "name": "Скачивание готового файла", "description": { "content": "Скачивает готовый файл отчёта по завершённой задаче.\n\n**Эндпоинт:** `GET https://mailganer.com/api/v2/tasks/:task_id/download_file`\n**Авторизация:** заголовок `Authorization: CodeRequest {{api_key}}`\n\n### Параметры пути\n| Поле | Тип | Обяз. | Описание |\n|---|---|---|---|\n| `task_id` | string | Да | UUID задачи, полученный при её создании |\n\n### Пример curl\n```bash\ncurl --location --request GET 'https://mailganer.com/api/v2/tasks/:task_id/download_file' \\\n--header 'Authorization: CodeRequest {{api_key}}' \\\n--output report.csv\n```\n\n### Примечания\n- Возвращает бинарный файл в формате, указанном при создании задачи (CSV или XLSX).\n- Скачивание доступно только после того, как задача перешла в статус `COMPLETED` (проверяйте через `GET /api/v2/tasks/:task_id`).\n- Если файл ещё не готов, метод вернёт ошибку `{\"status\": \"error\", \"error\": \"Task has not file\"}`.\n- Для использования метода в аккаунте должно быть включено ограничение доступа к API по IP-адресам (иначе `403`).\n- **Полный порядок:** создать задачу → дождаться статуса `COMPLETED` → скачать файл этим методом.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "tasks", ":task_id", "download_file" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "in culpa sint", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7ba9526c-d5a2-4782-a5bf-36010322da26", "name": "Error — файл ещё не готов", "originalRequest": { "url": { "path": [ "api", "v2", "tasks", ":task_id", "download_file" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "in culpa sint", "key": "task_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"error\",\n \"error\": \"Task has not file\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b6155778-4219-4dc5-bf9d-af3412c1e683", "name": "Постбек", "description": { "content": "Передача конверсий на отдельном хосте постбека", "type": "text/plain" }, "item": [ { "id": "a5fc9c40-6312-4d95-a7ee-372262460021", "name": "Передача конверсий", "request": { "name": "Передача конверсий и обновление переменной по ссылке", "description": { "content": "Передача конверсий (postback). Источник: https://documentation.mailganer.com/reference/\nХост отдельный (postback.mailganer.com), авторизация не требуется (No Auth). Параметры передаются в query-строке.\n\n### Пример curl\n```bash\ncurl --location --request GET 'http://postback.mailganer.com/v1/?mailing_id={{public_id}}&sum=1000¤cy=RUB&offer=order&email_hash={{email_hash}}&goto_url=domain.com'\n```\n\n\n### Обновление переменной по ссылке\n\nТот же адрес обновляет пользовательскую переменную подписчика по клику на ссылку в письме. Переменную передают как get-параметр `имя=значение` (в примере `nps=10`). `goto_url` должен содержать протокол и быть закодирован (urlencode). Авторизация не нужна.\n\n```bash\ncurl --location --request GET 'https://postback.mailganer.com/v1/?email_hash={{email_hash}}&mailing_id={{public_id}}&nps=10&goto_url=https%3A%2F%2Fdomain.com%2F%3Futm_source%3Dsource%26clickid%3D{{clickid}}'\n```\n", "type": "text/plain" }, "url": { "protocol": "https", "path": [ "v1", "" ], "host": [ "postback", "mailganer", "com" ], "query": [ { "disabled": false, "key": "mailing_id", "value": "166118134802", "description": "Обязательный. ID рассылки — используйте переменную {{public_id}}" }, { "disabled": false, "key": "email_hash", "value": "6b36dc48744043ec34ab9613c7f165b3e60f54f4", "description": "Обязательный. md5-хеш имейла подписчика, выполнившего целевое действие" }, { "disabled": false, "key": "sum", "value": "1000", "description": "Обязательный. Сумма целевого действия" }, { "disabled": false, "key": "currency", "value": "RUB", "description": "Необязательный. RUB или USD" }, { "disabled": false, "key": "offer", "value": "order", "description": "Необязательный. Уточнение, какое целевое действие выполнил подписчик" }, { "disabled": false, "key": "goto_url", "value": "domain.com", "description": "Необязательный. URL для редиректа после обработки" } ], "variable": [] }, "method": "GET", "auth": null }, "response": [ { "id": "71d005b6-a546-49c9-b1d7-b1112f375da6", "name": "Не переданы обязательные параметры", "originalRequest": { "url": { "protocol": "https", "path": [ "v1", "" ], "host": [ "postback", "mailganer", "com" ], "query": [ { "key": "mailing_id", "value": "166118134802" }, { "key": "email_hash", "value": "6b36dc48744043ec34ab9613c7f165b3e60f54f4" }, { "key": "sum", "value": "1000" }, { "key": "currency", "value": "RUB" }, { "key": "offer", "value": "order" }, { "key": "goto_url", "value": "domain.com" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "052687fb-ccb7-4ca6-bf63-b1af175586f0", "name": "Запрос принят", "originalRequest": { "url": { "protocol": "https", "path": [ "v1", "" ], "host": [ "postback", "mailganer", "com" ], "query": [ { "key": "mailing_id", "value": "166118134802" }, { "key": "email_hash", "value": "6b36dc48744043ec34ab9613c7f165b3e60f54f4" }, { "key": "sum", "value": "1000" }, { "key": "currency", "value": "RUB" }, { "key": "offer", "value": "order" }, { "key": "goto_url", "value": "domain.com" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Обновление переменной по ссылке", "request": { "name": "Передача конверсий и обновление переменной по ссылке", "description": { "content": "### Обновление переменной по ссылке\n\nТот же адрес обновляет пользовательскую переменную подписчика по клику на ссылку в письме. Переменную передают как get-параметр `имя=значение` (в примере `nps=10`). `goto_url` должен содержать протокол и быть закодирован (urlencode). Авторизация не нужна.\n\n```bash\ncurl --location --request GET 'https://postback.mailganer.com/v1/?email_hash={{email_hash}}&mailing_id={{public_id}}&nps=10&goto_url=https%3A%2F%2Fdomain.com%2F%3Futm_source%3Dsource%26clickid%3D{{clickid}}'\n```\n", "type": "text/plain" }, "url": { "protocol": "https", "path": [ "v1", "" ], "host": [ "postback", "mailganer", "com" ], "query": [ { "key": "email_hash", "value": "{{email_hash}}" }, { "key": "mailing_id", "value": "{{public_id}}" }, { "key": "nps", "value": "10" }, { "key": "goto_url", "value": "https%3A%2F%2Fdomain.com%2F%3Futm_source%3Dsource%26clickid%3D{{clickid}}" } ], "variable": [], "raw": "https://postback.mailganer.com/v1/?email_hash={{email_hash}}&mailing_id={{public_id}}&nps=10&goto_url=https%3A%2F%2Fdomain.com%2F%3Futm_source%3Dsource%26clickid%3D{{clickid}}" }, "method": "GET", "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "24bc6ad8-e0b0-49c2-81ab-6c5aceaf7b49", "name": "Вебхуки", "description": { "content": "Входящие вебхуки: Mailganer отправляет POST на ваш URL, заданный методом «Задать ссылку на webhook». Все четыре события и их поля описаны в блоке Callbacks этого метода.", "type": "text/plain" }, "item": [ { "name": "Изменение статуса подписчика", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "status", "value": "-1", "type": "text" }, { "key": "source_name", "value": "Тест хука", "type": "text" }, { "key": "source_id", "value": "1092359", "type": "text" }, { "key": "timestamp", "value": "2026-05-19 15:26:19.654599", "type": "text" }, { "key": "type", "value": "1", "type": "text" }, { "key": "method", "value": "unsubscribe", "type": "text" }, { "key": "email", "value": "example@example.com", "type": "text" } ] }, "url": { "raw": "{{webhook_url}}", "host": [ "{{webhook_url}}" ] }, "description": { "content": "Событие изменения статуса подписки подписчика (`type=1`).\n\n**Входящий вебхук** — Mailganer отправляет POST на ваш URL, заданный методом «Задать ссылку на webhook».\n\n**Метод доставки:** POST **Content-Type:** application/x-www-form-urlencoded (form-values)\n\n### Поля payload\n\n| Поле | Тип | Описание |\n| --- | --- | --- |\n| `type` | int | Тип вебхука, всегда `1` для изменения статуса подписчика |\n| `email` | string | Имейл подписчика |\n| `status` | int | Числовой статус подписки (см. таблицу статусов ниже) |\n| `status_message` | string | Текстовая расшифровка (например, причина недоставки) |\n| `timestamp` | string | Дата и время отправки вебхука |\n| `source_id` | int | ID списка. Передаётся не для всех событий (только при спаме/отписке) |\n| `source_name` | string | Название списка. Передаётся не для всех событий (только при спаме/отписке) |\n| `method` | string | `spam` или `unsubscribe`. Передаётся не для всех событий |\n| `reason` | string | Причина отписки. Передаётся только для событий отписки |\n\n### Значения `status`\n\n| Значение | Описание |\n| --- | --- |\n| `-6` | Исправлен (при импорте найдены недопустимые символы) |\n| `-5` | Исправлен (опечатка исправлена системой) |\n| `-4` | Помечен как спам сервером |\n| `-3` | Помечен как спам пользователем |\n| `-2` | Недоступен |\n| `-1` | Отписан от рассылок |\n| `0` | Новый |\n| `1` | Активен |\n| `2` | Запрошено подтверждение |\n\n### Пример payload\n\n```\nstatus=-1&source_name=%D0%A2%D0%B5%D1%81%D1%82+%D1%85%D1%83%D0%BA%D0%B0&source_id=1092359×tamp=2026-05-19+15%3A26%3A19.654599&type=1&method=unsubscribe&email=example%40example.com\n```\n\n### Примечания\n\n- Хук активируется в настройках списка на вкладке «Интеграции».\n- Опциональный переключатель добавляет в запрос заголовок с ключом авторизации.\n- Поля `source_id`, `source_name`, `method` передаются не для всех событий — только когда пользователь пожаловался на спам или отписался. Поле `reason` присутствует только для отписки.\n- Повторные попытки при ошибке на вашем эндпоинте: через 5 секунд, 1 час и 24 часа.\n", "type": "text/plain" } }, "response": [] }, { "name": "Изменение данных о подписчике", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "type", "value": "2", "type": "text" }, { "key": "src", "value": "2", "type": "text" }, { "key": "email", "value": "example@mail.ru", "type": "text" }, { "key": "birthday", "value": "1988-01-01", "type": "text" } ] }, "url": { "raw": "{{webhook_url}}", "host": [ "{{webhook_url}}" ] }, "description": { "content": "Событие изменения данных в карточке подписчика (`type=2`). Хук отправляется каждый раз, когда изменяется какое-либо поле в карточке подписчика.\n\n**Входящий вебхук** — Mailganer отправляет POST на ваш URL, заданный методом «Задать ссылку на webhook».\n\n**Метод доставки:** POST **Content-Type:** application/x-www-form-urlencoded (form-values)\n\n### Поля payload\n\n| Поле | Тип | Описание |\n| --- | --- | --- |\n| `type` | int | Тип вебхука, всегда `2` для изменения данных о подписчике |\n| `src` | int | Источник изменения: `1` — изменение через API, `2` — изменение через интерфейс |\n| `email` | string | Имейл подписчика |\n| `birthday` | date | Дата рождения, формат `YYYY-MM-DD` |\n| `user_vars` | array | Пользовательские переменные в формате `[['variable_name', 'value'], ['variable_name2', 'value']]` |\n\n### Пример payload\n\n```\ntype=2&src=2&email=example%40mail.ru&birthday=1988-01-01\n```\n\n### Примечания\n\n- В документации нет готового примера payload; тело выше собрано из перечня документированных полей с иллюстративными значениями-заглушками.\n- Хук активируется в настройках списка на вкладке «Интеграции».\n- Опциональный переключатель добавляет в запрос заголовок с ключом авторизации.\n- Хук срабатывает только при фактическом изменении данных.\n- Пользовательские переменные (`user_vars`) передаются парами «имя — значение» в виде массива.\n- Повторные попытки при ошибке на вашем эндпоинте: через 5 секунд, 1 час и 24 часа.\n", "type": "text/plain" } }, "response": [] }, { "name": "Взаимодействие с письмом", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "mail_id", "value": "999129235", "type": "text" }, { "key": "public_id", "value": "166118134802", "type": "text" }, { "key": "mail_type", "value": "mailing", "type": "text" }, { "key": "action", "value": "1", "type": "text" }, { "key": "timestamp", "value": "2022-08-22 15:18:44.960548", "type": "text" }, { "key": "type", "value": "3", "type": "text" }, { "key": "email", "value": "example@mail.ru", "type": "text" } ] }, "url": { "raw": "{{webhook_url}}", "host": [ "{{webhook_url}}" ] }, "description": { "content": "Событие взаимодействия с письмом в массовой или триггерной рассылке (`type=3`). Срабатывает на каждое сообщение при любом взаимодействии с ним.\n\n**Входящий вебхук** — Mailganer отправляет POST на ваш URL, заданный методом «Задать ссылку на webhook».\n\n**Метод доставки:** POST **Content-Type:** application/x-www-form-urlencoded (form-values)\n\n### Поля payload\n\n| Поле | Тип | Описание |\n| --- | --- | --- |\n| `type` | int | Тип вебхука, всегда `3` для взаимодействия с письмом |\n| `email` | string | Имейл получателя |\n| `source` | int | ID списка, которому принадлежит письмо |\n| `action` | int | Тип взаимодействия (см. таблицу значений ниже) |\n| `timestamp` | string | Дата и время взаимодействия |\n| `mail_type` | string | `mailing` (массовая рассылка) или `trigger` (триггерное сообщение) |\n| `public_id` | string | Публичный ID массовой/триггерной рассылки |\n| `mail_id` | string | ID отправки сообщения (для триггерных рассылок) |\n| `trigger_id` | string | ID триггера в системе Mailganer |\n\n### Значения `action`\n\n| Значение | Описание |\n| --- | --- |\n| `-3` | Не доставлено |\n| `-2` | Жалоба на спам |\n| `-1` | Отписка |\n| `1` | Доставлено |\n| `2` | Открытие письма |\n| `3` | Клик по ссылке в письме |\n\n### Значения `mail_type`\n\n| Значение | Описание |\n| --- | --- |\n| `mailing` | Взаимодействие из вручную отправленной массовой рассылки |\n| `trigger` | Взаимодействие из триггерного сообщения |\n\n### Пример payload\n\n```\nmail_id=999129235&public_id=166118134802&mail_type=mailing&action=1×tamp=2022-08-22+15%3A18%3A44.960548&type=3&email=example%40mail.ru\n```\n\n### Примечания\n\n- Хук активируется в настройках списка на вкладке «Интеграции».\n- Опциональный переключатель добавляет в запрос заголовок с ключом авторизации.\n- Повторные попытки при ошибке на вашем эндпоинте: через 5 секунд, 1 час и 24 часа.\n", "type": "text/plain" } }, "response": [] }, { "name": "Срабатывание события в триггере", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "type", "value": "4", "type": "text" }, { "key": "public_id", "value": "166118134802", "type": "text" }, { "key": "email", "value": "example@mail.ru", "type": "text" }, { "key": "phone", "value": "+79123456789", "type": "text" }, { "key": "name", "value": "Федор", "type": "text" }, { "key": "surname", "value": "Федоров", "type": "text" }, { "key": "patronymic", "value": "Федорович", "type": "text" }, { "key": "gender", "value": "1", "type": "text" }, { "key": "birthday", "value": "01.01.1988", "type": "text" }, { "key": "city", "value": "Москва", "type": "text" }, { "key": "user_var_company_name", "value": "Ganer", "type": "text" } ] }, "url": { "raw": "{{webhook_url}}", "host": [ "{{webhook_url}}" ] }, "description": { "content": "Событие срабатывания триггера (`type=4`). Используется, когда нужно передать информацию во внешнюю систему вместе с отправкой письма или передать данные без отправки письма.\n\n**Входящий вебхук** — Mailganer отправляет POST на ваш URL, заданный методом «Задать ссылку на webhook».\n\n**Метод доставки:** POST **Content-Type:** application/x-www-form-urlencoded (form-values)\n\n### Поля payload\n\n| Поле | Тип | Описание |\n| --- | --- | --- |\n| `type` | int | Тип вебхука, всегда `4` для срабатывания события в триггере |\n| `public_id` | int | ID триггера |\n| `email` | string | Имейл подписчика |\n| `phone` | string | Телефон |\n| `name` | string | Имя |\n| `surname` | string | Фамилия |\n| `patronymic` | string | Отчество |\n| `gender` | int | Пол: `1` — мужской, `2` — женский |\n| `birthday` | date | Дата рождения, формат `dd.mm.yyyy` |\n| `city` | string | Город |\n| `user_var_{имя_переменной}` | string | Пользовательские переменные передаются как `user_var_{имя_переменной}` (например, `user_var_company_name`) |\n\n### Пример payload\n\n```\ntype=4&public_id=166118134802&email=example%40mail.ru&phone=%2B79123456789&name=%D0%A4%D0%B5%D0%B4%D0%BE%D1%80&surname=%D0%A4%D0%B5%D0%B4%D0%BE%D1%80%D0%BE%D0%B2&patronymic=%D0%A4%D0%B5%D0%B4%D0%BE%D1%80%D0%BE%D0%B2%D0%B8%D1%87&gender=1&birthday=01.01.1988&city=%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0&user_var_company_name=Ganer\n```\n\n### Примечания\n\n- В документации нет готового примера payload; тело выше собрано из перечня документированных полей с иллюстративными значениями-заглушками.\n- Хук активируется в настройках списка на вкладке «Интеграции».\n- Опциональный переключатель добавляет в запрос заголовок с ключом авторизации.\n- Пользовательские переменные передаются с префиксом `user_var_` в названии поля.\n- Повторные попытки при ошибке на вашем эндпоинте: через 5 секунд, 1 час и 24 часа.\n", "type": "text/plain" } }, "response": [] } ], "event": [] } ], "event": [], "variable": [ { "key": "api_key", "value": "", "type": "string", "description": "API-ключ из раздела «Ключ API» личного кабинета (mailganer.com/app/profile/settings/api/), без слова CodeRequest" }, { "type": "string", "value": "https://mailganer.com", "key": "baseUrl" }, { "key": "webhook_url", "value": "https://your-domain.example/webhook", "type": "string", "description": "URL вашего обработчика вебхуков" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "CodeRequest {{api_key}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "info": { "_postman_id": "ced4f319-85cd-4d98-921b-e20b1533f636", "name": "REST API Mailganer", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Методы поделены на несколько групп: \n1\\. Работа с личным кабинетом Mailganer. Стандартные методы по работе с подписчикам, списками, рассылками. \n2\\. Интеграция Mailganer со сторонними приложениями. Группа методов называется \"Работа с пользователями\"\n\nНапишите нам на [api@mailganer.com](mailto:api@mailganer.com), если вам не хватает какого то метода.\n\nМетоды по работе с [SMTP](https://documentation.samotpravil.ru/) задокументированы отдельно и имеют свою отдельную авторизацию\n\n### Авторизация\n\n1\\. В методах, содержащих в **url v1,** авторизация происходит через использование апи ключа в теле запроса в переменной _api_key_. \n2\\. В методах, содержащих в **url v2**, авторизация происходит через использование апи ключа в заголовке `Authorization: CodeRequest {{api_key}}`\n\nAPI ключ находится в разделе [Ключ API](https://mailganer.com/app/profile/settings/api/) личного кабинета\n\n### Лимиты\n\nК API можно обращаться не чаще **500 раз в минуту**. В случае превышения лимита, вы получите ошибку с кодом 429. Напишите нам, если требуется увеличить лимит.\n\n### Пагинация\n\nНекоторые методы отдают по 25 записей на странице. В переменной count находится количество записей. Ответ находится в json-масиве result. В переменных next и previous находятся ссылки на следующую или предыдущую страницы. Если следующей или предыдущей страницы нет, то вернётся значение null.\n\n``` json\n{\n \"count\": 2,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"source\": 1,\n \"title\": \"user_var_float\",\n \"type\": 2,\n \"type_text\": \"Вещественное число\"\n },\n {\n \"source\": 1,\n \"title\": \"user_var_datetime\",\n \"type\": 4,\n \"type_text\": \"Дата и время\"\n }\n ]\n}\n\n ```", "type": "text/plain" } } }