{"info":{"_postman_id":"ad2a6101-55ec-46be-9158-ec0369852183","name":"REST API Mailganer","description":"

Методы поделены на несколько групп:
1. Работа с личным кабинетом Mailganer. Стандартные методы по работе с подписчикам, списками, рассылками.
2. Интеграция Mailganer со сторонними приложениями. Группа методов называется \"Работа с пользователями\"

Напишите нам на api@mailganer.com, если вам не хватает какого то метода.

Методы по работе с SMTP задокументированы отдельно и имеют свою отдельную авторизацию

Авторизация

1. В методах, содержащих в url v1, авторизация происходит через использование апи ключа в теле запроса в переменной api_key.
2. В методах, содержащих в url v2, авторизация происходит через использование апи ключа в заголовке Authorization: CodeRequest

API ключ находится в разделе Ключ API личного кабинета

Лимиты

К API можно обращаться не чаще 500 раз в минуту. В случае превышения лимита, вы получите ошибку с кодом 429. Напишите нам, если требуется увеличить лимит.

Пагинация

Некоторые методы отдают по 25 записей на странице. В переменной count находится количество записей. Ответ находится в json-масиве result. В переменных next и previous находятся ссылки на следующую или предыдущую страницы. Если следующей или предыдущей страницы нет, то вернётся значение null.

{\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

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"23131434","collectionId":"ad2a6101-55ec-46be-9158-ec0369852183","publishedId":"VUxPvnhA","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"656565","highlight":"2980b9"},"publishDate":"2022-12-09T09:48:32.000Z"},"item":[{"name":"Подписчики","item":[{"name":"Добавление нового подписчика","id":"f328aa03-d531-4799-a098-580e5301e0c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"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"}}},"url":"https://mailganer.com/api/v2/emails/","description":"

Добавляет нового подписчика в указанный список (или списки).

Эндпоинт: POST https://mailganer.com/api/v2/emails/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)\nContent-Type: application/json

Обязательные поля

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

Поле	Тип	Описание
`email`	string	Имейл подписчика
`source`	int / array / `\"all\"`	ID списка. `\"all\"` — во все списки; можно передать массив ID

Необязательные поля

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

Поле	Тип	Описание
`phone`	string	Телефон
`name`, `surname`, `patronymic`	string	ФИО
`gender`	int	1 — мужской, 2 — женский
`birthday`	string	Дата рождения, формат `dd.mm.yyyy`
`city`	string	Город
`add_tag` / `delete_tag`	string / array	Добавить / удалить метку (≤ 140 символов)
`add_category` / `delete_category`	string	Добавить / удалить категорию (≤ 250 символов)
`user_vars`	object	Пользовательские переменные (`null` в значении — удалить его)
`not_doi` / `need_activate`	bool	Управление DOI (требует активации поддержкой)

Пример curl

curl --location --request POST 'https://mailganer.com/api/v2/emails/' \\\n--header 'Authorization: CodeRequest ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n    \"email\": \"test@example.com\",\n    \"source\": 49767\n}'\n

Примечания

Лимит: 500 запросов/мин, иначе 429.
Ошибка 400 «We have already sent a subscription confirmation email…» — повторное DOI-письмо доступно через 1 час.
Рекомендуется v3 (/api/v3/emails/) — детальный ответ с массивами successful / failed.

📄 Документация: https://documentation.mailganer.ru/documentation/email/add

Массовое добавление

До 50 подписчиков за один запрос: тело — JSON-массив тех же объектов.\nНа странице «Попробовать» пример выбирается в списке примеров тела.

Тело запроса

Массив объектов; поля каждого объекта:

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

Поле	Тип	Обяз.	Описание
`email`	string	да	Имейл подписчика
`source`	int / array / `\"all\"`	да	ID списка; можно передать несколько или `\"all\"` — во все списки
`phone`	string	нет	Телефон
`name`	string	нет	Имя
`surname`	string	нет	Фамилия
`patronymic`	string	нет	Отчество
`gender`	int	нет	1 — мужской, 2 — женский
`birthday`	string	нет	Дата рождения, формат `dd.mm.yyyy`
`city`	string	нет	Город
`add_tag`	string / array	нет	Добавить метку (≤ 140 символов)
`delete_tag`	string	нет	Удалить метку
`user_vars`	object	нет	Пользовательские переменные
`not_doi`	bool	нет	Отменить отправку письма подтверждения
`need_activate`	bool	нет	Отправить письмо подтверждения
`add_category`	string	нет	Добавить категорию подписки (≤ 250 символов)
`delete_category`	string	нет	Удалить категорию подписки

Пример curl

curl --location --request POST 'https://mailganer.com/api/v2/emails/' \\\n--header 'Authorization: CodeRequest ' \\\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

Примечания

Максимум 50 имейлов за запрос.
Атомарность: если хотя бы в одном имейле есть ошибка, ни один имейл из пакета не будет добавлен.
В ответе по каждому имейлу возвращаются id, mg_hash, in_base (был ли уже в базе) и email_status.
Повторная отправка DOI-письма возможна через 1 час.
При HTTP 503 необходимо повторить запрос с задержкой.

📄 Документация: https://documentation.mailganer.ru/documentation/email/add/mass

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ad2a6101-55ec-46be-9158-ec0369852183","id":"ad2a6101-55ec-46be-9158-ec0369852183","name":"REST API Mailganer","type":"collection"}},"urlObject":{"path":["api","v2","emails",""],"host":["https://mailganer.com"],"query":[],"variable":[]}},"response":[{"id":"bf66c537-2501-48a0-b751-aa2c623299cf","name":"Success","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"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"}}},"url":"https://mailganer.com/api/v2/emails/"},"status":"Created","code":201,"_postman_previewlanguage":"json","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"}],"cookie":[],"responseTime":null,"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}"},{"id":"99138fd9-e4de-44cf-9cab-615230dc52c7","name":"Error","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"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"}}},"url":"https://mailganer.com/api/v2/emails/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","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"}],"cookie":[],"responseTime":null,"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}"},{"id":"1a2ff37d-95fa-4c85-9200-4ed94c7fe60d","name":"Error - Недопустимый токен","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"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"}}},"url":"https://mailganer.com/api/v2/emails/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","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"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"error\": \"Недопустимый токен.\"\n}"}],"_postman_id":"f328aa03-d531-4799-a098-580e5301e0c1"},{"name":"Массовое добавление подписчиков","id":"63a11505-7b3a-4f94-bb43-9cccb44386c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"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"}}},"url":"https://mailganer.com/api/v2/emails/","description":"

Добавляет до 50 подписчиков за один запрос. Тело — JSON-массив объектов подписчиков.

Массовое добавление

Тело запроса

Массив объектов; поля каждого объекта:

Поле	Тип	Обяз.	Описание
`email`	string	да	Имейл подписчика
`source`	int / array / `\"all\"`	да	ID списка; можно передать несколько или `\"all\"` — во все списки
`phone`	string	нет	Телефон
`name`	string	нет	Имя
`surname`	string	нет	Фамилия
`patronymic`	string	нет	Отчество
`gender`	int	нет	1 — мужской, 2 — женский
`birthday`	string	нет	Дата рождения, формат `dd.mm.yyyy`
`city`	string	нет	Город
`add_tag`	string / array	нет	Добавить метку (≤ 140 символов)
`delete_tag`	string	нет	Удалить метку
`user_vars`	object	нет	Пользовательские переменные
`not_doi`	bool	нет	Отменить отправку письма подтверждения
`need_activate`	bool	нет	Отправить письмо подтверждения
`add_category`	string	нет	Добавить категорию подписки (≤ 250 символов)
`delete_category`	string	нет	Удалить категорию подписки

Пример curl

curl --location --request POST 'https://mailganer.com/api/v2/emails/' \\\n--header 'Authorization: CodeRequest ' \\\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

Примечания

Максимум 50 имейлов за запрос.
Атомарность: если хотя бы в одном имейле есть ошибка, ни один имейл из пакета не будет добавлен.
В ответе по каждому имейлу возвращаются id, mg_hash, in_base (был ли уже в базе) и email_status.
Повторная отправка DOI-письма возможна через 1 час.
При HTTP 503 необходимо повторить запрос с задержкой.

📄 Документация: https://documentation.mailganer.ru/documentation/email/add/mass

Возвращает информацию о подписчике(ах) с фильтрацией по query-параметрам.

Эндпоинт: GET https://mailganer.com/api/v2/emails/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)

Query-параметры

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

Поле	Тип	Обяз.	Описание
`email`	string	нет	Имейл, о котором нужна информация; оставьте пустым, чтобы получить по всем подписчикам
`source`	int	нет	ID списка; оставьте пустым, чтобы получить по всем спискам
`start_date`	string	нет	Фильтр по дате создания подписчика (формат `YYYY-MM-DD`)
`end_date`	string	нет	Фильтр по дате создания подписчика (формат `YYYY-MM-DD`)
`updated_at_start`	string	нет	Фильтр по дате изменения подписчика (формат `YYYY-MM-DD`)
`updated_at_end`	string	нет	Фильтр по дате изменения подписчика (формат `YYYY-MM-DD`)
`last_activity_days`	int	нет	Передайте `1`, чтобы дополнительно вернуть в ответе поле активности подписчика

Пример curl

curl --location --request GET 'https://mailganer.com/api/v2/emails/?email=test@example.com&source=51488' \\\n--header 'Authorization: CodeRequest '\n

Примечания

При фильтрации по имейлу count всегда равен 1.
Если параметры дат не указаны — возвращаются все подписчики.
Активностью считается последнее открытие рассылки или триггерного письма.
Поле активности рассчитывается только если передан last_activity_days=1.
Ответ постраничный: поля next / previous / count / results.

📄 Документация: https://documentation.mailganer.ru/documentation/email/get

Имейл, о котором нужна информация; оставьте пустым, чтобы получить по всем подписчикам

\n","type":"text/plain"},"key":"email","value":"test@example.com"},{"description":{"content":"

ID списка; оставьте пустым, чтобы получить по всем спискам

\n","type":"text/plain"},"key":"source","value":"51488"},{"description":{"content":"

Фильтр по дате создания подписчика (формат YYYY-MM-DD)

\n","type":"text/plain"},"key":"start_date","value":"2026-01-01"},{"description":{"content":"

Фильтр по дате создания подписчика (формат YYYY-MM-DD)

\n","type":"text/plain"},"key":"end_date","value":"2026-12-31"},{"description":{"content":"

Фильтр по дате изменения подписчика (формат YYYY-MM-DD)

\n","type":"text/plain"},"key":"updated_at_start","value":"2026-01-01"},{"description":{"content":"

Фильтр по дате изменения подписчика (формат YYYY-MM-DD)

\n","type":"text/plain"},"key":"updated_at_end","value":"2026-12-31"},{"description":{"content":"

Передайте 1, чтобы дополнительно вернуть в ответе поле активности подписчика

\n","type":"text/plain"},"key":"last_activity_days","value":"1"}],"variable":[]}},"response":[{"id":"eb19b27f-8fcc-453d-97e0-b6ef55febe6e","name":"Email найден","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://mailganer.com/api/v2/emails/?email=test@example.com&source=51488&start_date=2026-01-01&end_date=2026-12-31&updated_at_start=2026-01-01&updated_at_end=2026-12-31&last_activity_days=1","host":["https://mailganer.com"],"path":["api","v2","emails",""],"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"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","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"}],"cookie":[],"responseTime":null,"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}"},{"id":"433ade9b-65e2-4173-974d-cfbeeaff4884","name":"Ошибка (400) — неверный source","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://mailganer.com/api/v2/emails/?email=test@example.com&source=51488&start_date=2026-01-01&end_date=2026-12-31&updated_at_start=2026-01-01&updated_at_end=2026-12-31&last_activity_days=1","host":["https://mailganer.com"],"path":["api","v2","emails",""],"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"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"invalid\",\n \"error\": {\n \"source\": [\n \"Not found site (source_id=497671) or site blocked\"\n ]\n }\n}"}],"_postman_id":"4ea9f524-fb95-4ca2-8947-dcf423ddac00"},{"name":"Обновление информации о подписчике 1 способ","id":"425795f6-5c9e-4c02-aa38-2cfd932ee4e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"birthday\": \"02.01.1990\"\n}","options":{"raw":{"language":"json"}}},"url":"https://mailganer.com/api/v2/emails/:email_hash/","description":"

Обновляет информацию о подписчике, идентифицируя его по хэшу имейла (mg_hash) в URL.

Эндпоинт: PATCH https://mailganer.com/api/v2/emails/:email_hash/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)\nContent-Type: application/json

Подписчик определяется по mg_hash в пути (path-переменная email_hash), поэтому передавать email и source в теле не требуется — в теле указываются только обновляемые поля.

Тело запроса

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

Поле	Тип	Обяз.	Описание
`phone`	string	нет	Телефон
`name`	string	нет	Имя
`surname`	string	нет	Фамилия
`patronymic`	string	нет	Отчество
`gender`	int	нет	1 — мужской, 2 — женский
`birthday`	string	нет	Дата рождения, формат `dd.mm.yyyy`
`city`	string	нет	Город
`add_tag`	string / array	нет	Добавить метку
`delete_tag`	string	нет	Удалить метку
`user_vars`	object	нет	Пользовательские переменные (передайте `null` в значении, чтобы удалить переменную)
`not_doi`	bool	нет	Отменить отправку письма подтверждения
`need_activate`	bool	нет	Отправить письмо подтверждения
`add_category`	string	нет	Добавить категорию подписки
`delete_category`	string	нет	Удалить категорию подписки

Пример curl

curl --location --request PATCH 'https://mailganer.com/api/v2/emails/a05ad557332370764cd4f267a251f3b13289bcff/' \\\n--header 'Authorization: CodeRequest ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n    \"birthday\": \"02.01.1990\"\n}'\n

Примечания

Переменные (user_vars) обновляются только если явно переданы в запросе.
Чтобы удалить значение пользовательской переменной, передайте null — работает для всех типов переменных.
Альтернативные способы обновления: эндпоинт /api/v2/emails/update/ (передача email + source в теле) или массовое обновление /api/v2/emails/mass/.

📄 Документация: https://documentation.mailganer.ru/documentation/email/update

(Required) Хэш имейла

\n","type":"text/plain"},"type":"any","value":"a05ad557332370764cd4f267a251f3b13289bcff","key":"email_hash"}]}},"response":[{"id":"1c46f17b-1e06-49ba-b51e-e81344b7c495","name":"Успех (200)","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"birthday\": \"02.01.1990\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mailganer.com/api/v2/emails/:email_hash/","host":["https://mailganer.com"],"path":["api","v2","emails",":email_hash",""],"variable":[{"key":"email_hash","value":"a05ad557332370764cd4f267a251f3b13289bcff","description":"(Required) Хэш имейла"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 45763880,\n \"mg_hash\": \"53158545763880e054b31ecbad2cf3265d4001d1\"\n}"},{"id":"f9a76f69-a42d-4311-b730-8918addf2611","name":"Ошибка (400)","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"birthday\": \"02.01.1990\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mailganer.com/api/v2/emails/:email_hash/","host":["https://mailganer.com"],"path":["api","v2","emails",":email_hash",""],"variable":[{"key":"email_hash","value":"a05ad557332370764cd4f267a251f3b13289bcff","description":"(Required) Хэш имейла"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"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}"}],"_postman_id":"425795f6-5c9e-4c02-aa38-2cfd932ee4e7"},{"name":"Получение информации о подписчике 2 способ","id":"9cb5c910-bb67-4d1f-82c7-6c87902aba28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://mailganer.com/api/v2/emails/:email_hash/","description":"

Возвращает информацию о конкретном подписчике по хэшу имейла (mg_hash) в URL.

Эндпоинт: GET https://mailganer.com/api/v2/emails/:email_hash/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)

Подписчик определяется по path-переменной email_hash (значение mg_hash). Query-параметры не требуются.

Пример curl

curl --location --request GET 'https://mailganer.com/api/v2/emails/ae2f6611598633414be10fe73380863cb59afe7b8/' \\\n--header 'Authorization: CodeRequest '\n

Примечания

Возвращается тот же формат объекта подписчика, что и в способе 1 (поля id, mg_hash, email, source, email_status, user_vars, tags, categories, created, modified и др.).
Если подписчик по хэшу не найден — вернётся ошибка «Не найдено.».

📄 Документация: https://documentation.mailganer.ru/documentation/email/get

(Required) Хэш имейла

\n","type":"text/plain"},"type":"any","value":"a05ad557332370764cd4f267a251f3b13289bcff","key":"email_hash"}]}},"response":[{"id":"c05938c2-24ee-456d-be30-f2a6a271cf6e","name":"Успех (200)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://mailganer.com/api/v2/emails/:email_hash/","host":["https://mailganer.com"],"path":["api","v2","emails",":email_hash",""],"variable":[{"key":"email_hash","value":"a05ad557332370764cd4f267a251f3b13289bcff","description":"(Required) Хэш имейла"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"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}"}],"_postman_id":"9cb5c910-bb67-4d1f-82c7-6c87902aba28"},{"name":"Обновление информации о подписчике 2 способ","id":"d1edb9ce-ddbd-47ef-8a8d-4b96361c0104","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"test@example.com\",\n \"source\": \"51488\",\n \"birthday\": \"05.01.1990\"\n}","options":{"raw":{"language":"json"}}},"url":"https://mailganer.com/api/v2/emails/update/","description":"

Обновляет информацию о подписчике, идентифицируя его по паре email + source в теле запроса.

Эндпоинт: PATCH https://mailganer.com/api/v2/emails/update/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)\nContent-Type: application/json

Тело запроса

Поле	Тип	Обяз.	Описание
`email`	string	да	Имейл подписчика
`source`	int / array / `\"all\"`	да	ID списка; можно передать несколько `[49767,50145]` или `\"all\"`
`phone`	string	нет	Телефон
`name`	string	нет	Имя
`surname`	string	нет	Фамилия
`patronymic`	string	нет	Отчество
`gender`	int	нет	1 — мужской, 2 — женский
`birthday`	string	нет	Дата рождения, формат `dd.mm.yyyy`
`city`	string	нет	Город
`add_tag`	string / array	нет	Добавить метку
`delete_tag`	string	нет	Удалить метку
`user_vars`	object	нет	Пользовательские переменные (передайте `null` в значении, чтобы удалить переменную)
`not_doi`	bool	нет	Отменить отправку письма подтверждения
`need_activate`	bool	нет	Отправить письмо подтверждения
`add_category`	string	нет	Добавить категорию подписки
`delete_category`	string	нет	Удалить категорию подписки

Пример curl

curl --location --request PATCH 'https://mailganer.com/api/v2/emails/update/' \\\n--header 'Authorization: CodeRequest ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n    \"email\": \"test@example.com\",\n    \"source\": \"51488\",\n    \"birthday\": \"05.01.1990\"\n}'\n

Примечания

Переменные (user_vars) обновляются только если явно переданы в запросе; значение null удаляет переменную (для всех типов).
Альтернативные способы: передача mg_hash в URL (/api/v2/emails/:email_hash/) или массовое обновление /api/v2/emails/mass/.

📄 Документация: https://documentation.mailganer.ru/documentation/email/update

Отписывает подписчика, идентифицируя его по хэшу имейла (mg_hash) в URL. Это рабочий способ отписки.

Эндпоинт: POST https://mailganer.com/api/v2/emails/:email_hash/unsubscribe/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)

Подписчик определяется по path-переменной email_hash (значение mg_hash). Тело запроса не требуется.

Пример curl

curl --location --request POST 'https://mailganer.com/api/v2/emails/a05ad557332370764cd4f267a251f3b13289bcff/unsubscribe/' \\\n--header 'Authorization: CodeRequest '\n

Примечания

Успешный ответ: {\"email_status\": \"unsubscribe\"} — статус подписки меняется на «Отписался».
Если подписчик по хэшу не найден — вернётся ошибка {\"status\": \"error\", \"error\": \"Не найдено.\"}.
На странице документации в таблице параметров ошибочно продублированы поля со страницы «получение информации о подписчике» (артефакт копирования). Рабочий вариант отписки — передача mg_hash в URL.

📄 Документация: https://documentation.mailganer.ru/documentation/email/unsubscribe

(Required) Хэш имейла

\n","type":"text/plain"},"type":"any","value":"a05ad557332370764cd4f267a251f3b13289bcff","key":"email_hash"}]}},"response":[{"id":"f9159897-9ed4-457b-a700-c645e4d8ab69","name":"Успех (200)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://mailganer.com/api/v2/emails/:email_hash/unsubscribe/","host":["https://mailganer.com"],"path":["api","v2","emails",":email_hash","unsubscribe",""],"variable":[{"key":"email_hash","value":"a05ad557332370764cd4f267a251f3b13289bcff","description":"(Required) Хэш имейла"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"email_status\": \"unsubscribe\"\n}"},{"id":"9b1e2711-3b0a-4b84-af4c-de144f53458d","name":"Ошибка (404)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://mailganer.com/api/v2/emails/:email_hash/unsubscribe/","host":["https://mailganer.com"],"path":["api","v2","emails",":email_hash","unsubscribe",""],"variable":[{"key":"email_hash","value":"a05ad557332370764cd4f267a251f3b13289bcff","description":"(Required) Хэш имейла"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"error\": \"Не найдено.\"\n}"}],"_postman_id":"fd593ea7-8007-4020-98de-552464c64760"},{"name":"Отписка подписчика 2 способ","id":"66ae841b-f21f-4488-b33a-c1ab8e149a59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"test@example.com\",\n \"source\": \"51488\"\n}","options":{"raw":{"language":"json"}}},"url":"https://mailganer.com/api/v2/emails/unsubscribe/","description":"

Отписывает подписчика, идентифицируя его по паре email + source в теле запроса.

Эндпоинт: POST https://mailganer.com/api/v2/emails/unsubscribe/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)\nContent-Type: application/json

Тело запроса

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

Поле	Тип	Обяз.	Описание
`email`	string	да	Имейл подписчика
`source`	int / array / `\"all\"`	да	ID списка; можно передать несколько или `\"all\"`

Пример curl

curl --location --request POST 'https://mailganer.com/api/v2/emails/unsubscribe/' \\\n--header 'Authorization: CodeRequest ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n    \"email\": \"test@example.com\",\n    \"source\": \"51488\"\n}'\n

Примечания

Успешный ответ: {\"email_status\": \"unsubscribe\"} — статус подписки меняется на «Отписался».
Если подписчик не найден — вернётся ошибка {\"status\": \"error\", \"error\": \"Не найдено.\"}.
В таблице параметров на странице документации ошибочно продублированы поля фильтрации со страницы «получение информации о подписчике» (start_date, end_date, updated_at_start, updated_at_end, last_activity_days) — это артефакт копирования; для отписки используются email + source. Полностью рабочий вариант — передача mg_hash в URL (способ 1).

📄 Документация: https://documentation.mailganer.ru/documentation/email/unsubscribe

Проверяет валидность имейла. Валидация тарифицируется отдельно.

Эндпоинт: POST https://mailganer.com/api/v2/emails/validate/\nАвторизация: заголовок Authorization: CodeRequest \nContent-Type: application/json

Тело запроса

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

Поле	Тип	Обяз.	Описание
`email`	string	✔	Имейл
`source`	int	✔	ID списка

Пример curl

curl --location --request POST 'https://mailganer.com/api/v2/emails/validate/' \\\n--header 'Authorization: CodeRequest ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n    \"email\": \"test@example.com\",\n    \"source\": 49767\n}'\n

Примечания

При слишком частых запросах по одному имейлу — ошибка «Email to many add method».
В ответе is_valid показывает результат проверки; corrected_email — исправленный имейл (если было исправление).

📄 Документация: https://documentation.mailganer.ru/documentation/email/validate

Обновляет до 50 подписчиков за один запрос. Тело — JSON-массив объектов. Операция атомарна.

Эндпоинт: PATCH https://mailganer.com/api/v2/emails/mass/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)\nContent-Type: application/json

Тело запроса

Массив объектов; поля каждого объекта:

Поле	Тип	Обяз.	Описание
`email`	string	да	Имейл подписчика
`source`	int / array / `\"all\"`	да	ID списка (узнать ID: https://mailganer.com/app/settings/); можно передать несколько или `\"all\"`
`phone`	string	нет	Телефон
`name`	string	нет	Имя
`surname`	string	нет	Фамилия
`patronymic`	string	нет	Отчество
`gender`	int	нет	1 — мужской, 2 — женский
`birthday`	string	нет	Дата рождения, формат `dd.mm.yyyy`
`city`	string	нет	Город
`add_tag`	string / array	нет	Добавить метку
`delete_tag`	string	нет	Удалить метку
`user_vars`	object	нет	Пользовательские переменные; чтобы удалить значение переменной — передайте `null`
`not_doi`	bool	нет	Отменяет отправку письма подтверждения; имейл добавляется в статусе «Активен»
`need_activate`	bool	нет	Отправляет письмо подтверждения, даже если имейл в статусе «Запрошено подтверждение»
`add_category`	string	нет	Добавить категорию подписки
`delete_category`	string	нет	Удалить категорию подписки
`email_status`	string	нет	Изменить статус. Значение `unsubscribe` меняет статус подписчика с «Активен» на «Отписался»

Пример curl

curl --location --request PATCH 'https://mailganer.com/api/v2/emails/mass/' \\\n--header 'Authorization: CodeRequest ' \\\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

Примечания

Максимум 50 имейлов за запрос.
Атомарность: если хотя бы в одном имейле есть ошибка, ни один имейл из пакета не будет обновлён.
source принимает: одиночный ID, массив ID или \"all\" (все списки).
В ответе по каждому имейлу возвращаются id и mg_hash.

📄 Документация: https://documentation.mailganer.ru/documentation/email/update/mass

Добавляет подписчиков пачкой и возвращает подробный ответ: по каждой записи видно, добавилась она или нет и почему.

Эндпоинт: POST https://mailganer.com/api/v3/emails/\nАвторизация: заголовок Authorization: CodeRequest \nContent-Type: application/json

Тело запроса — массив объектов подписчиков. Одиночный объект без массива метод тоже принимает.

Лимиты

Не больше 2000 запросов в минуту на аккаунт, при превышении вернётся 429.
Жёсткого ограничения на размер пачки нет, но разумный размер — до нескольких сотен записей: ответ содержит полную карточку каждого добавленного подписчика.

Особенности

Пустая строка в необязательном поле равнозначна тому, что поле не передано: сохранённое значение не затирается. Незнакомые ключи игнорируются.
Если в source передан массив или \"all\", подписчик создаётся в каждом списке, но в ответе придёт одна запись — по последнему обработанному списку.
Даты в переменных: dd.mm.yyyy, dd-mm-yyyy, yyyy.mm.dd, yyyy-mm-dd; дата-время — те же форматы плюс ЧЧ:ММ или ЧЧ:ММ:СС. Минимальный год 1900. Логические переменные принимают да/true/yes и нет/false/no в любом регистре.
Повторная отправка того же имейла в тот же список ошибкой не считается: подписчик обновляется и приходит в successful.

Ответ

Ответ всегда содержит три массива: successful (добавлены), failed (не добавлены, в errors причина по каждому параметру), warnings (добавлены, но часть данных не записалась — чаще всего переменная не заведена в списке).

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

Код	Когда
`201`	Все записи добавлены, ошибок и предупреждений нет
`207`	Часть записей не добавлена (непустой `failed`) или есть предупреждения (непустой `warnings`)
`401`	Ключ API не передан или неверен, тело ответа пустое
`429`	Превышен лимит 2000 запросов в минуту
`503`	Сервис временно не смог обработать запрос, повторите через небольшую паузу

Предупреждения по переменным

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

Когда возникает	Текст
Переменной нет в списке	Переменная \"имя\" не найдена и была пропущена.
В целочисленную переменную передано не целое число	Значение \"...\" не является целым числом и было пропущено.
В числовую переменную передано не число	Значение \"...\" не является числом и было пропущено.
Некорректная дата или год меньше 1900	Значение \"...\" не является корректной датой и было пропущено.
Некорректная дата-время	Значение \"...\" не является корректной датой/временем и было пропущено.
Логическое значение не из списка да/true/yes/нет/false/no	Значение \"...\" не является логическим значением и было пропущено.
Строка не является корректным JSON (JSON-переменная)	Значение \"...\" не является корректным JSON и было пропущено.
В значении найден html, а html не включён	В значении переменной \"имя\" обнаружен html-код; значение не записано.

Возможные ошибки

400 We have already sent a subscription confirmation email to this email. Resending is possible in 1 hour. — слишком много запросов на реактивацию имейла, повтор через час.
Email to many add method — при частых запросах второй запрос на тот же имейл не дождался обработки первого.

Пример curl

curl --location --request POST 'https://mailganer.com/api/v3/emails/' \\\n--header 'Authorization: CodeRequest ' \\\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

📄 Документация: https://documentation.mailganer.ru/documentation/email/add/mass_v3

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ad2a6101-55ec-46be-9158-ec0369852183","id":"ad2a6101-55ec-46be-9158-ec0369852183","name":"REST API Mailganer","type":"collection"}},"urlObject":{"path":["api","v3","emails",""],"host":["https://mailganer.com"],"query":[],"variable":[]}},"response":[{"id":"528690a2-aa10-44da-b202-dbc29fe652b7","name":"Все записи добавлены","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"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"}}},"url":"https://mailganer.com/api/v3/emails/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"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}"},{"id":"195c377d-a456-461a-9b8f-5c55619aaa7d","name":"Часть записей не добавлена или есть предупреждения","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"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"}}},"url":"https://mailganer.com/api/v3/emails/"},"status":"Multi-Status (WebDAV) (RFC 4918)","code":207,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"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}"},{"id":"7cf5bd23-f8ef-4d9b-a781-3cae60373d56","name":"Ключ API не передан или неверен, тело пустое","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"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"}}},"url":"https://mailganer.com/api/v3/emails/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"6f50d3ad-9ba7-49b9-8922-20e08ec5d328","name":"Превышен лимит 2000 запросов в минуту","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"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"}}},"url":"https://mailganer.com/api/v3/emails/"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"1888eec9-28e9-4be2-af4b-01c968c5ab45","name":"Сервис временно недоступен, повторите запрос позже","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"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"}}},"url":"https://mailganer.com/api/v3/emails/"},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"1d4e94c8-eda6-4080-8b32-55cc79c77947"}],"id":"2a938313-d6f7-44f8-82d6-2342d2f707bc","description":"

Управление подписчиками (добавление, обновление, отписка, валидация)

\n","_postman_id":"2a938313-d6f7-44f8-82d6-2342d2f707bc","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ad2a6101-55ec-46be-9158-ec0369852183","id":"ad2a6101-55ec-46be-9158-ec0369852183","name":"REST API Mailganer","type":"collection"}}},{"name":"Списки","item":[{"name":"Создать список","id":"65fd1544-681c-4da9-8114-e6d5eadce5c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"domain\": \"test2\"\n}","options":{"raw":{"language":"json"}}},"url":"https://mailganer.com/api/v2/sites/","description":"

Создаёт новый список рассылки.

Эндпоинт: POST https://mailganer.com/api/v2/sites/
Авторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)
Content-Type: application/json

Тело запроса

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

Поле	Тип	Обяз.	Описание
`domain`	string	да	Название списка

Пример curl

curl --location --request POST 'https://mailganer.com/api/v2/sites/' \\\n--header 'Authorization: CodeRequest ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n    \"domain\": \"test2\"\n}'\n\n

Примечания

В ответе возвращается объект созданного списка, включая его id.
\n
Поле domain не должно содержать недопустимые символы (например <, >).
\n
Комбинация полей domain и user должна быть уникальной (иначе non_field_errors).
\n

📄 Документация: https://documentation.mailganer.ru/documentation/sites/post

Возвращает постраничный массив списков рассылки аккаунта.

Эндпоинт: GET https://mailganer.com/api/v2/sites/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)

Query-параметры

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

Поле	Тип	Обяз.	Описание
`simple`	bool	нет	Если `true`, возвращаются только основные поля (`id` и `domain`). По умолчанию `false`

Пример curl

curl --location --request GET 'https://mailganer.com/api/v2/sites/' \\\n--header 'Authorization: CodeRequest '\n

Примечания

Ответ постраничный: поля count, next, previous, results.
Стандартный элемент results содержит: id, domain, domain_ext, logo, user, click_domain, count_emails, count_emails_active.
При simple=true элемент results содержит только id и domain.

📄 Документация: https://documentation.mailganer.ru/documentation/sites/get

Если true — вернуть только id и domain (по умолчанию false)

\n","type":"text/plain"},"key":"simple","value":"true"}],"variable":[]}},"response":[{"id":"bb46817d-f378-42ed-a7fa-71e6d1c94ce6","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://mailganer.com/api/v2/sites/?simple=true","host":["https://mailganer.com"],"path":["api","v2","sites",""],"query":[{"key":"simple","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","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"}],"cookie":[],"responseTime":null,"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}"}],"_postman_id":"4f9f3942-898d-4e24-9bf2-1d33c4315afe"},{"name":"Проверка верификации домена","id":"371a872f-f834-4482-925d-7b2e3ec35369","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://mailganer.com/api/v2/sites/verify_domain/?domain=mailganer.com","description":"

Проверяет статус верификации домена списка (SPF, DMARC, DKIM).

Эндпоинт: GET https://mailganer.com/api/v2/sites/verify_domain/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)

Query-параметры

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

Поле	Тип	Обяз.	Описание
`domain`	string	да	Домен, который необходимо проверить

Пример curl

curl --location --request GET 'https://mailganer.com/api/v2/sites/verify_domain/?domain=mailganer.com' \\\n--header 'Authorization: CodeRequest '\n

Примечания

Ответ содержит булевы поля: verification_status (общий статус верификации), spf_status, dmarc_status, dkim_status.

📄 Документация: https://documentation.mailganer.ru/documentation/sites/verify_domain

Домен, который необходимо проверить

\n","type":"text/plain"},"key":"domain","value":"mailganer.com"}],"variable":[]}},"response":[{"id":"5b0b7b45-419c-42b1-83d7-de8a717addef","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://mailganer.com/api/v2/sites/verify_domain/?domain=mailganer.com","host":["https://mailganer.com"],"path":["api","v2","sites","verify_domain",""],"query":[{"key":"domain","value":"mailganer.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","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"}],"cookie":[],"responseTime":null,"body":"{\n \"verification_status\": true,\n \"spf_status\": true,\n \"dmarc_status\": true,\n \"dkim_status\": true\n}"}],"_postman_id":"371a872f-f834-4482-925d-7b2e3ec35369"},{"name":"Задать ссылку на webhook","id":"fc37b06c-772e-462f-abcd-6da1fd95ff3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"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"}}},"url":"https://mailganer.com/api/v2/sites/set_webhook","description":"

Задаёт (или обновляет) URL webhook для списка и параметры его работы.

Эндпоинт: POST https://mailganer.com/api/v2/sites/set_webhook\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)\nContent-Type: application/json

Тело запроса

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

Поле	Тип	Обяз.	Описание
`id`	string	да	ID списка (можно узнать в настройках списка: https://mailganer.com/app/settings/)
`url`	string	да	URL, на который отправляются события (webhook)
`is_active`	bool	нет	Включает/отключает отправку событий на webhook
`is_use_auth_key`	bool	нет	Включает/отключает отправку ключа авторизации в заголовке `Authorization`
`is_enable_retry`	bool	нет	Включает/отключает повторы, если URL хука недоступен

Пример curl

curl --location --request POST 'https://mailganer.com/api/v2/sites/set_webhook' \\\n--header 'Authorization: CodeRequest ' \\\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

Примечания

Повторы (is_enable_retry) выполняются тремя попытками при ошибке эндпоинта: через 5 секунд, 1 час и 24 часа.
Активировать webhook также можно в настройках списка на вкладке «Интеграции».
При is_use_auth_key=true ключ авторизации передаётся в заголовке Authorization.

📄 Документация: https://documentation.mailganer.ru/documentation/sites/set_webhook_url

Работа со списками рассылки и их настройками

\n","_postman_id":"d9b42d23-38aa-4cff-8cbe-c424c12bb5ea","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ad2a6101-55ec-46be-9158-ec0369852183","id":"ad2a6101-55ec-46be-9158-ec0369852183","name":"REST API Mailganer","type":"collection"}}},{"name":"Сегменты","item":[{"name":"Создать сегмент","id":"b8286ddb-ed39-4f7e-9d06-3cb5e3a7a12f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"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"}}},"url":"https://mailganer.com/api/v2/segments/","description":"

Создаёт сегмент подписчиков по заданным условиям.

Эндпоинт: POST https://mailganer.com/api/v2/segments/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)\nContent-Type: application/json

Тело запроса

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

Поле	Тип	Обяз.	Описание
`title`	string	да	Название сегмента
`conditions`	array	да	Массив условий сегментации
`conditions[].condition`	int	да	Тип условия (например, `6` — «Метка», `5` — «Список»)
`conditions[].type_value`	int	да	Тип значения (`4` — «Равна одной из», `5` — «Не равна одной из»)
`conditions[].value`	array	да	Значения условия

Пример curl

curl --location --request POST 'https://mailganer.com/api/v2/segments/' \\\n--header 'Authorization: CodeRequest ' \\\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

Примечания

В ответе возвращаются status, segment_url (ссылка на созданный сегмент) и segment_id.

📄 Документация: https://documentation.mailganer.ru/documentation/segments/sozdanie-segmenta

Возвращает постраничный массив сегментов аккаунта.

Эндпоинт: GET https://mailganer.com/api/v2/segments/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)

Пример curl

curl --location --request GET 'https://mailganer.com/api/v2/segments/' \\\n--header 'Authorization: CodeRequest '\n

Примечания

Ответ постраничный: поля count, next, previous, results; переход по страницам — через next/previous (параметр page).
Элемент results содержит: title, id, cnt_email, cnt_active_email, created.
Метод не описан в публичной документации.

📄 Документация (раздел API): https://documentation.mailganer.ru/documentation/api

Возвращает информацию об одном сегменте по его ID.

Эндпоинт: GET https://mailganer.com/api/v2/segments/:segment_id\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)

Path-параметры

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

Поле	Тип	Обяз.	Описание
`segment_id`	int	да	ID сегмента

Пример curl

curl --location --request GET 'https://mailganer.com/api/v2/segments/12345' \\\n--header 'Authorization: CodeRequest '\n

Примечания

Ответ содержит: title, id, cnt_email, cnt_active_email, created.
Метод не описан в публичной документации.

📄 Документация (раздел API): https://documentation.mailganer.ru/documentation/api

(Required)

\n","type":"text/plain"},"type":"any","value":"12345","key":"segment_id"}]}},"response":[{"id":"46eac6ba-e659-4f23-ab6d-f8cddbe93219","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://mailganer.com/api/v2/segments/:segment_id","host":["https://mailganer.com"],"path":["api","v2","segments",":segment_id"],"variable":[{"key":"segment_id","value":"12345","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","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"}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"Название сегмента\",\n \"id\": 12345,\n \"cnt_email\": 1,\n \"cnt_active_email\": 1,\n \"created\": \"2022-12-05T11:26:44.465956\"\n}"}],"_postman_id":"a4dcf877-e665-4065-867e-873c563f535d"},{"name":"Отправка триггера на сегмент","id":"b03e7fad-3903-4c0f-99c8-4df67eb797eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"trigger_id\": 34521\n}","options":{"raw":{"language":"json"}}},"url":"https://mailganer.com/api/v2/segments/:segment_id/send_trigger/","description":"

Запускает отправку триггерного письма подписчикам указанного сегмента.

Эндпоинт: POST https://mailganer.com/api/v2/segments/:segment_id/send_trigger/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)\nContent-Type: application/json

Path-параметры

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

Поле	Тип	Обяз.	Описание
`segment_id`	int	да	ID сегмента, по которому запускается триггер

Тело запроса

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

Поле	Тип	Обяз.	Описание
`trigger_id`	int	да	ID триггера, который необходимо отправить

Пример curl

curl --location --request POST 'https://mailganer.com/api/v2/segments/12345/send_trigger/' \\\n--header 'Authorization: CodeRequest ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n    \"trigger_id\": 34521\n}'\n

Примечания

Метод не описан в публичной документации.

📄 Документация (раздел API): https://documentation.mailganer.ru/documentation/api

(Required)

\n","type":"text/plain"},"type":"any","value":"enim veniam ipsum","key":"segment_id"}]}},"response":[],"_postman_id":"b03e7fad-3903-4c0f-99c8-4df67eb797eb"}],"id":"bd55632a-126c-4fe6-a17c-045bdc253222","description":"

Создание и получение сегментов подписчиков

\n","_postman_id":"bd55632a-126c-4fe6-a17c-045bdc253222","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ad2a6101-55ec-46be-9158-ec0369852183","id":"ad2a6101-55ec-46be-9158-ec0369852183","name":"REST API Mailganer","type":"collection"}}},{"name":"Переменные","item":[{"name":"Добавление пользовательской переменной","id":"194528c1-92e6-41e7-b4c3-61212e70bb3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"source\": 1,\n \"title\": \"Название переменной\",\n \"type\": 0,\n \"name\": \"my_var\"\n}","options":{"raw":{"language":"json"}}},"url":"https://mailganer.com/api/v2/user_vars/","description":"

Добавляет пользовательскую переменную в указанный список.

Эндпоинт: POST https://mailganer.com/api/v2/user_vars/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)\nContent-Type: application/json

Тело запроса

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

Поле	Тип	Обяз.	Описание
`source`	Целое число	✔	ID списка, в который добавляется переменная
`title`	Строка	✔	Название переменной
`type`	Целое число	✔	Тип переменной (допустимые значения — в таблице ниже)
`name`	Строка	—	Имя переменной. Если не задано, формируется автоматически и возвращается в ответе

Пример curl

curl --location 'https://mailganer.com/api/v2/user_vars/' \\\n--header 'Authorization: CodeRequest ' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"source\": 1,\n    \"title\": \"Название переменной\",\n    \"type\": 0\n}'\n

Примечания

Значения поля type:

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

id типа	Тип переменной	Пример
0	Строка	Текст
1	Целое число	12
2	Вещественное число	1.5
3	Дата	22.07.2021
4	Дата и время	22.07.2021 16:03:00
6	Логический тип	true или false
8	Json-массив	{\"a\": 1, \"b\": \"два\", \"c\": [1, 2]}

Ответ содержит поля: source (ID списка), title (название), name (имя переменной), type (тип), type_text (тип текстом).
\n

📄 Документация: https://documentation.mailganer.ru/documentation/user_var/add

Возвращает список пользовательских переменных списка (или всех списков).

Эндпоинт: GET https://mailganer.com/api/v2/user_vars/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)

Query-параметры

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

Поле	Тип	Обяз.	Описание
`source`	Целое число	—	ID списка. Если не указан — возвращаются переменные всех списков

Пример curl

curl --location 'https://mailganer.com/api/v2/user_vars/?source=1' \\\n--header 'Authorization: CodeRequest '\n

Примечания

Ответ постраничный: count (количество переменных), next / previous (ссылки на соседние страницы, null — если страницы нет), results (массив переменных).
\n
Поля объекта в results: source (ID списка), title (название), name (системное имя для подстановки в шаблонах), type (тип), is_global (false — локальная, true — глобальная переменная).
\n
По умолчанию API отдаёт по 25 записей на страницу.
\n

Значения поля type:

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

id типа	Тип переменной	Пример
0	Строка	Текст
1	Целое число	12
2	Вещественное число	1.5
3	Дата	22.07.2021
4	Дата и время	22.07.2021 16:03:00
6	Логический тип	true или false
8	Json-массив	{\"a\": 1, \"b\": \"два\", \"c\": [1, 2]}

📄 Документация: https://documentation.mailganer.ru/documentation/user_var/get

ID списка. Если не указан — переменные всех списков

\n","type":"text/plain"},"key":"source","value":"1"}],"variable":[]}},"response":[{"id":"2d2a912f-cdec-41c9-8fe3-f38b4efc41f4","name":"Успех (200)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://mailganer.com/api/v2/user_vars/?source=1","host":["https://mailganer.com"],"path":["api","v2","user_vars",""],"query":[{"key":"source","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"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}"}],"_postman_id":"1895009e-03fb-4263-b7ea-beca16288981"}],"id":"636b7387-6cd2-465f-98f3-1d8ae44b51ef","description":"

Пользовательские переменные подписчиков

\n","_postman_id":"636b7387-6cd2-465f-98f3-1d8ae44b51ef","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ad2a6101-55ec-46be-9158-ec0369852183","id":"ad2a6101-55ec-46be-9158-ec0369852183","name":"REST API Mailganer","type":"collection"}}},{"name":"Теги","item":[{"name":"Добавление тега","id":"f01577dc-8825-49d3-9641-fe52d2257031","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"название_тега\"\n}","options":{"raw":{"language":"json"}}},"url":"https://mailganer.com/api/v2/tags/","description":"

Добавляет новый тег.

Эндпоинт: POST https://mailganer.com/api/v2/tags/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)\nContent-Type: application/json

Тело запроса

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

Поле	Тип	Обяз.	Описание
`name`	Строка	✔	Имя тега. Длина не более 140 символов

Пример curl

curl --location 'https://mailganer.com/api/v2/tags/' \\\n--header 'Authorization: CodeRequest ' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"name\": \"название_тега\"\n}'\n

Примечания

Ответ содержит поля: id (идентификатор тега), name (имя тега).
Возможные ошибки:
- 400 — The selected tag name is already in use — тег с таким названием уже есть в системе.
- 400 — The tag name must not exceed 140 characters — длина name более 140 символов.
\n

📄 Документация: https://documentation.mailganer.ru/documentation/tags/add

Возвращает список тегов.

Эндпоинт: GET https://mailganer.com/api/v2/tags/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)

Пример curl

curl --location 'https://mailganer.com/api/v2/tags/' \\\n--header 'Authorization: CodeRequest '\n

Примечания

Ответ постраничный: count (количество тегов), next / previous (ссылки на соседние страницы), results (массив тегов).
Поля объекта в results: id (идентификатор тега), name (название тега).

📄 Документация: https://documentation.mailganer.ru/documentation/tags/get

Управление тегами подписчиков

\n","_postman_id":"776f3bc1-8ca2-4df5-a021-0226a79462fd","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ad2a6101-55ec-46be-9158-ec0369852183","id":"ad2a6101-55ec-46be-9158-ec0369852183","name":"REST API Mailganer","type":"collection"}}},{"name":"Рассылки","item":[{"name":"Создание рассылки","id":"e24bc16e-6183-461f-9ba2-417c57c18eb6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"api_key","value":"","type":"text","description":"

(Required) Ключ API из профиля

\n"},{"key":"name","value":"Новая рассылка","type":"text","description":"

Название рассылки

\n"},{"key":"theme","value":"Тема письма","type":"text","description":"

Тема рассылки

\n"},{"key":"from_email","value":"info@example.com","type":"text","description":"

Имейл отправителя

\n"},{"key":"from_name","value":"Mailganer","type":"text","description":"

Имя отправителя

\n"},{"key":"segment_id","value":"123456","type":"text","description":"

ID сегмента

\n"},{"key":"html-content","value":"Привет!","type":"text","description":"

Вёрстка рассылки

\n"}]},"url":"https://mailganer.com/api/v1/mailing/create/","description":"

Создаёт черновик рассылки — возвращает ссылку на редактирование и public_id.

Эндпоинт: POST https://mailganer.com/api/v1/mailing/create/\nАвторизация: noauth — API-ключ передаётся в теле запроса в поле api_key\nContent-Type: multipart/form-data (form-data)

Тело запроса (form-data)

Поле	Тип	Обяз.	Описание
`api_key`	string	✔	Ключ API из профиля
`name`	string		Название рассылки, максимум 150 символов
`html-content`	string		Вёрстка рассылки
`template_id`	string		UID шаблона со страницы `https://mailganer.com/app/custom-templates/`
`amp-html-content`	string		Вёрстка AMP-рассылки
`zip-content`	string		Ссылка на архив с вёрсткой
`amp-zip-content`	string		Ссылка на архив с AMP-вёрсткой
`theme`	string		Тема рассылки
`from_name`	string		Имя отправителя
`from_email`	string		Имейл отправителя
`segment_id`	int		ID сегмента
`utm_campaign`	string		Если не передано — формируется как `{{year}}{{month}}{{day}}_{{public_id}}` (год, месяц, день отправки и ID рассылки)
`utm_source`	string		Если не передано — `\"mailganer\"`
`utm_medium`	string		Если не передано — `\"email\"`
`user_utms`	JSON-строка		Кастомные UTM-метки, формат `{\"param1\":\"value1\",\"param2\":\"value2\"}`
`variables`	JSON-строка		Динамические переменные, формат `{\"var1\":\"value1\",\"var2\":123}`; имеют приоритет над переменными подписчика

Пример curl

curl --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

Примечания

В вёрстке письма можно одновременно использовать переменные из запроса (variables) и переменные подписчика (например {{name}}); значение, не обязательное для хранения в Mailganer (например delivery_address), можно передать в запросе и подставить как {{delivery_address}}.
При передаче вёрстки в html-content заменить символы: &→%26, \"→%22, \\→%27, <→%3C, >→%3E.
Архив в zip-content — только .zip; размер архива должен быть более 7 Мб; внутри обязателен html-файл.
Поля ответа: status (1 — успех, -1 — нет), status_text (success/error), public_id, step1_url, error.
Возможные значения 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.

📄 Документация: https://documentation.mailganer.ru/documentation/mailing/create

Отправляет рассылку — сразу или в запланированное время.

Эндпоинт: POST https://mailganer.com/api/v2/mailing/send/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)\nContent-Type: application/json

Тело запроса

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

Поле	Тип	Обяз.	Описание
`public_id`	int	✔	ID рассылки
`datetime_send`	string		Дата/время отправки в формате `DD.MM.YYYY HH:MM`, например `16.02.2024 17:00`
`is_chunked`	bool		Включить распределённую отправку. Для сегментов больше 5 000 получателей. Недоступно при A/Б тестировании темы письма
`chunk_size`	int		Количество подписчиков в одной отправке. Значения вне допустимого диапазона система может скорректировать самостоятельно
`chunk_timeout`	int		Перерыв между отправками. Разрешённые значения: `15`, `30`, `60`, `90` минут

Пример curl

curl --location 'https://mailganer.com/api/v2/mailing/send/' \\\n--header 'Authorization: CodeRequest ' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"public_id\": 155959878052,\n    \"datetime_send\": \"16.02.2024 17:00\"\n}'\n

Примечания

Параметры chunk_size и chunk_timeout требуют is_chunked=True (иначе ошибка Parameters 'chunk_size' and 'chunk_timeout' require 'is_chunked=True').
Поля ответа: статус (success), status_text (Mailing has been sent for moderation или Mailing has been sent), error.
Возможные значения ошибок (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'.
Возможные ошибки уровня запроса: invalid http method (метод не POST); invalid post values (не задана обязательная переменная); invalid api key (неправильный апи-ключ).

📄 Документация: https://documentation.mailganer.ru/documentation/mailing/send

Возвращает подробную информацию о конкретной рассылке.

Эндпоинт: GET https://mailganer.com/api/v2/mailing/:public_id\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)

Path-параметры

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

Поле	Тип	Обяз.	Описание
`public_id`	int	✔	ID рассылки

Пример curl

curl --location 'https://mailganer.com/api/v2/mailing/166775985258' \\\n--header 'Authorization: CodeRequest '\n

Примечания

Поля ответа (json):

public_id (int) — ID рассылки
datetime_send (string) — время отправки (datetime)
send (string) — время отправки
name (string) — название рассылки
subject (string) — тема рассылки
subject2 (string) — вторая тема рассылки (актуально для А/Б-тестов)
segment_name (string) — название сегмента
segment_id (int) — ID сегмента
from_name (string) — имя отправителя
from_email (string) — имейл отправителя
utm_campaign (string) — значение URL-параметра utm_campaign
utm_source (string) — значение URL-параметра utm_source
utm_medium (string) — значение URL-параметра utm_medium
text (string) — HTML-контент письма в виде строки
count_spam (int) — количество жалоб на спам
count_unsubscribe (int) — количество отписок
count_click (int) — количество кликов
count_open (int) — количество открытий
count_delivery (int) — количество доставленных писем
count_sent (int) — количество отправленных писем
webversion (string) — ссылка на вебверсию письма
user_utms (array) — пользовательские переменные
preheader (string) — прехедер письма
clickmap (string) — ссылка на карту кликов

📄 Документация: https://documentation.mailganer.ru/documentation/mailing/get

(Required) public_id рассылки вы можете увидеть в личном кабинете, открыв эту рассылку в браузере

\n","type":"text/plain"},"type":"any","value":"enim veniam ipsum","key":"public_id"}]}},"response":[{"id":"92ccd28b-a006-4134-80e1-b25705f23750","name":"Получение информации о рассылке","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://mailganer.com/api/v2/mailing/:public_id","host":["https://mailganer.com"],"path":["api","v2","mailing",":public_id"],"variable":[{"key":"public_id","value":"enim veniam ipsum","description":"(Required) public_id рассылки вы можете увидеть в личном кабинете, открыв эту рассылку в браузере"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"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}"}],"_postman_id":"b34e5134-2057-4ccd-bd64-9267b45b2403"},{"name":"Получить список рассылок","id":"d8dd5710-8e2d-4a30-bdf1-a1487a319f4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://mailganer.com/api/v2/mailing/?start_date=2024-04-01&end_date=2024-04-13","description":"

Возвращает список рассылок за указанный период.

Эндпоинт: GET https://mailganer.com/api/v2/mailing/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)

Query-параметры

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

Поле	Тип	Обяз.	Описание
`start_date`	date		Дата начала периода, за который возвращать список рассылок
`end_date`	date		Дата окончания периода, за который возвращать список рассылок

Пример curl

curl --location 'https://mailganer.com/api/v2/mailing/?start_date=2024-04-01&end_date=2024-04-13' \\\n--header 'Authorization: CodeRequest '\n

Примечания

Поля ответа (json):

count (int) — количество пользователей
next (url) — ссылка на следующую страницу
previous (url) — ссылка на предыдущую страницу
results (json-массив) — список рассылок

Содержимое массива results:

datetime_send (дата и время) — планируемое время отправки
send (дата и время) — время начала отправки
count_sent (int) — получателей в рассылке
count_delivery (int) — доставленных писем
count_spam (int) — жалоб на спам
count_unsubscribe (int) — отписались
count_click (int) — кликнули в рассылке
count_open (int) — открыли
public_id (int) — ID рассылки
Created (дата и время) — дата создания рассылки
name (string) — название рассылки
subject (string) — тема рассылки
subject2 (string) — вторая тема рассылки
preheader (string) — прехедер
segment_name (string) — название сегмента
segment_id (int) — ID сегмента
excluding_segments (int) — ID исключающего сегмента
from_name (string) — имя отправителя
from_email (string) — email отправителя
text — HTML-код верстки письма
webversion (url) — веб-версия письма
clickmap (url) — карта кликов
status_str (string) — статус рассылки

📄 Документация: https://documentation.mailganer.ru/documentation/mailing/get_id

Дата начала периода, за который возвращать список рассылок

\n","type":"text/plain"},"key":"start_date","value":"2024-04-01"},{"description":{"content":"

Дата окончания периода, за который возвращать список рассылок

\n","type":"text/plain"},"key":"end_date","value":"2024-04-13"}],"variable":[]}},"response":[{"id":"3e5dae0d-3399-4d45-88b1-005336572e93","name":"Ошибка","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://mailganer.com/api/v2/mailing/?start_date=2024-04-01&end_date=2024-04-13","host":["https://mailganer.com"],"path":["api","v2","mailing",""],"query":[{"key":"start_date","value":"2024-04-01"},{"key":"end_date","value":"2024-04-13"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","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"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"error\": \"Учетные данные не были предоставлены.\"\n}"}],"_postman_id":"d8dd5710-8e2d-4a30-bdf1-a1487a319f4a"},{"name":"Статистика по рассылке","id":"f508de22-2589-4a50-a5ea-17b464e9293d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://mailganer.com/api/v2/mailing/:public_id/stat/?start_date=2023-12-11&end_date=2023-12-13","description":"

Возвращает статистику по рассылке — в разрезе дней и суммарно за период.

Эндпоинт: GET https://mailganer.com/api/v2/mailing/:public_id/stat/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)

Path-параметры

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

Поле	Тип	Обяз.	Описание
`public_id`	int	✔	ID рассылки

Query-параметры

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

Поле	Тип	Обяз.	Описание
`start_date`	string		Дата начала в формате `YYYY-MM-DD`
`end_date`	string		Дата конца в формате `YYYY-MM-DD`

Пример curl

curl --location 'https://mailganer.com/api/v2/mailing/459562475965/stat/?start_date=2023-12-11&end_date=2023-12-13' \\\n--header 'Authorization: CodeRequest '\n

Примечания

Если параметры не указаны — возвращается общая статистика по рассылке за каждый день, а также суммарная статистика за весь период.
Если один из параметров start_date/end_date не указан — возвращается общая статистика за каждый день плюс суммарная за весь период.
Если указаны обе даты — возвращаются данные за указанный период (включая последний день) в разрезе дней плюс суммарная за период статистика.

Поля ответа (json):

count_sent — отправлено
count_delivery — доставлено
count_spam — пожаловались на спам
count_unsubscribe — отписались
count_click — кликнули
count_open — открыли

📄 Документация: https://documentation.mailganer.ru/documentation/mailing/stat

Дата начала в формате YYYY-MM-DD

\n","type":"text/plain"},"key":"start_date","value":"2023-12-11"},{"description":{"content":"

Дата конца в формате YYYY-MM-DD

\n","type":"text/plain"},"key":"end_date","value":"2023-12-13"}],"variable":[{"id":"4dce2558-7bdb-4f91-8b10-596963b71866","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"enim veniam ipsum","key":"public_id"}]}},"response":[{"id":"387a28ef-2a4e-4f9d-975c-a9ef359034a2","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://mailganer.com/api/v2/mailing/:public_id/stat/?start_date=2023-12-11&end_date=2023-12-13","host":["https://mailganer.com"],"path":["api","v2","mailing",":public_id","stat",""],"query":[{"key":"start_date","value":"2023-12-11"},{"key":"end_date","value":"2023-12-13"}],"variable":[{"key":"public_id","value":"enim veniam ipsum","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"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]"}],"_postman_id":"f508de22-2589-4a50-a5ea-17b464e9293d"}],"id":"f42ac6e1-9019-4243-8f0c-a7a6d17f1eea","description":"

Создание, отправка и статистика рассылок

\n","_postman_id":"f42ac6e1-9019-4243-8f0c-a7a6d17f1eea","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ad2a6101-55ec-46be-9158-ec0369852183","id":"ad2a6101-55ec-46be-9158-ec0369852183","name":"REST API Mailganer","type":"collection"}}},{"name":"Триггеры","item":[{"name":"Отправка триггера","id":"63033de6-d8f7-45c2-b136-25ba65682e03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"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"}}},"url":"https://mailganer.com/api/v2/triggers/:trigger_id/send/","description":"

Отправляет триггерное письмо (или SMS) конкретному подписчику по его имейлу.

Эндпоинт: POST https://mailganer.com/api/v2/triggers/:trigger_id/send/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)\nContent-Type: application/json

Path-параметры

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

Поле	Тип	Обяз.	Описание
`trigger_id`	int	Да	ID триггера

Тело запроса

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

Поле	Тип	Обяз.	Описание
`email`	string	Да	Имейл получателя
`phone`	string	Нет	Телефон получателя (для SMS-триггера)
`trigger_content`	string	Нет	Своё содержимое письма (UTF-8), переопределяет контент из кабинета
`trigger_theme`	string	Нет	Своя тема письма (UTF-8), переопределяет тему из кабинета
`ignore_wait`	bool	Нет	Отправить, несмотря на статус «ожидает подтверждения»
`ignore_unsubscribed`	bool	Нет	Отправить, несмотря на статус «отписан»
`ignore_spam`	bool	Нет	Отправить, несмотря на жалобу на спам
`doi_ok`	bool	Нет	Добавить подписчика как «Активный» перед отправкой
`send_now`	bool	Нет	Игнорировать настройку отложенной отправки
`variables`	array/object	Нет	Переменные шаблона письма (одномерные и многомерные массивы)
`update_variables`	bool	Нет	Обновить переменные подписчика (требует активации)
`sender_email`	string	Нет	Свой адрес отправителя (требует `sender_name`)
`sender_name`	string	Нет	Имя отправителя в поле From

Пример curl

curl --location 'https://mailganer.com/api/v2/triggers/1111/send/' \\\n--header 'Authorization: CodeRequest ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n    \"email\": \"test@example.com\"\n}'\n

Примечания

Рекомендуемая частота вызовов — не более 300 в минуту.
variables поддерживает одномерные и многомерные массивы; язык шаблонов — Django-подобный синтаксис с операторами {% for %}, {% if %}.
Нельзя размещать {% for %} или {% if %} между тегами <table> и <td>.
sender_email принимается только если отправитель существует в аккаунте и подтверждён (верифицирован).
По умолчанию doi_ok, ignore_unsubscribed, ignore_spam, update_variables отключены — активация через поддержку.
Ответ: status (1 — отправлено, -1 — ошибка, 0 — системная ошибка), status_text (success/error), result (уникальный ID отправки для запроса статистики), error (описание ошибки).
Возможные ошибки: 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 (подписчик не проходит условия).

📄 Документация: https://documentation.mailganer.ru/documentation/trigger/send/v2

(Required) ID триггера

\n","type":"text/plain"},"type":"any","value":"","key":"trigger_id"}]}},"response":[{"id":"ab3eb2b1-8fa0-451c-8163-468dc4128d3e","name":"Успешная отправка","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"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"}}},"url":{"raw":"https://mailganer.com/api/v2/triggers/:trigger_id/send/","host":["https://mailganer.com"],"path":["api","v2","triggers",":trigger_id","send",""],"variable":[{"key":"trigger_id","value":"","description":"(Required) ID триггера"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 1,\n \"updated_variables\": [],\n \"status_text\": \"Success. Complete on 0.453127 sec.\",\n \"result\": 191015674\n}"}],"_postman_id":"63033de6-d8f7-45c2-b136-25ba65682e03"},{"name":"Статистика триггера","id":"016115fa-0450-4746-9903-5acb144afeff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://mailganer.com/api/v2/triggers/:trigger_id/stat/?start_date=2022-08-01&end_date=2023-08-03","description":"

Возвращает статистику по триггеру: суммарную или в разрезе дней за период.

Эндпоинт: GET https://mailganer.com/api/v2/triggers/:trigger_id/stat/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)

Path-параметры

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

Поле	Тип	Обяз.	Описание
`trigger_id`	int	Да	ID триггера

Query-параметры

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

Поле	Тип	Обяз.	Описание
`start_date`	string	Нет	Дата начала в формате `YYYY-MM-DD`
`end_date`	string	Нет	Дата конца в формате `YYYY-MM-DD`

Пример curl

curl --location 'https://mailganer.com/api/v2/triggers/1111/stat/?start_date=2022-08-01&end_date=2023-08-03' \\\n--header 'Authorization: CodeRequest '\n

Примечания

Без параметров дат — возвращается суммарная статистика по триггеру (объект summary).
Если передан только один из параметров (start_date или end_date) — также возвращается суммарная статистика.
Если переданы оба параметра — данные за указанный период (включая последний день) в разрезе дней плюс блок summary.
Поля статистики: delivered (доставлено), clicked (клики), opened (открытия), not_available (недоступно), unsubscribed (отписки), spammed (жалобы на спам), sent (отправлено).

📄 Документация: https://documentation.mailganer.ru/documentation/trigger/stat/v2

Дата начала в формате YYYY-MM-DD

\n","type":"text/plain"},"key":"start_date","value":"2022-08-01"},{"description":{"content":"

Дата конца в формате YYYY-MM-DD

\n","type":"text/plain"},"key":"end_date","value":"2023-08-03"}],"variable":[{"id":"96aacd3b-482b-4994-8501-d3e02bd39a5a","description":{"content":"

(Required) ID триггера

\n","type":"text/plain"},"type":"any","value":"1111","key":"trigger_id"}]}},"response":[{"id":"fd366e1b-74be-4b92-8b2f-63885c0c7bbb","name":"С датой","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mailganer.com/api/v2/triggers/:trigger_id/stat/?start_date=2022-08-01&end_date=2023-08-03","host":["https://mailganer.com"],"path":["api","v2","triggers",":trigger_id","stat",""],"query":[{"key":"start_date","value":"2022-08-01"},{"key":"end_date","value":"2023-08-03"}],"variable":[{"key":"trigger_id","value":"1111","description":"(Required) ID триггера"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"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}"},{"id":"826b9a3b-690f-4d81-8d1f-ed1e1966f825","name":"Ошибка авторизации","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mailganer.com/api/v2/triggers/:trigger_id/stat/?start_date=2022-08-01&end_date=2023-08-03","host":["https://mailganer.com"],"path":["api","v2","triggers",":trigger_id","stat",""],"query":[{"key":"start_date","value":"2022-08-01"},{"key":"end_date","value":"2023-08-03"}],"variable":[{"key":"trigger_id","value":"1111","description":"(Required) ID триггера"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","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"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"error\": \"Недопустимый токен.\"\n}"},{"id":"5b1ea526-6b32-4c79-8c76-6896f4b685c5","name":"Триггер не найден","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mailganer.com/api/v2/triggers/:trigger_id/stat/?start_date=2022-08-01&end_date=2023-08-03","host":["https://mailganer.com"],"path":["api","v2","triggers",":trigger_id","stat",""],"query":[{"key":"start_date","value":"2022-08-01"},{"key":"end_date","value":"2023-08-03"}],"variable":[{"key":"trigger_id","value":"1111","description":"(Required) ID триггера"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","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"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"error\": \"Не найдено.\"\n}"}],"_postman_id":"016115fa-0450-4746-9903-5acb144afeff"},{"name":"Получение статистики по отправке триггера","id":"ec9a8bed-9869-461f-8384-d68140b6459f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"\",\n \"id_list\": [\n 123,\n 456\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://mailganer.com/api/v1/trigger/id_stat/","description":"

Возвращает статусы доставки по списку ID отправок триггера (пакетно).

Эндпоинт: POST https://mailganer.com/api/v1/trigger/id_stat/\nАвторизация: без авторизации (noauth); API-ключ передаётся в теле запроса в поле api_key\nContent-Type: application/json

Тело запроса

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

Поле	Тип	Обяз.	Описание
`api_key`	string	Да	API-ключ (см. https://mailganer.com/app/profile/settings/api/)
`id_list`	array	Да	Список ID отправок для пакетного получения статусов

Пример curl

curl --location 'https://mailganer.com/api/v1/trigger/id_stat/' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"api_key\": \"\",\n    \"id_list\": [123, 456]\n}'\n

Примечания

Максимум 100 ID в одном запросе.
Ответ: status (1 — успех, -1 — ошибка), status_text (success, error или throttling), result (массив статусов), error (описание ошибки, если есть).
Элемент result: id (ID отправки), status — одно из: Доставлено, Не доставлено, Открыл, Кликнул, Пользователь считает спамом.

📄 Документация: https://documentation.mailganer.ru/documentation/trigger/id_stat

Возвращает список триггеров аккаунта (с пагинацией).

Эндпоинт: GET https://mailganer.com/api/v2/triggers/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)

Пример curl

curl --location 'https://mailganer.com/api/v2/triggers/' \\\n--header 'Authorization: CodeRequest '\n

Примечания

Ответ постраничный: count (количество триггеров), next (ссылка на следующую страницу), previous (ссылка на предыдущую страницу), results (массив триггеров).
Элемент results: id (идентификатор триггера), name (название, может быть null), sites (списки, с которыми связан триггер).

📄 Документация: https://documentation.mailganer.ru/documentation/triggers

Возвращает подробную информацию (метаданные) о триггере.

Эндпоинт: GET https://mailganer.com/api/v2/triggers/:trigger_id/meta/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)

Path-параметры

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

Поле	Тип	Обяз.	Описание
`trigger_id`	int	Да	ID триггера

Пример curl

curl --location 'https://mailganer.com/api/v2/triggers/1111/meta/' \\\n--header 'Authorization: CodeRequest '\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).

📄 Документация: https://documentation.mailganer.ru/documentation/trigger/meta/

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"trigger_id"}]}},"response":[{"id":"cde63658-cfdc-47df-b12c-efa69323c9e3","name":"Успешный ответ","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://mailganer.com/api/v2/triggers/:trigger_id/meta/","host":["https://mailganer.com"],"path":["api","v2","triggers",":trigger_id","meta",""],"variable":[{"key":"trigger_id","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","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"}],"cookie":[],"responseTime":null,"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}"},{"id":"415b7daa-b312-4408-abe0-aa61b4457017","name":"Ошибка авторизации","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://mailganer.com/api/v2/triggers/:trigger_id/meta/","host":["https://mailganer.com"],"path":["api","v2","triggers",":trigger_id","meta",""],"variable":[{"key":"trigger_id","value":"","description":"(Required) "}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","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"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"603f634f-4887-419b-8ca1-828b719f2c73"},{"name":"Создание триггера","id":"e3be7f03-b0d5-4137-b46a-30a1f5810ace","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Новый триггер\",\n \"theme\": \"Новый триггер\",\n \"sites\": [\n 94321\n ],\n \"html-content\": \"

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

\"\n}","options":{"raw":{"language":"json"}}},"url":"https://mailganer.com/api/v2/triggers/create/","description":"

Создаёт новый триггер в аккаунте.

Эндпоинт: POST https://mailganer.com/api/v2/triggers/create/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)\nContent-Type: application/json

Тело запроса

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

Поле	Тип	Обяз.	Описание
`name`	string	Да*	Название триггера (≤250 символов)
`theme`	string	Нет	Тема письма триггера (≤250 символов)
`sites`	array	Нет	Список ID списков (сегментов)
`html-content`	string	Нет	HTML-вёрстка письма триггера
`zip-content`	string	Нет	Ссылка на архив с вёрсткой (.zip)

* В старой документации поле было необязательным, но без name API возвращает ошибку 400 «Это поле обязательно».

Пример curl

curl --location 'https://mailganer.com/api/v2/triggers/create/' \\\n--header 'Authorization: CodeRequest ' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"name\": \"Новый триггер\",\n    \"theme\": \"Новый триггер\",\n    \"sites\": [94321],\n    \"html-content\": \"<p>Привет, это пример HTML-содержимого письма.</p>\",\n    \"zip-content\": \"\"\n}'\n

Примечания

При использовании html-content спецсимволы экранируются: &→%26, \"→%22, \\→%27, <→%3C, >→%3E.
Ответ: status (1/success или invalid), status_text (success/invalid), trigger_id (ID созданного триггера), step1_url (ссылка на страницу редактирования), error (объект с ошибками при invalid).
Возможные ошибки: неверный API-ключ; недопустимый HTTP-метод; неверная ссылка zip-content; архив недоступен; формат не .zip; превышен размер архива; в архиве нет HTML-шаблона; неподтверждённый адрес отправителя; несуществующий ID сегмента; превышение длины name (250) или theme (250).

📄 Документация: https://documentation.mailganer.ru/documentation/trigger/create

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

\"\n}","options":{"raw":{"language":"json"}}},"url":"https://mailganer.com/api/v2/triggers/create/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 1,\n \"step1_url\": \"https://mailganer.com/app/trigger/step1/53223/\",\n \"status_text\": \"success\",\n \"trigger_id\": 16434\n}"},{"id":"83b2189c-579d-4807-8c2d-2b9613f04f91","name":"Ошибка валидации","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Новый триггер\",\n \"theme\": \"Новый триггер\",\n \"sites\": [\n 94321\n ],\n \"html-content\": \"

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

\"\n}","options":{"raw":{"language":"json"}}},"url":"https://mailganer.com/api/v2/triggers/create/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"invalid\",\n \"error\": {\n \"name\": [\n \"Это поле обязательно.\"\n ]\n }\n}"}],"_postman_id":"e3be7f03-b0d5-4137-b46a-30a1f5810ace"},{"name":"История имейлов по триггеру","id":"07885f32-ff43-404d-a83f-920b74b7c71a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://mailganer.com/api/v2/triggers/:trigger_id/emails/?start_date=2024-08-01&end_date=2024-08-03","description":"

Возвращает историю отправленных имейлов по триггеру (с пагинацией).

Эндпоинт: GET https://mailganer.com/api/v2/triggers/:trigger_id/emails/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)

Path-параметры

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

Поле	Тип	Обяз.	Описание
`trigger_id`	int	Да	ID триггера

Query-параметры

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

Поле	Тип	Обяз.	Описание
`start_date`	string	Нет	Дата начала в формате `YYYY-MM-DD`
`end_date`	string	Нет	Дата конца в формате `YYYY-MM-DD`

Пример curl

curl --location 'https://mailganer.com/api/v2/triggers/1111/emails/?start_date=2024-08-01&end_date=2024-08-03' \\\n--header 'Authorization: CodeRequest '\n

Примечания

Без параметров дат — возвращаются все имейлы за всю историю.
Если передан только один из параметров дат — фильтр игнорируется, возвращаются все имейлы.
Оба параметра (start_date и end_date) должны передаваться вместе для фильтрации по периоду.
Ответ постраничный: count (всего имейлов), next (ссылка на следующую страницу), previous (ссылка на предыдущую страницу), results (массив имейлов).
Элемент results: id (ID отправки), queue_date (время постановки в очередь), sended (время отправки, null если не отправлено), email (имейл подписчика), email_id (идентификатор имейла), mg_hash (уникальный хэш подписчика), source_id (ID списка), status (0 — в очереди, 1 — отправлено, 2 — доставлено, -1 — отменено, -2 — не доставлено, -3 — отписался), action (действие: Не открыл / Открыл / Кликнул / Отписался).

📄 Документация: https://documentation.mailganer.ru/documentation/trigger/emails

Дата начала в формате YYYY-MM-DD

\n","type":"text/plain"},"key":"start_date","value":"2024-08-01"},{"description":{"content":"

Дата конца в формате YYYY-MM-DD

\n","type":"text/plain"},"key":"end_date","value":"2024-08-03"}],"variable":[{"id":"2c0dfd39-4e13-42af-8d09-22ddeadba477","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"enim veniam ipsum","key":"trigger_id"}]}},"response":[{"id":"10dacb05-6c2d-4694-9b13-ba8d2a4ef4b5","name":"История имейлов","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://mailganer.com/api/v2/triggers/:trigger_id/emails/?start_date=2024-08-01&end_date=2024-08-03","host":["https://mailganer.com"],"path":["api","v2","triggers",":trigger_id","emails",""],"query":[{"key":"start_date","value":"2024-08-01"},{"key":"end_date","value":"2024-08-03"}],"variable":[{"key":"trigger_id","value":"enim veniam ipsum","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"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}"}],"_postman_id":"07885f32-ff43-404d-a83f-920b74b7c71a"}],"id":"21786dec-2ddf-4699-bd58-baaddc4186e6","description":"

Триггерные механики, их отправка и статистика

\n","_postman_id":"21786dec-2ddf-4699-bd58-baaddc4186e6","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ad2a6101-55ec-46be-9158-ec0369852183","id":"ad2a6101-55ec-46be-9158-ec0369852183","name":"REST API Mailganer","type":"collection"}}},{"name":"Товарные рекомендации","item":[{"name":"Передача оформленных заказов","id":"cb9cb246-037b-47e1-956b-93bd53dec33c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"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"}}},"url":"https://mailganer.com/api/v1/recomend/orders/","description":"

Передаёт оформленные заказы в Mailganer для запуска триггеров с товарными рекомендациями.

Эндпоинт: POST https://mailganer.com/api/v1/recomend/orders/\nАвторизация: без заголовка (noauth) — api_key передаётся в теле запроса (v1)\nContent-Type: application/json

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

Поле	Тип	Обяз.	Описание
`api_key`	string	да	API-ключ (из настроек профиля)
`source_id`	int	да	ID списка
`orders`	array	да	Данные о заказах
`orders[].id`	string	—	Номер заказа
`orders[].status`	string	—	Статус заказа (например, «Новый»)
`orders[].channel`	string	—	Канал заказа (website / app / callcenter / offline)
`orders[].date`	string	—	Дата заказа, Unix-timestamp
`orders[].email`	string	—	Имейл покупателя
`orders[].value.total`	float	—	Сумма заказа
`orders[].items`	array	—	Товары заказа
`orders[].items[].id`	int	—	ID товара
`orders[].items[].price`	float	—	Цена товара
`orders[].items[].quantity`	float	—	Количество
`orders[].items[].categories`	array	—	ID категорий товара

Поля ответа

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

Поле	Тип	Описание
`status`	int	`1` — триггер отправлен, `-1` — ошибка
`status_text`	string	`success` или `error`
`error`	string	Описание ошибки (при наличии)

Пример curl

curl --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

Примечания

Метод v1: авторизация не через заголовок — api_key передаётся в теле запроса.
Ответ: status = 1 (триггер отправлен) или -1 (ошибка); status_text = success / error; при ошибке добавляется поле error.
Вёрстка письма-триггера с блоком рекомендаций описана в отдельной инструкции (см. «Триггеры с товарными рекомендациями»).

📄 Документация: https://documentation.mailganer.ru/documentation/recomend/orders

Инструкция по подготовке вёрстки письма-триггера с блоком товарных рекомендаций.

Эндпоинт: отдельного HTTP-эндпоинта у этой страницы нет — это руководство по вёрстке. Данные о заказах/покупках передаются методами «Передача оформленных заказов» (POST https://mailganer.com/api/v1/recomend/orders/) и «Передача RFM-сегмента» (POST https://mailganer.com/api/v2/recomend/orders/); данная страница описывает, как сверстать HTML-шаблон, в который движок подставит товары. URL запроса указывает на саму страницу документации.\nАвторизация: —

Переменные товара (`product`)

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

Переменная	Описание
`{{ product.id }}`	ID товара
`{{ product.name }}`	Название
`{{ product.description }}`	Описание
`{{ product.barcode }}`	Штрихкод
`{{ product.price }}`	Цена (формат «10 500»)
`{{ product.oldprice }}`	Старая цена (до скидки)
`{{ product.currency }}`	Валюта
`{{ product.url }}`	Ссылка на товар
`{{ product.image_url }}`	Ссылка на изображение
`{{ product.brand }}`	Бренд
`{{ product.amount }}`	Количество

Массивы и служебные переменные цикла

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

Переменная	Описание
`s_products`	Товары-источники (причина рекомендации, например из корзины / просмотренные)
`r_products`	Рекомендованные товары
`{{ forloop.first }}`	Первая итерация цикла
`{{ forloop.last }}`	Последняя итерация цикла
`{{ forloop.counter }}`	Номер текущей итерации

Пример вёрстки

<html>\n <body>\n   ...\n   <h2>Товары в корзине</h2>\n\n   {% for product in s_products %}\n   <div>\n     <p><a href=\"{{ product.url }}\"><img src=\"{{ product.image_url }}\"/></a></p>\n     <p>{{ product.name }}, {{ product.amount }} шт., {{ product.price }} руб.</p>\n   </div>\n   {% endfor %}\n\n   <h2>Рекомендуем посмотреть</h2>\n\n   {% for product in r_products %}\n   <div>\n     <p><a href=\"{{ product.url }}\"><img src=\"{{ product.image_url }}\"/></a></p>\n     <p>{{ product.name }}, {{ product.price }} руб.</p>\n   </div>\n   {% endfor %}\n   ...\n </body>\n</html>\n

Примечания

Важно: не вставляйте операторы {% for %} или {% if %} между тегами <table> и <td> — иначе операторы автоматически переносятся перед <table> и вёрстка ломается.
Нужны два цикла: один — по товарам-причинам рекомендации (s_products), второй — по рекомендованным товарам (r_products).
Условный вывод (например, старой цены) — через {% if product.oldprice %}...{% endif %}.

📄 Документация: https://documentation.mailganer.ru/documentation/recomend-layout-guide

Передаёт данные о покупках для расчёта RFM-сегмента подписчиков.

Эндпоинт: POST https://mailganer.com/api/v2/recomend/orders/\nАвторизация: заголовок Authorization: CodeRequest (v2, наследуется от коллекции)\nContent-Type: application/json

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

Поле	Тип	Обяз.	Описание
`source_id`	int	да	ID списка
`orders`	array	да	Данные о заказах
`orders[].product_id`	string	да	Номер заказа
`orders[].date`	date	да	Дата покупки (формат `ДД.ММ.ГГГГ`)
`orders[].email`	string	да	Имейл покупателя
`orders[].amount`	int	да	Стоимость покупки

Пример curl

curl --location --request POST 'https://mailganer.com/api/v2/recomend/orders/' \\\n--header 'Authorization: CodeRequest ' \\\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

Примечания

Метод v2: авторизация через заголовок Authorization: CodeRequest (наследуется от коллекции). На самой странице документации авторизация отдельно не расписана; используется общий для v2-методов заголовок.
api_key в теле запроса не передаётся (в отличие от v1-метода «Передача оформленных заказов»).
Пример ответа в документации не приведён.

📄 Документация: https://documentation.mailganer.ru/documentation/recomend/rfm_segment

Передача заказов и RFM-сегментов для товарных рекомендаций

\n","_postman_id":"80fbd147-c80c-4a07-9202-0eabf76183b0","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ad2a6101-55ec-46be-9158-ec0369852183","id":"ad2a6101-55ec-46be-9158-ec0369852183","name":"REST API Mailganer","type":"collection"}}},{"name":"Пользователи","item":[{"name":"Создать пользователя","id":"c2903050-bffb-48b6-9c5d-b1565ee8959e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Федор\",\n \"email\": \"test@example.com\",\n \"phone\": \"+79123456789\"\n}","options":{"raw":{"language":"json"}}},"url":"https://mailganer.com/api/v2/users/","description":"

Создаёт нового пользователя (личный кабинет) в системе Mailganer.

Эндпоинт: POST https://mailganer.com/api/v2/users/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)\nContent-Type: application/json

Параметры запроса

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

Поле	Тип	Обяз.	Описание
`first_name`	string	да	Имя пользователя
`email`	string	да	Имейл пользователя
`phone`	string	нет	Телефон

Параметры ответа

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

Поле	Тип	Описание
`id`	integer	ID пользователя
`username`	string	Логин для авторизации
`fullname`	string	Полное имя пользователя
`email`	string	Имейл
`phone`	string	Телефон
`code_request`	string	Токен доступа к API
`autologin`	string	Код автологина (авторизация на сайте)

Пример curl

curl --location --request POST 'https://mailganer.com/api/v2/users/' \\\n--header 'Authorization: CodeRequest ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n    \"first_name\": \"Федор\",\n    \"email\": \"test@example.com\",\n    \"phone\": \"+79123456789\"\n}'\n

Примечания

Данная группа методов по умолчанию отключена. Для получения доступа обратитесь на api@mailganer.com.

📄 Документация: https://documentation.mailganer.ru/documentation/users

Возвращает список пользователей.

Эндпоинт: GET https://mailganer.com/api/v2/users/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)

Пример curl

curl --location --request GET 'https://mailganer.com/api/v2/users/' \\\n--header 'Authorization: CodeRequest '\n

Примечания

Метод не описан в публичной документации.

Возвращает ссылку на оплату для пополнения баланса пользователя.

Эндпоинт: POST https://mailganer.com/api/v2/pay/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)\nContent-Type: application/json

Параметры запроса

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

Поле	Тип	Обяз.	Описание
`id`	integer	да	ID пользователя
`summ`	integer	да	Сумма пополнения
`payment_type`	string	да	Тип оплаты: `card` или `invoice`
`requisites`	array	нет	Реквизиты; обязателен при `payment_type=invoice`

Поля объекта `requisites` (при `payment_type=invoice`)

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

Поле	Тип	Обяз.	Описание
`inn`	string	да	ИНН
`bic`	string	да	БИК
`rs`	string	да	Расчётный счёт
`kpp`	string	да	КПП
`name_org`	string	да	Название организации
`address_org`	string	да	Адрес организации

Параметры ответа

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

Поле	Тип	Описание
`url`	string	Ссылка на оплату

Пример curl

curl --location --request POST 'https://mailganer.com/api/v2/pay/' \\\n--header 'Authorization: CodeRequest ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n    \"id\": 12345,\n    \"summ\": 1000,\n    \"payment_type\": \"card\"\n}'\n

Примечания

Данная группа методов по умолчанию отключена. Для получения доступа обратитесь на api@mailganer.com.
Для оплаты по счёту (payment_type=invoice) необходимо передать массив requisites со всеми полями реквизитов.

📄 Документация: https://documentation.mailganer.ru/documentation/users/payment

Изменяет параметры пользователя по его ID.

Эндпоинт: PATCH https://mailganer.com/api/v2/users/:id/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)\nContent-Type: application/json

Path-параметры

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

Поле	Тип	Обяз.	Описание
`id`	integer	да	ID пользователя

Параметры запроса

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

Поле	Тип	Обяз.	Описание
`is_access_api_doi`	boolean	нет	Флаг доступа к API DOI (поле присутствует в запросе)

Пример curl

curl --location --request PATCH 'https://mailganer.com/api/v2/users/:id/' \\\n--header 'Authorization: CodeRequest ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n    \"is_access_api_doi\": true\n}'\n

Примечания

Метод не описан в публичной документации.

(Required) ID пользователя

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"70bd4d27-529e-4629-9517-5b399444cbf7"},{"name":"Получить информацию о пользователе","id":"e91ad583-36c6-4fd8-bf7b-df0ee88582eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://mailganer.com/api/v2/users/:id/","description":"

Возвращает информацию о пользователе по его ID.

Эндпоинт: GET https://mailganer.com/api/v2/users/:id/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)

Path-параметры

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

Поле	Тип	Обяз.	Описание
`id`	integer	да	ID пользователя

Пример curl

curl --location --request GET 'https://mailganer.com/api/v2/users/:id/' \\\n--header 'Authorization: CodeRequest '\n

Примечания

Метод не описан в публичной документации.

(Required) ID пользователя

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"e91ad583-36c6-4fd8-bf7b-df0ee88582eb"},{"name":"Получение токена другого пользователя","id":"a9efbbcd-a43f-4268-99ee-7b115e649600","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"test@mailganer.com\",\n \"password\": \"cb61c634\"\n}","options":{"raw":{"language":"json"}}},"url":"https://mailganer.com/api/auth/","description":"

Возвращает API-токен и ID пользователя по логину и паролю (получение токена другого пользователя).

Эндпоинт: POST https://mailganer.com/api/auth/\nАвторизация: заголовок Authorization: CodeRequest \nContent-Type: application/json

Параметры запроса

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

Поле	Тип	Обяз.	Описание
`username`	string (email)	да	Логин (имейл)
`password`	string	да	Пароль

Параметры ответа

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

Поле	Тип	Описание
`api_key`	string	Токен доступа к API
`id`	integer	ID пользователя

Пример curl

curl --location --request POST 'https://mailganer.com/api/auth/' \\\n--header 'Authorization: CodeRequest ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n    \"username\": \"test@mailganer.com\",\n    \"password\": \"cb61c634\"\n}'\n

Примечания

Данная группа методов по умолчанию отключена. Для получения доступа обратитесь на api@mailganer.com.
В публичной документации эндпоинт указан как POST https://mailganer.com/api/v2/auth/; в данном запросе используется POST https://mailganer.com/api/auth/.

📄 Документация: https://documentation.mailganer.ru/documentation/auth

Возвращает баланс личного кабинета Mailganer.

Эндпоинт: GET https://mailganer.com/api/v2/users/get_balance/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)

Параметры запроса

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

Поле	Тип	Обяз.	Описание
`api_key`	string	да	API-ключ от личного кабинета Mailganer

Параметры ответа

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

Поле	Тип	Описание
`balance`	integer	Баланс личного кабинета

Пример curl

curl --location --request GET 'https://mailganer.com/api/v2/users/get_balance/' \\\n--header 'Authorization: CodeRequest 54654768d9897654456wergdd5' \\\n--form 'api_key=\"54654768d9897654456wergdd5\"'\n

Примечания

Данная группа методов по умолчанию отключена. Для получения доступа обратитесь на api@mailganer.com.

📄 Документация: https://documentation.mailganer.ru/documentation/users/balance

Управление пользователями аккаунта и балансом

\n","_postman_id":"8702978a-b92e-4da1-a73f-660ba8994bd9","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ad2a6101-55ec-46be-9158-ec0369852183","id":"ad2a6101-55ec-46be-9158-ec0369852183","name":"REST API Mailganer","type":"collection"}}},{"name":"Шаблоны","item":[{"name":"Создание шаблона","id":"db55fa8c-a800-4cc8-8082-4b5bec714482","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Письмо о доставке\",\n \"html\": \"

Здравствуйте, {{ name }}!

Отписаться\",\n \"group_id\": 641\n}","options":{"raw":{"language":"json"}}},"url":"https://mailganer.com/api/v2/template/","description":"

Создаёт HTML-шаблон письма в разделе «Шаблоны» личного кабинета. Вёрстка передаётся текстом, шаблон сразу доступен для редактирования в личном кабинете и для выбора при создании рассылки.

Эндпоинт: POST https://mailganer.com/api/v2/template/\nАвторизация: заголовок Authorization: CodeRequest \nContent-Type: application/json

Параметры тела

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

Поле	Тип	Обяз.	Описание
`name`	Строка	✅	Название шаблона, не больше 250 символов
`html`	Строка	✅	HTML-вёрстка письма. Размер не больше максимального размера письма для аккаунта, по умолчанию 2048 Кб
`group_id`	Число	—	ID группы шаблонов. Если не передан, шаблон создаётся без группы

Пример curl

curl --location 'https://mailganer.com/api/v2/template/' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: CodeRequest ' \\\n--data-raw '{\n  \"name\": \"Письмо о доставке\",\n  \"html\": \"<html><body><div>Здравствуйте, {{ name }}!</div><a href=\\\"{{unsubscribeUrl}}\\\">Отписаться</a></body></html>\",\n  \"group_id\": 641\n}'\n

Примечания

В ответе возвращается template_id. Его можно передать в метод создания рассылки в параметре template_id.
edit_url — ссылка на редактирование шаблона в личном кабинете.
Лимит: не больше 60 запросов в час на аккаунт.
Возможные ошибки:
- 400 Bad Request — не передано обязательное поле (status: invalid, в error перечислены поля).
- 401 Unauthorized — не предоставлен или неверный ключ API.
\n

Здравствуйте, {{ name }}!

Отписаться\",\n \"group_id\": 641\n}","options":{"raw":{"language":"json"}}},"url":"https://mailganer.com/api/v2/template/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"template_id\": \"3e28f835-b2e6-43f1-9e82-f263a4a4a4fb\",\n \"edit_url\": \"https://mailganer.com/app/custom-template/3e28f835-b2e6-43f1-9e82-f263a4a4a4fb/\"\n}"},{"id":"a6be99f3-c6bd-4f70-809c-c6296154c92e","name":"Не переданы обязательные поля","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Письмо о доставке\",\n \"html\": \"

Здравствуйте, {{ name }}!

Отписаться\",\n \"group_id\": 641\n}","options":{"raw":{"language":"json"}}},"url":"https://mailganer.com/api/v2/template/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"invalid\",\n \"error\": {\n \"html\": [\n \"Это поле обязательно.\"\n ],\n \"name\": [\n \"Это поле обязательно.\"\n ]\n }\n}"}],"_postman_id":"db55fa8c-a800-4cc8-8082-4b5bec714482"},{"name":"Получение HTML-вёрстки шаблона","id":"f4a4f9a0-00d8-4fe8-8dce-b333a12cbd1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://mailganer.com/api/v2/template/:template_id/","description":"

Возвращает HTML-вёрстку шаблона по его ID.

Эндпоинт: GET https://mailganer.com/api/v2/template/:template_id/\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)

Параметры пути

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

Поле	Тип	Обяз.	Описание
`template_id`	Строка (UID)	—	ID шаблона. Оставьте пустым, чтобы получить ID и названия всех шаблонов

Пример curl

curl --location 'https://mailganer.com/api/v2/template/4f848a39-136b-42e7-9ba8-e4b4a9dadbe2/' \\\n--header 'Authorization: CodeRequest '\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 шаблона.
Успешный ответ (200) содержит поле text с HTML-вёрсткой шаблона.
Возможные ошибки:
- 401 Unauthorized — не предоставлен или неверный ключ API от личного кабинета.
- 403 Forbidden — у пользователя нет доступа к запрашиваемому шаблону.
- 404 Not Found — шаблон с указанным ID не найден.
\n

📄 Документация: https://documentation.mailganer.ru/documentation/templates

(Required)

\n","type":"text/plain"},"type":"any","value":"enim veniam ipsum","key":"template_id"}]}},"response":[{"id":"bb86e55d-592a-4fa4-ba52-86bffdb3dc93","name":"Успех (200)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://mailganer.com/api/v2/template/:template_id/","host":["https://mailganer.com"],"path":["api","v2","template",":template_id",""],"variable":[{"key":"template_id","value":"enim veniam ipsum","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"text\": \"...\"\n}"}],"_postman_id":"f4a4f9a0-00d8-4fe8-8dce-b333a12cbd1a"}],"id":"08641388-462e-4679-9079-34f76d963f74","description":"

Получение HTML-вёрстки шаблонов

\n","_postman_id":"08641388-462e-4679-9079-34f76d963f74","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ad2a6101-55ec-46be-9158-ec0369852183","id":"ad2a6101-55ec-46be-9158-ec0369852183","name":"REST API Mailganer","type":"collection"}}},{"name":"Отчёты","item":[{"name":"Создать задачу на формирование отчёта","id":"6bcea69c-066b-4edf-b970-5c649646541e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"mailing_id\": 177022020521,\n \"mailing_report_type\": \"general_mailing_report\",\n \"file_type\": \"csv\"\n}","options":{"raw":{"language":"json"}}},"url":"https://mailganer.com/api/v2/tasks/emails_report","description":"

Запускает асинхронную задачу на формирование файла с данными аккаунта (выгрузка списка/сегмента или отчёт по рассылке).

Эндпоинт: POST https://mailganer.com/api/v2/tasks/emails_report\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)\nContent-Type: application/json

Параметры тела

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

Поле	Тип	Обяз.	Описание
`file_type`	string	Да	Формат файла: `csv` или `xlsx`
`site_id`	int	Нет*	ID списка — выгрузить всех подписчиков списка
`segment_id`	int	Нет*	ID сегмента — выгрузить подписчиков сегмента
`mailing_id`	int	Нет*	ID рассылки (требует `mailing_report_type`)
`mailing_report_type`	string	Нет	Тип отчёта по рассылке: `general_mailing_report` — общий отчёт, `clicks` — отчёт по кликам
`start_date`	string	Нет	Фильтр по дате от (дата создания подписчика), формат `YYYY-MM-DD`
`end_date`	string	Нет	Фильтр по дате до (дата создания подписчика), формат `YYYY-MM-DD`

* Нужно передать ровно одну группу: site_id, segment_id или mailing_id.

Пример curl

curl --location --request POST 'https://mailganer.com/api/v2/tasks/emails_report' \\\n--header 'Authorization: CodeRequest ' \\\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

Примечания

Метод запускает асинхронную задачу; в ответе возвращается task_id, state и task_type.
Параметры site_id, segment_id и mailing_id взаимоисключающие — их нельзя комбинировать (иначе ошибка Request cannot contain parameters from different report types...).
Для mailing_id обязателен mailing_report_type (иначе mailing_id is required for mailing_report_type parameter).
Фильтры по датам (start_date/end_date) применяются к дате создания подписчика; для отчётов по рассылке игнорируются.
Для использования метода в аккаунте должно быть включено ограничение доступа к API по IP-адресам (иначе 403).
Порядок работы с отчётами: 1) создать задачу этим методом → получить task_id; 2) опрашивать статус GET /api/v2/tasks/:task_id, пока state не станет COMPLETED; 3) скачать файл GET /api/v2/tasks/:task_id/download_file.

📄 Документация: https://documentation.mailganer.ru/documentation/task/create

Возвращает текущий статус задачи на формирование отчёта по её идентификатору.

Эндпоинт: GET https://mailganer.com/api/v2/tasks/:task_id\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)

Параметры пути

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

Поле	Тип	Обяз.	Описание
`task_id`	string	Да	UUID задачи, полученный при её создании

Пример curl

curl --location --request GET 'https://mailganer.com/api/v2/tasks/:task_id' \\\n--header 'Authorization: CodeRequest '\n

Примечания

Поля ответа: id — UUID задачи; state — статус; task_type — тип отчёта (DOWNLOAD_SITE_EMAILS, DOWNLOAD_SEGMENT, DOWNLOAD_MAILING_REPORT и т.п.).
Значения state: IN_PROGRESS — выполняется; COMPLETED — успешно завершена, файл готов к скачиванию; FAILED — ошибка формирования.
Опрашивайте метод, пока state не станет COMPLETED, затем скачайте файл через GET /api/v2/tasks/:task_id/download_file.
Если задача не найдена — ответ с ошибкой Task by id=... not found.
Для использования метода в аккаунте должно быть включено ограничение доступа к API по IP-адресам (иначе 403).

📄 Документация: https://documentation.mailganer.ru/documentation/task/status

(Required)

\n","type":"text/plain"},"type":"any","value":"enim veniam ipsum","key":"task_id"}]}},"response":[{"id":"bedc6e34-1716-4670-8bf7-920f43d57b74","name":"Success — выполняется","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://mailganer.com/api/v2/tasks/:task_id","host":["https://mailganer.com"],"path":["api","v2","tasks",":task_id"],"variable":[{"key":"task_id","value":"enim veniam ipsum","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"a39929f4-dac8-4f5d-8d02-82c945623856\",\n \"state\": \"IN_PROGRESS\",\n \"task_type\": \"DOWNLOAD_MAILING_REPORT\"\n}"},{"id":"1ae42223-73be-4048-bad2-88c8734250f1","name":"Error — задача не найдена","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://mailganer.com/api/v2/tasks/:task_id","host":["https://mailganer.com"],"path":["api","v2","tasks",":task_id"],"variable":[{"key":"task_id","value":"enim veniam ipsum","description":"(Required) "}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"error\": \"Task by id=8959d954-9baf-4491-a1b3-46adf787c064 not found\"\n}"}],"_postman_id":"f85d418f-aabf-40da-bee6-9828eb985fad"},{"name":"Скачивание готового файла","id":"af0e93ce-bce8-40e7-8788-1d643a22000f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://mailganer.com/api/v2/tasks/:task_id/download_file","description":"

Скачивает готовый файл отчёта по завершённой задаче.

Эндпоинт: GET https://mailganer.com/api/v2/tasks/:task_id/download_file\nАвторизация: заголовок Authorization: CodeRequest (наследуется от коллекции)

Параметры пути

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

Поле	Тип	Обяз.	Описание
`task_id`	string	Да	UUID задачи, полученный при её создании

Пример curl

curl --location --request GET 'https://mailganer.com/api/v2/tasks/:task_id/download_file' \\\n--header 'Authorization: CodeRequest ' \\\n--output report.csv\n

Примечания

Возвращает бинарный файл в формате, указанном при создании задачи (CSV или XLSX).
Скачивание доступно только после того, как задача перешла в статус COMPLETED (проверяйте через GET /api/v2/tasks/:task_id).
Если файл ещё не готов, метод вернёт ошибку {\"status\": \"error\", \"error\": \"Task has not file\"}.
Для использования метода в аккаунте должно быть включено ограничение доступа к API по IP-адресам (иначе 403).
Полный порядок: создать задачу → дождаться статуса COMPLETED → скачать файл этим методом.

📄 Документация: https://documentation.mailganer.ru/documentation/task/download

(Required)

\n","type":"text/plain"},"type":"any","value":"enim veniam ipsum","key":"task_id"}]}},"response":[{"id":"ea1081cb-8e5e-4e90-b924-e14e777805e0","name":"Error — файл ещё не готов","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://mailganer.com/api/v2/tasks/:task_id/download_file","host":["https://mailganer.com"],"path":["api","v2","tasks",":task_id","download_file"],"variable":[{"key":"task_id","value":"enim veniam ipsum","description":"(Required) "}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"error\": \"Task has not file\"\n}"}],"_postman_id":"af0e93ce-bce8-40e7-8788-1d643a22000f"}],"id":"89756913-819f-4b63-b255-98e78b270ca1","description":"

Формирование, статус и скачивание отчётов

\n","_postman_id":"89756913-819f-4b63-b255-98e78b270ca1","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ad2a6101-55ec-46be-9158-ec0369852183","id":"ad2a6101-55ec-46be-9158-ec0369852183","name":"REST API Mailganer","type":"collection"}}},{"name":"Постбек","item":[{"name":"Передача конверсий","id":"35a5b29d-b812-4e0b-bb8d-f14967616fe0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://postback.mailganer.com/v1/?mailing_id={{public_id}}&email_hash={{email_hash}}&sum=1000¤cy=RUB&offer=order&goto_url=domain.com","description":"

Передача конверсий (postback). Источник: https://documentation.mailganer.ru/documentation/postback\nХост отдельный (postback.mailganer.com), авторизация не требуется (No Auth). Параметры передаются в query-строке.

Пример curl

curl --location --request GET 'http://postback.mailganer.com/v1/?mailing_id={{public_id}}&sum=1000&currency=RUB&offer=order&email_hash={{email_hash}}&goto_url=domain.com'\n

Обновление переменной по ссылке

Тот же адрес обновляет пользовательскую переменную подписчика по клику на ссылку в письме. Переменную передают как get-параметр имя=значение (в примере nps=10). goto_url должен содержать протокол и быть закодирован (urlencode). Авторизация не нужна.

curl --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

📄 Документация: https://documentation.mailganer.ru/documentation/variables_on_click

Обязательный. ID рассылки — используйте переменную {{public_id}}

\n","type":"text/plain"},"key":"mailing_id","value":"{{public_id}}"},{"description":{"content":"

Обязательный. md5-хеш имейла подписчика, выполнившего целевое действие

\n","type":"text/plain"},"key":"email_hash","value":"{{email_hash}}"},{"description":{"content":"

Обязательный. Сумма целевого действия

\n","type":"text/plain"},"key":"sum","value":"1000"},{"description":{"content":"

Необязательный. RUB или USD

\n","type":"text/plain"},"key":"currency","value":"RUB"},{"description":{"content":"

Необязательный. Уточнение, какое целевое действие выполнил подписчик

\n","type":"text/plain"},"key":"offer","value":"order"},{"description":{"content":"

Необязательный. URL для редиректа после обработки

\n","type":"text/plain"},"key":"goto_url","value":"domain.com"}],"variable":[]}},"response":[],"_postman_id":"35a5b29d-b812-4e0b-bb8d-f14967616fe0"},{"name":"Обновление переменной по ссылке","id":"71774d94-8b18-4cd8-8ade-b84697e04ea7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"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}}","description":"

Обновление переменной по ссылке

curl --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

📄 Документация: https://documentation.mailganer.ru/documentation/variables_on_click

Передача конверсий на отдельном хосте постбека

\n","_postman_id":"d82e70ad-83ce-401f-965b-baedd2b7c904","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ad2a6101-55ec-46be-9158-ec0369852183","id":"ad2a6101-55ec-46be-9158-ec0369852183","name":"REST API Mailganer","type":"collection"}}},{"name":"Вебхуки","item":[{"name":"Изменение статуса подписчика","id":"51776142-519f-411e-8280-b81af3bc0257","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","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":"https://your-domain.example/webhook","description":"

Событие изменения статуса подписки подписчика (type=1).

Входящий вебхук — Mailganer отправляет POST на ваш URL, заданный методом «Задать ссылку на webhook».

Метод доставки: POST Content-Type: application/x-www-form-urlencoded (form-values)

Поля payload

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

Поле	Тип	Описание
`type`	int	Тип вебхука, всегда `1` для изменения статуса подписчика
`email`	string	Имейл подписчика
`status`	int	Числовой статус подписки (см. таблицу статусов ниже)
`status_message`	string	Текстовая расшифровка (например, причина недоставки)
`timestamp`	string	Дата и время отправки вебхука
`source_id`	int	ID списка. Передаётся не для всех событий (только при спаме/отписке)
`source_name`	string	Название списка. Передаётся не для всех событий (только при спаме/отписке)
`method`	string	`spam` или `unsubscribe`. Передаётся не для всех событий
`reason`	string	Причина отписки. Передаётся только для событий отписки

Значения `status`

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

Значение	Описание
`-6`	Исправлен (при импорте найдены недопустимые символы)
`-5`	Исправлен (опечатка исправлена системой)
`-4`	Помечен как спам сервером
`-3`	Помечен как спам пользователем
`-2`	Недоступен
`-1`	Отписан от рассылок
`0`	Новый
`1`	Активен
`2`	Запрошено подтверждение

Пример payload

status=-1&source_name=%D0%A2%D0%B5%D1%81%D1%82+%D1%85%D1%83%D0%BA%D0%B0&source_id=1092359&timestamp=2026-05-19+15%3A26%3A19.654599&type=1&method=unsubscribe&email=example%40example.com\n

Примечания

Хук активируется в настройках списка на вкладке «Интеграции».
Опциональный переключатель добавляет в запрос заголовок с ключом авторизации.
Поля source_id, source_name, method передаются не для всех событий — только когда пользователь пожаловался на спам или отписался. Поле reason присутствует только для отписки.
Повторные попытки при ошибке на вашем эндпоинте: через 5 секунд, 1 час и 24 часа.

📄 Документация: https://documentation.mailganer.ru/documentation/webhooks/email_status

\n","urlObject":{"host":["https://your-domain.example/webhook"],"query":[],"variable":[]}},"response":[],"_postman_id":"51776142-519f-411e-8280-b81af3bc0257"},{"name":"Изменение данных о подписчике","id":"991c378b-ddc3-47c7-8280-09fbe7217853","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","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":"https://your-domain.example/webhook","description":"

Событие изменения данных в карточке подписчика (type=2). Хук отправляется каждый раз, когда изменяется какое-либо поле в карточке подписчика.

Входящий вебхук — Mailganer отправляет POST на ваш URL, заданный методом «Задать ссылку на webhook».

Метод доставки: POST Content-Type: application/x-www-form-urlencoded (form-values)

Поля payload

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

Поле	Тип	Описание
`type`	int	Тип вебхука, всегда `2` для изменения данных о подписчике
`src`	int	Источник изменения: `1` — изменение через API, `2` — изменение через интерфейс
`email`	string	Имейл подписчика
`birthday`	date	Дата рождения, формат `YYYY-MM-DD`
`user_vars`	array	Пользовательские переменные в формате `[['variable_name', 'value'], ['variable_name2', 'value']]`

Пример payload

type=2&src=2&email=example%40mail.ru&birthday=1988-01-01\n

Примечания

В документации нет готового примера payload; тело выше собрано из перечня документированных полей с иллюстративными значениями-заглушками.
Хук активируется в настройках списка на вкладке «Интеграции».
Опциональный переключатель добавляет в запрос заголовок с ключом авторизации.
Хук срабатывает только при фактическом изменении данных.
Пользовательские переменные (user_vars) передаются парами «имя — значение» в виде массива.
Повторные попытки при ошибке на вашем эндпоинте: через 5 секунд, 1 час и 24 часа.

📄 Документация: https://documentation.mailganer.ru/documentation/webhooks/email_meta

\n","urlObject":{"host":["https://your-domain.example/webhook"],"query":[],"variable":[]}},"response":[],"_postman_id":"991c378b-ddc3-47c7-8280-09fbe7217853"},{"name":"Взаимодействие с письмом","id":"d0fdbf69-4733-491a-a91d-80f83ded3706","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","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":"https://your-domain.example/webhook","description":"

Событие взаимодействия с письмом в массовой или триггерной рассылке (type=3). Срабатывает на каждое сообщение при любом взаимодействии с ним.

Входящий вебхук — Mailganer отправляет POST на ваш URL, заданный методом «Задать ссылку на webhook».

Метод доставки: POST Content-Type: application/x-www-form-urlencoded (form-values)

Поля payload

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

Поле	Тип	Описание
`type`	int	Тип вебхука, всегда `3` для взаимодействия с письмом
`email`	string	Имейл получателя
`source`	int	ID списка, которому принадлежит письмо
`action`	int	Тип взаимодействия (см. таблицу значений ниже)
`timestamp`	string	Дата и время взаимодействия
`mail_type`	string	`mailing` (массовая рассылка) или `trigger` (триггерное сообщение)
`public_id`	string	Публичный ID массовой/триггерной рассылки
`mail_id`	string	ID отправки сообщения (для триггерных рассылок)
`trigger_id`	string	ID триггера в системе Mailganer

Значения `action`

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

Значение	Описание
`-3`	Не доставлено
`-2`	Жалоба на спам
`-1`	Отписка
`1`	Доставлено
`2`	Открытие письма
`3`	Клик по ссылке в письме

Значения `mail_type`

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

Значение	Описание
`mailing`	Взаимодействие из вручную отправленной массовой рассылки
`trigger`	Взаимодействие из триггерного сообщения

Пример payload

mail_id=999129235&public_id=166118134802&mail_type=mailing&action=1&timestamp=2022-08-22+15%3A18%3A44.960548&type=3&email=example%40mail.ru\n

Примечания

Хук активируется в настройках списка на вкладке «Интеграции».
Опциональный переключатель добавляет в запрос заголовок с ключом авторизации.
Повторные попытки при ошибке на вашем эндпоинте: через 5 секунд, 1 час и 24 часа.

📄 Документация: https://documentation.mailganer.ru/documentation/webhooks/mail_status

\n","urlObject":{"host":["https://your-domain.example/webhook"],"query":[],"variable":[]}},"response":[],"_postman_id":"d0fdbf69-4733-491a-a91d-80f83ded3706"},{"name":"Срабатывание события в триггере","id":"12b6cde2-5435-4876-a3cc-e93a42a779d0","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","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":"https://your-domain.example/webhook","description":"

Событие срабатывания триггера (type=4). Используется, когда нужно передать информацию во внешнюю систему вместе с отправкой письма или передать данные без отправки письма.

Входящий вебхук — Mailganer отправляет POST на ваш URL, заданный методом «Задать ссылку на webhook».

Метод доставки: POST Content-Type: application/x-www-form-urlencoded (form-values)

Поля payload

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

Поле	Тип	Описание
`type`	int	Тип вебхука, всегда `4` для срабатывания события в триггере
`public_id`	int	ID триггера
`email`	string	Имейл подписчика
`phone`	string	Телефон
`name`	string	Имя
`surname`	string	Фамилия
`patronymic`	string	Отчество
`gender`	int	Пол: `1` — мужской, `2` — женский
`birthday`	date	Дата рождения, формат `dd.mm.yyyy`
`city`	string	Город
`user_var_{имя_переменной}`	string	Пользовательские переменные передаются как `user_var_{имя_переменной}` (например, `user_var_company_name`)

Пример payload

type=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

Примечания

В документации нет готового примера payload; тело выше собрано из перечня документированных полей с иллюстративными значениями-заглушками.
Хук активируется в настройках списка на вкладке «Интеграции».
Опциональный переключатель добавляет в запрос заголовок с ключом авторизации.
Пользовательские переменные передаются с префиксом user_var_ в названии поля.
Повторные попытки при ошибке на вашем эндпоинте: через 5 секунд, 1 час и 24 часа.

📄 Документация: https://documentation.mailganer.ru/documentation/webhooks/trigger_event

\n","urlObject":{"host":["https://your-domain.example/webhook"],"query":[],"variable":[]}},"response":[],"_postman_id":"12b6cde2-5435-4876-a3cc-e93a42a779d0"}],"id":"b5a19d1f-1bfe-4d70-a53a-ee87d66352f3","description":"

Входящие вебхуки: Mailganer отправляет POST на ваш URL, заданный методом «Задать ссылку на webhook». Все четыре события и их поля описаны в блоке Callbacks этого метода.

\n","_postman_id":"b5a19d1f-1bfe-4d70-a53a-ee87d66352f3","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ad2a6101-55ec-46be-9158-ec0369852183","id":"ad2a6101-55ec-46be-9158-ec0369852183","name":"REST API Mailganer","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]}},"variable":[{"key":"api_key","value":"","type":"string","description":"API-ключ из раздела «Ключ API» личного кабинета (mailganer.com/app/profile/settings/api/), без слова CodeRequest"},{"key":"baseUrl","value":"https://mailganer.com","type":"string"},{"key":"webhook_url","value":"https://your-domain.example/webhook","type":"string","description":"URL вашего обработчика вебхуков"}]}