{ "info": { "_postman_id": "250a00b5-5a8d-4fd3-ab58-fb45fa4f31f0", "name": "DashaMail API 1.21", "description": "Методы DashaMail предыдущего поколения — те, что вызываются как\n`?method=lists.get`. API работает и отключать его не собираемся,\nно в новых интеграциях лучше брать\n[REST API v2](https://dashamail.ru/api/): там понятные адреса,\nкоды ответов HTTP и подробнее описаны параметры.\n\n**Перед первым запросом** заполните переменную коллекции `api_key`:\nличный кабинет → Аккаунт → API и интеграции.\n\nОбязательные параметры в запросах заполнены правдоподобными\nзначениями — подставьте свои. Необязательные лежат выключенными.\n\nСправочник: [API 1.21](https://dashamail.ru/api/v1/),\n[обработка входящих](https://dashamail.ru/router/).", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_key", "type": "string" }, { "key": "value", "value": "{{api_key}}", "type": "string" }, { "key": "in", "value": "query", "type": "string" } ] }, "variable": [ { "key": "base_url", "value": "https://api.dashamail.com", "type": "string", "description": "Базовый адрес API." }, { "key": "api_key", "value": "", "type": "string", "description": "Ваш API-ключ. Подставьте перед первым запросом." } ], "item": [ { "name": "Адресные базы", "description": "Базы, подписчики, дополнительные поля, импорт, отписки и жалобы.", "item": [ { "name": "lists.get", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=lists.get", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "lists.get", "description": "(обязательный) Имя вызываемого метода." }, { "key": "list_id", "value": "128341", "description": "(int) id запрашиваемой адресной базы", "disabled": true } ] }, "description": "Получаем список баз пользователя\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `list_id` | int | id запрашиваемой адресной базы |\n\n**Что возвращается**\n\nМассив строк адресных баз с различными параметрами. Вложенный массив подразумевается сериализорованным.\n\n| Поле | Описание |\n| --- | --- |\n| `id` | id адресной базы |\n| `name` | название адресной базы |\n| `state` | статус адресной базы, возможные значения: active, blocked (если идет процесс импорта) и archived |\n| `merge_{1..10}` | Сериализированные массивы настроек дополнительных полей. Подробнее смотрите методы merge_add, merge_update `title` — название дополнительного поля; `type` — тип поля. возможные значения: text, date, choice; `req` — обязательно поле или нет? возможные значения: on,off; `var` — название шаблона |\n| `description` | описание того, как подписчик может оказаться в этой базе |\n| `company` | название вашей компании, владеющей адресной базой |\n| `abuse_name` | Имя человека, которому можно жаловаться на спам |\n| `phone` | контактный телефон |\n| `address` | контактный адрес |\n| `city` | город, где находится ваша компания |\n| `url` | url вашего сайта, где можно подписаться/отписаться на базу |\n| `count_active` | количество активных подписчиков в базе |\n| `count_bounced` | количество жестких возвратов в базе |\n| `count_inactive` | количество неактивных подписчиков в базе |\n| `count_unconfirmed` | количество неподтвержденных адресов в базе |\n| `count_unsubscribed` | количество отписавшихся подписчиков в базе |\n| `count_all` | общее количество подписчиков в базе |\n| `count` | JSON-массив с агрегированной статистикой подписчиков в адресной базе |\n| `stat` | JSON-массив с агрегированной статистикой рассылок (открытий, кликов итд) по данной адресной базе |\n\n[Метод в документации](https://dashamail.ru/api/v1/lists/#lists.get)" }, "response": [] }, { "name": "lists.add", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=lists.add", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "lists.add", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Добавляем адресную базу\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `name` | string, обязательный | название создаваемой базы |\n| `abuse_email` | string | Email, по которому будут приниматься жалобы на спам. |\n| `abuse_name` | string | Имя человека, которому можно жаловаться на спам. |\n| `company` | string | название вашей компании, владеющей адресной базой |\n| `address` | string | контактный адрес |\n| `city` | string | город, где находится ваша компания |\n| `zip` | string | почтовый индекс |\n| `country` | string | страна, где вы находитесь |\n| `url` | string | url вашего сайта, где можно подписаться/отписаться на базу |\n| `phone` | string | контактный телефон |\n\n**Что возвращается**\n\nid добавленной базы\n\n[Метод в документации](https://dashamail.ru/api/v1/lists/#lists.add)", "body": { "mode": "raw", "raw": "{\n \"name\": \"Клиенты интернет-магазина\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "lists.update", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=lists.update", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "lists.update", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Обновляем контактную информацию адресной базы\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `list_id` | int, обязательный | id редактируемой адресной базы |\n| `name` | string | Название базы. |\n| `abuse_email` | string | Email, по которому будут приниматься жалобы на спам. |\n| `abuse_name` | string | Имя человека, которому можно жаловаться на спам. |\n| `company` | string | название вашей компании, владеющей адресной базой |\n| `address` | string | контактный адрес |\n| `city` | string | город, где находится ваша компания |\n| `zip` | string | почтовый индекс |\n| `country` | string | страна, где вы находитесь |\n| `url` | string | url вашего сайта, где можно подписаться/отписаться на базу |\n| `phone` | string | контактный телефон |\n\n**Что возвращается**\n\nЕсли `msg.err_code` равен нулю, операция прошла успешно.\n\n[Метод в документации](https://dashamail.ru/api/v1/lists/#lists.update)", "body": { "mode": "raw", "raw": "{\n \"list_id\": 128341\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "lists.delete", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=lists.delete", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "lists.delete", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Удаляем адресную базу и всех активных подписчиков в ней.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `list_id` | int, обязательный | id удаляемой адресной базы |\n\n**Что возвращается**\n\nколичество удаленных активных подписчиков из удаленной базы.\n\n[Метод в документации](https://dashamail.ru/api/v1/lists/#lists.delete)", "body": { "mode": "raw", "raw": "{\n \"list_id\": 128341\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "lists.get_members", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=lists.get_members&list_id=128341", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "lists.get_members", "description": "(обязательный) Имя вызываемого метода." }, { "key": "list_id", "value": "128341", "description": "(обязательный, int) id адресной базы" }, { "key": "state", "value": "значение", "description": "статус подписчика, возможные варианты: active,unsubscribed,bounced", "disabled": true }, { "key": "start", "value": "1", "description": "(int) с какого номера начинать выдачу данных", "disabled": true }, { "key": "limit", "value": "1", "description": "(int) кол-во подписчиков в выдаваемом массиве", "disabled": true }, { "key": "order", "value": "значение", "description": "порядок сортировки, вида \"поле порядок\", например, \"id desc\"", "disabled": true }, { "key": "member_id", "value": "90412881", "description": "(int) id необходимого подписчика", "disabled": true }, { "key": "email", "value": "ivan@example.com", "description": "email необходимого подписчика", "disabled": true }, { "key": "segment_id", "value": "1", "description": "(int) id сегмента для отображения", "disabled": true } ] }, "description": "Получаем подписчиков в адресной базе с возможность фильтра и регулировки выдачи.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `list_id` | int, обязательный | id адресной базы |\n| `state` | string | статус подписчика, возможные варианты: active,unsubscribed,bounced |\n| `start` | int | с какого номера начинать выдачу данных |\n| `limit` | int | кол-во подписчиков в выдаваемом массиве |\n| `order` | string | порядок сортировки, вида \"поле порядок\", например, \"id desc\" |\n| `member_id` | int | id необходимого подписчика |\n| `email` | string | email необходимого подписчика |\n| `segment_id` | int | id сегмента для отображения |\n\n**Что возвращается**\n\nМассив подписчиков с параметрами.\n\n| Поле | Описание |\n| --- | --- |\n| `id` | id подписчика |\n| `list_id` | адресная база в которой он состоит |\n| `email` | email-адрес подписчика |\n| `state` | статус подписчика |\n| `merge_1` | дополнительное поле №1 |\n| `merge_2` | дополнительное поле №2 |\n| `merge_3` | дополнительное поле №3 |\n| `merge_4` | дополнительное поле №4 |\n| `merge_5` | дополнительное поле №5 |\n| `merge_6` | дополнительное поле №6 |\n| `merge_7` | дополнительное поле №7 |\n| `merge_8` | дополнительное поле №8 |\n| `merge_9` | дополнительное поле №9 |\n| `merge_10` | дополнительное поле №10 |\n| `optin_time` | время добавления в базу |\n| `unsub_time` | время отписки из базы |\n| `lastedit_time` | время последнего редактирования |\n| `gender` | пол подписчика {m - мужчина, f - женщина, n - неизвестно} |\n| `source` | источник подписки |\n| `device` | устройство, с которого читаются письма |\n| `rating` | рейтинг подписчика |\n\n[Метод в документации](https://dashamail.ru/api/v1/lists/#lists.get_members)" }, "response": [] }, { "name": "lists.get_unsubscribed", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=lists.get_unsubscribed", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "lists.get_unsubscribed", "description": "(обязательный) Имя вызываемого метода." }, { "key": "start", "value": "1", "description": "(int) с какого номера начинать выдачу данных", "disabled": true }, { "key": "limit", "value": "1", "description": "(int) кол-во подписчиков в выдаваемом массиве", "disabled": true }, { "key": "order", "value": "значение", "description": "порядок сортировки, вида \"поле порядок\", например, \"id desc\"", "disabled": true }, { "key": "list_id", "value": "128341", "description": "ID адресной базы", "disabled": true } ] }, "description": "Получаем список отписавшихся подписчиков как из всех баз, так и в разрезе конкретной адресной базы.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `start` | int | с какого номера начинать выдачу данных |\n| `limit` | int | кол-во подписчиков в выдаваемом массиве |\n| `order` | string | порядок сортировки, вида \"поле порядок\", например, \"id desc\" |\n| `list_id` | string | ID адресной базы |\n\n**Что возвращается**\n\nМассив подписчиков с параметрами.\n\n| Поле | Описание |\n| --- | --- |\n| `id` | id подписчика |\n| `list_id` | адресная база в которой он состоит |\n| `email` | email-адрес подписчика |\n| `state` | статус подписчика |\n| `merge_1` | дополнительное поле №1 |\n| `merge_2` | дополнительное поле №2 |\n| `merge_3` | дополнительное поле №3 |\n| `merge_4` | дополнительное поле №4 |\n| `merge_5` | дополнительное поле №5 |\n| `merge_6` | дополнительное поле №6 |\n| `merge_7` | дополнительное поле №7 |\n| `merge_8` | дополнительное поле №8 |\n| `merge_9` | дополнительное поле №9 |\n| `merge_10` | дополнительное поле №10 |\n| `optin_time` | время добавления в базу |\n| `unsub_time` | время отписки из базы |\n| `lastedit_time` | время последнего редактирования |\n| `gender` | пол подписчика {m - мужчина, f - женщина, n - неизвестно} |\n| `source` | источник подписки |\n| `device` | устройство, с которого читаются письма |\n| `rating` | рейтинг подписчика |\n\n[Метод в документации](https://dashamail.ru/api/v1/lists/#lists.get_unsubscribed)" }, "response": [] }, { "name": "lists.get_complaints", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=lists.get_complaints", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "lists.get_complaints", "description": "(обязательный) Имя вызываемого метода." }, { "key": "start", "value": "1", "description": "(int) с какого номера начинать выдачу данных", "disabled": true }, { "key": "limit", "value": "1", "description": "(int) кол-во подписчиков в выдаваемом массиве", "disabled": true }, { "key": "order", "value": "значение", "description": "порядок сортировки, вида \"поле порядок\", например, \"id desc\"", "disabled": true }, { "key": "list_id", "value": "128341", "description": "(int) ID адресной базы", "disabled": true } ] }, "description": "Получаем список подписчиков, нажавших «Это Спам», как из всех баз, так и в разрезе конкретной базы.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `start` | int | с какого номера начинать выдачу данных |\n| `limit` | int | кол-во подписчиков в выдаваемом массиве |\n| `order` | string | порядок сортировки, вида \"поле порядок\", например, \"id desc\" |\n| `list_id` | int | ID адресной базы |\n\n**Что возвращается**\n\nМассив подписчиков с параметрами.\n\n| Поле | Описание |\n| --- | --- |\n| `id` | id подписчика |\n| `list_id` | адресная база в которой он состоит |\n| `email` | email-адрес подписчика |\n| `state` | статус подписчика |\n| `merge_1` | дополнительное поле №1 |\n| `merge_2` | дополнительное поле №2 |\n| `merge_3` | дополнительное поле №3 |\n| `merge_4` | дополнительное поле №4 |\n| `merge_5` | дополнительное поле №5 |\n| `merge_6` | дополнительное поле №6 |\n| `merge_7` | дополнительное поле №7 |\n| `merge_8` | дополнительное поле №8 |\n| `merge_9` | дополнительное поле №9 |\n| `merge_10` | дополнительное поле №10 |\n| `optin_time` | время добавления в базу |\n| `unsub_time` | время отписки из базы |\n| `lastedit_time` | время последнего редактирования |\n| `gender` | пол подписчика {m - мужчина, f - женщина, n - неизвестно} |\n| `source` | источник подписки |\n| `device` | устройство, с которого читаются письма |\n| `rating` | рейтинг подписчика |\n\n[Метод в документации](https://dashamail.ru/api/v1/lists/#lists.get_complaints)" }, "response": [] }, { "name": "lists.member_activity", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=lists.member_activity&email=ivan%40example.com", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "lists.member_activity", "description": "(обязательный) Имя вызываемого метода." }, { "key": "email", "value": "ivan@example.com", "description": "(обязательный) Email подписчика" }, { "key": "filter", "value": "значение", "description": "Фильтр по типу события. Возможные значения: {sent, opened, clicked, bounced, unsubscribed}", "disabled": true }, { "key": "start_time", "value": "2026-08-01 00:00:00", "description": "(datetime) фильтр событий по времени, начальное время, формат: YYYY-MM-DD HH:ii:ss", "disabled": true }, { "key": "end_time", "value": "2026-08-01 00:00:00", "description": "(datetime) фильтр событий по времени, конечное время, формат: YYYY-MM-DD HH:ii:ss", "disabled": true }, { "key": "campaign_id", "value": "5512", "description": "(int) фильтр по id рассылки", "disabled": true } ] }, "description": "Получаем активность подписчика в различных рассылках\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `email` | string, обязательный | Email подписчика |\n| `filter` | string | Фильтр по типу события. Возможные значения: {sent, opened, clicked, bounced, unsubscribed} |\n| `start_time` | datetime | фильтр событий по времени, начальное время, формат: YYYY-MM-DD HH:ii:ss |\n| `end_time` | datetime | фильтр событий по времени, конечное время, формат: YYYY-MM-DD HH:ii:ss |\n| `campaign_id` | int | фильтр по id рассылки |\n\n**Что возвращается**\n\nМассив событий, сортированный в обратном порядке по времени события\n\n| Поле | Описание |\n| --- | --- |\n| `member_id` | id подписчика |\n| `action_time` | дата и время события |\n| `campaign_id` | id рассылки, в которой произошло событие |\n| `list_id` | id адресной базы, используемой при рассылке |\n| `action` | тип события {campaign-sent, campaign-opened, campaign-clicked, unsubscribe, bounced, abuse-report} |\n| `action_text` | расшифровка события |\n| `campaign_name` | название рассылки, в которой произошло событие |\n| `bounce_category` | [для возвратов] категория возврата письма {hrd,sft,blk,spm} |\n| `bounce_reason` | [для возвратов] полный текст ошибки возврата письма |\n\n[Метод в документации](https://dashamail.ru/api/v1/lists/#lists.member_activity)" }, "response": [] }, { "name": "lists.upload", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=lists.upload", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "lists.upload", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Импорт подписчиков из файла\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `list_id` | int, обязательный | id адресной базы |\n| `file` | string, обязательный | url импортируемого файла |\n| `email` | int, обязательный | номер столбца импортируемого файла, содержащего email (счет от 0) |\n| `merge_1` | int | номер столбца дополнительного поля 1 (счет от 0; параметр обязателен, если поле является обязательным в базе) |\n| `merge_2` | int | номер столбца дополнительного поля 2 (счет от 0; параметр обязателен, если поле является обязательным в базе) |\n| `merge_3` | int | номер столбца дополнительного поля 3 (счет от 0; параметр обязателен, если поле является обязательным в базе) |\n| `merge_4` | int | номер столбца дополнительного поля 4 (счет от 0; параметр обязателен, если поле является обязательным в базе) |\n| `merge_5` | int | номер столбца дополнительного поля 5 (счет от 0; параметр обязателен, если поле является обязательным в базе) |\n| `merge_6` | int | номер столбца дополнительного поля 6 (счет от 0; параметр обязателен, если поле является обязательным в базе) |\n| `merge_7` | int | номер столбца дополнительного поля 7 (счет от 0; параметр обязателен, если поле является обязательным в базе) |\n| `merge_8` | int | номер столбца дополнительного поля 8 (счет от 0; параметр обязателен, если поле является обязательным в базе) |\n| `merge_9` | int | номер столбца дополнительного поля 9 (счет от 0; параметр обязателен, если поле является обязательным в базе) |\n| `merge_10` | int | номер столбца дополнительного поля 10 (счет от 0; параметр обязателен, если поле является обязательным в базе) |\n| `gender` | enum | пол подписчика, возможные значения: m - мужчина, f - женщина, n - неизвестно |\n| `type` | string, обязательный | расширение импортируемого файла (\"xls\",\"csv\",\"xlsx\",\"xml\",\"ods\",\"slk\",\"gnumeric\") |\n| `update` | string | обновлять существующие записи, если этот параметр задан (например, true) |\n| `sheet_index` | int | номер листа в xls-книге (по умолчанию - первый) |\n| `sheet_name` | string | название листа в xls-книге (по умолчанию - первый) |\n\n[Метод в документации](https://dashamail.ru/api/v1/lists/#lists.upload)", "body": { "mode": "raw", "raw": "{\n \"list_id\": 128341,\n \"file\": \"значение\",\n \"email\": \"ivan@example.com\",\n \"type\": \"значение\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "lists.add_member", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=lists.add_member", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "lists.add_member", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Добавляем подписчика в базу\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `list_id` | int, обязательный | id адресной базы, в которую добавляется подписчик |\n| `email` | string, обязательный | email подписчика |\n| `merge_1` | string | дополнительное поле 1 |\n| `merge_2` | string | дополнительное поле 2 |\n| `merge_3` | string | дополнительное поле 3 |\n| `merge_4` | string | дополнительное поле 4 |\n| `merge_5` | string | дополнительное поле 5 |\n| `merge_6` | string | дополнительное поле 6 |\n| `merge_7` | string | дополнительное поле 7 |\n| `merge_8` | string | дополнительное поле 8 |\n| `merge_9` | string | дополнительное поле 9 |\n| `merge_10` | string | дополнительное поле 10 |\n| `gender` | enum | пол подписчика, возможные значения: m - мужчина, f - женщина, n - неизвестно |\n| `region` | int | регион подписчика согласно кодам субъектов Российской Федерации, например, 77 – Москва |\n| `update` | string | обновлять существующие записи, если этот параметр задан |\n| `no_check` | string | не проверять валидность адреса, если этот параметр задан |\n| `update_tags` | string | если параметр = on, то теги из запроса добавляются к текущим, если параметр = off – целиком заменяются |\n\n**Что возвращается**\n\nid добавленного подписчика\n\n[Метод в документации](https://dashamail.ru/api/v1/lists/#lists.add_member)", "body": { "mode": "raw", "raw": "{\n \"list_id\": 128341,\n \"email\": \"ivan@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "lists.add_member_batch", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=lists.add_member_batch", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "lists.add_member_batch", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Добавляем несколько подписчиков в базу\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `list_id` | int, обязательный | id адресной базы, в которую добавляется подписчики |\n| `batch` | JSON, обязательный | JSON-массив добавленных подписчиков: [{\"email\":\" test1@dashamail.ru \",\"merge_1\":\"Ваня\",\"gender\":\"m\",\"region\":17,\"state\":\"active\"},{\"email\":\" test2@inbox.ru \",\"merge_1\":\"Петя\",\"state\":\"inactive\"}]. Каждый JSON-объект подписчика может сохранять следующие параметры: адрес электронной почты (email-адрес подписчика), merge_xxx (значения дополнительных полей), состояние (активный – активен, неактивный – неактивен), пол (пол подписчика, возможные значения: m – мужчина, f – женщина, n – неизвестно), регион (номер региона подписчика) |\n| `update` | string | обновлять существующие записи, если этот параметр задан |\n| `no_check` | string | не проверять валидность адреса, если этот параметр задан |\n\n**Что возвращается**\n\nid добавленных подписчиков через запятую\n\n[Метод в документации](https://dashamail.ru/api/v1/lists/#lists.add_member_batch)", "body": { "mode": "raw", "raw": "{\n \"list_id\": 128341,\n \"batch\": \"[]\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "lists.update_member", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=lists.update_member", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "lists.update_member", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Редактируем подписчика в базе\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `member_id` | int, обязательный | id подписчика [альтернативно email + list_id] |\n| `email` | string, обязательный | email подписчика совместно с list_id могут использоваться для выбора подписчика вместо member_id |\n| `list_id` | int, обязательный | list_id подписчика совместно с email могут использоваться для выбора подписчика вместо member_id |\n| `state` | string | активировать подписчика - state=active, деактивировать - state=inactive. параметр актуален только для тех клиентов, которым было выдано соответствующее разрешение в отделе тех.поддержки. |\n| `merge_1` | string | дополнительное поле 1 |\n| `merge_2` | string | дополнительное поле 2 |\n| `merge_3` | string | дополнительное поле 3 |\n| `merge_4` | string | дополнительное поле 4 |\n| `merge_5` | string | дополнительное поле 5 |\n| `merge_6` | string | дополнительное поле 6 |\n| `merge_7` | string | дополнительное поле 7 |\n| `merge_8` | string | дополнительное поле 8 |\n| `merge_9` | string | дополнительное поле 9 |\n| `merge_10` | string | дополнительное поле 10 |\n| `gender` | enum | пол подписчика, возможные значения: m - мужчина, f - женщина, n - неизвестно |\n| `region` | int | регион подписчика согласно кодам субъектов Российской Федерации, например, 77 – Москва |\n| `source` | string | источник подписки. Список разрешенных значений с расшифровками для данного параметра: - 'manual' => 'вручную' - 'form' => 'форма подписки' - 'api' => 'API' - 'excel' => 'импорт из Excel' - 'trigger' => 'события' - 'survey' => 'опрос' - 'fblead' => 'FB Ad Lead' - 'floctory' => 'Flocktory' - 'landing' => 'Лендинг' - 'shelter' => 'Shelter PMS' - 'yclients' => 'YClients' - 'qtickets' => 'Qtickets' - 'mdtourist' => 'МоиДокументы' - 'amocrm' => 'AmoCRM' - 'vk' => 'VK-форма' - 'bitrix24' => 'Битрикс24' - 'megaplan' => 'Мегаплан' - 'insales' => 'InSales' - '1cbitrix' => '1С-битрикс' - 'wordpress' => 'Wordpress' - 'joomla' => 'Joomla' - 'tilda' => 'Tilda' - 'cscart' => 'CS-cart' - 'leadplan' => 'LeadPlan' - 'botmother' => 'Botmother' - 'mtslink' => 'МТС Линк' - 'flexbe' => 'Flexbe' - 'retailcrm' => 'RetailCRM' |\n| `update_tags` | string | если параметр = on, то теги из запроса добавляются к текущим, в противном случае – целиком заменяются |\n\n**Что возвращается**\n\nЕсли `msg.err_code` равен нулю, операция прошла успешно.\n\n[Метод в документации](https://dashamail.ru/api/v1/lists/#lists.update_member)", "body": { "mode": "raw", "raw": "{\n \"member_id\": 90412881,\n \"email\": \"ivan@example.com\",\n \"list_id\": 128341\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "lists.delete_member", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=lists.delete_member", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "lists.delete_member", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Удаляем подписчика из базы.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `member_id` | int, обязательный | id удаляемого подписчика |\n\n**Что возвращается**\n\nЕсли `msg.err_code` равен нулю, операция прошла успешно.\n\n[Метод в документации](https://dashamail.ru/api/v1/lists/#lists.delete_member)", "body": { "mode": "raw", "raw": "{\n \"member_id\": 90412881\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "lists.unsubscribe_member", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=lists.unsubscribe_member", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "lists.unsubscribe_member", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Отписываем подписчика из базы.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `member_id` | int | id отписываемого подписчика |\n| `email` | string | email отписываемого подписчика |\n| `list_id` | string | адресная база из которой надо отписать подписчика. если не задано - отписывается из всевозможных баз. |\n\n**Что возвращается**\n\nколичество отписанных подписчиков (может быть больше 1, если подписчик был отписан из нескольких баз)\n\n[Метод в документации](https://dashamail.ru/api/v1/lists/#lists.unsubscribe_member)", "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "lists.move_member", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=lists.move_member", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "lists.move_member", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Перемещаем подписчика в другую адресную базу.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `member_id` | int, обязательный | id отписываемого подписчика |\n| `list_id` | int, обязательный | id адресной базы в которую перемещаем подписчика |\n\n**Что возвращается**\n\nЕсли `msg.err_code` равен нулю, операция прошла успешно.\n\n[Метод в документации](https://dashamail.ru/api/v1/lists/#lists.move_member)", "body": { "mode": "raw", "raw": "{\n \"member_id\": 90412881,\n \"list_id\": 128341\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "lists.copy_member", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=lists.copy_member", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "lists.copy_member", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Копируем подписчика в другую адресную базу.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `member_id` | int, обязательный | id отписываемого подписчика |\n| `list_id` | int, обязательный | id адресной базы в которую копируем подписчика |\n\n**Что возвращается**\n\nid подписчика-копии\n\n[Метод в документации](https://dashamail.ru/api/v1/lists/#lists.copy_member)", "body": { "mode": "raw", "raw": "{\n \"member_id\": 90412881,\n \"list_id\": 128341\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "lists.add_merge", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=lists.add_merge", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "lists.add_merge", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Добавить дополнительное поле в адресную базу.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `list_id` | int, обязательный | id адресной базы |\n| `type` | string, обязательный | тип поля. возможные значения: text, date, choice, number, tags |\n| `choices` | serialized array/JSON, обязательный | сериализированный массив элементов списка. Также может быть в формате JSON. Обязателен, если type = choice |\n| `title` | string | название поля |\n| `req` | string | обязательно ли поле. возможные значения: on, off |\n| `var` | string | название шаблона. должно быть вида %ШАБЛОН% |\n\n**Что возвращается**\n\nЕсли `msg.err_code` равен нулю, операция прошла успешно.\n\n[Метод в документации](https://dashamail.ru/api/v1/lists/#lists.add_merge)", "body": { "mode": "raw", "raw": "{\n \"list_id\": 128341,\n \"type\": \"значение\",\n \"choices\": \"значение\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "lists.update_merge", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=lists.update_merge", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "lists.update_merge", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Обновить настройки дополнительного поля в адресной базе.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `list_id` | int, обязательный | id адресной базы |\n| `merge_id` | int, обязательный | номер дополнительного поля. возможные значения: от 1 до 10. |\n| `choices` | serialized array | сериализированный массив элементов списка. Обязателен, если type = choice |\n| `title` | string | название поля |\n| `req` | string | обязательно ли поле. возможные значения: on, off |\n| `var` | string | название шаблона. должно быть вида %ШАБЛОН% |\n\n**Что возвращается**\n\nЕсли `msg.err_code` равен нулю, операция прошла успешно.\n\n[Метод в документации](https://dashamail.ru/api/v1/lists/#lists.update_merge)", "body": { "mode": "raw", "raw": "{\n \"list_id\": 128341,\n \"merge_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "lists.delete_merge", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=lists.delete_merge", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "lists.delete_merge", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Удалить дополнительное поле из адресной базы.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `list_id` | int, обязательный | id адресной базы |\n| `merge_id` | int, обязательный | номер дополнительного поля. возможные значения: от 1 до 10. |\n\n**Что возвращается**\n\nЕсли `msg.err_code` равен нулю, операция прошла успешно.\n\n[Метод в документации](https://dashamail.ru/api/v1/lists/#lists.delete_merge)", "body": { "mode": "raw", "raw": "{\n \"list_id\": 128341,\n \"merge_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "lists.last_status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=lists.last_status&email=ivan%40example.com", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "lists.last_status", "description": "(обязательный) Имя вызываемого метода." }, { "key": "email", "value": "ivan@example.com", "description": "(обязательный) email-адрес подписчика" }, { "key": "list_id", "value": "128341", "description": "(int) id адресной базы", "disabled": true } ] }, "description": "Получить последний статус конкретного email в адресных базах\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `email` | string, обязательный | email-адрес подписчика |\n| `list_id` | int | id адресной базы |\n\n**Что возвращается**\n\nМассив подписчиков с параметрами.\n\n| Поле | Описание |\n| --- | --- |\n| `status` | unsubscribed/bounced/clicked/opened/delivered |\n| `date` | время в формате datetime данного события |\n\n[Метод в документации](https://dashamail.ru/api/v1/lists/#lists.last_status)" }, "response": [] }, { "name": "lists.get_import_history", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=lists.get_import_history", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "lists.get_import_history", "description": "(обязательный) Имя вызываемого метода." }, { "key": "list_id", "value": "128341", "description": "(int) id адресной базы", "disabled": true } ] }, "description": "Получить историю и результаты импорта адресной базы\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `list_id` | int | id адресной базы |\n\n**Что возвращается**\n\nМассив результатов импортов с параметрами.\n\n| Поле | Описание |\n| --- | --- |\n| `id` | id импорта |\n| `list_id` | id адресной базы |\n| `username` | имя пользователя, производившего импорт |\n| `message` | результат импорта с ссылками на не прошедших фильтры, отписавшихся, в черном списке, список возвратов |\n| `type` | {success,errors,in_progress} |\n| `file_name` | имя импортируемого файла |\n| `time` | время запуска импорта |\n\n[Метод в документации](https://dashamail.ru/api/v1/lists/#lists.get_import_history)" }, "response": [] } ] }, { "name": "Рассылки", "description": "Создание, отправка и расписание массовых рассылок.", "item": [ { "name": "campaigns.get", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=campaigns.get", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "campaigns.get", "description": "(обязательный) Имя вызываемого метода." }, { "key": "campaign_id", "value": "5512", "description": "(int) id запрашиваемой рассылки", "disabled": true }, { "key": "status", "value": "значение", "description": "{DRAFT, SCHEDULE, MODERATING, CREATED, PROCESSING, SENT, BLOCKED, SUBSCRIBE, BLOCKED-SPAM, NEED-FIX} - статус рассылки", "disabled": true }, { "key": "list_id", "value": "128341", "description": "(int) фильтр рассылок по адресным базам", "disabled": true }, { "key": "workflow", "value": "1", "description": "(int) ID автоматизации/потока для получения списка рассылок, содержащихся в нем", "disabled": true }, { "key": "member_id", "value": "90412881", "description": "(int) в случае передачи в даннном параметре id подписчика вместе с campaign_id в результатах текстовой версии (plain_text) и html будут подставлены все теги персонализации, а также динамический контент для данного подписчика", "disabled": true }, { "key": "start", "value": "2026-08-01", "description": "(date) фильтр рассылок по времени, начальная дата, формат: YYYY-MM-DD", "disabled": true }, { "key": "end ", "value": "2026-08-01", "description": "(date) фильтр рассылок по времени, конечная дата, формат: YYYY-MM-DD", "disabled": true }, { "key": "type", "value": "значение", "description": "{online_builder, html} - тип кампании (онлайн-редактор, html-шаблон)", "disabled": true }, { "key": "limit", "value": "1", "description": "(int) количество записей для вывода. по-умолчанию: без ограничений", "disabled": true } ] }, "description": "Получаем список рассылок пользователя\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `campaign_id` | int | id запрашиваемой рассылки |\n| `status` | string | {DRAFT, SCHEDULE, MODERATING, CREATED, PROCESSING, SENT, BLOCKED, SUBSCRIBE, BLOCKED-SPAM, NEED-FIX} - статус рассылки |\n| `list_id` | int | фильтр рассылок по адресным базам |\n| `workflow` | int | ID автоматизации/потока для получения списка рассылок, содержащихся в нем |\n| `member_id` | int | в случае передачи в даннном параметре id подписчика вместе с campaign_id в результатах текстовой версии (plain_text) и html будут подставлены все теги персонализации, а также динамический контент для данного подписчика |\n| `start` | date | фильтр рассылок по времени, начальная дата, формат: YYYY-MM-DD |\n| `end ` | date | фильтр рассылок по времени, конечная дата, формат: YYYY-MM-DD |\n| `type` | string | {online_builder, html} - тип кампании (онлайн-редактор, html-шаблон) |\n| `limit` | int | количество записей для вывода. по-умолчанию: без ограничений |\n\n**Что возвращается**\n\nМассив подписчиков с параметрами.\n\n| Поле | Описание |\n| --- | --- |\n| `id` | id рассылки |\n| `external_campaign_id` | внешний id рассылки |\n| `channel` | канал рассылки. возможные значения: email, sms, viber, whatsapp, telegram, notify, push, webpush |\n| `type` | тип рассылки. возможные значения: online_builder, html. |\n| `status` | {DRAFT, SCHEDULE, MODERATING, CREATED, PROCESSING, SENT, BLOCKED} - статус рассылки |\n| `name` | название рассылки |\n| `list_id` | id адресной базы, по которой была отправлена рассылка. |\n| `subject` | заголовок письма |\n| `from_name` | от кого письмо? |\n| `from_email` | обратный адрес |\n| `personalizeToEmail` | {on/off} - включить/выключить персонализацию в поле \"Кому:\" |\n| `to_email` | персонализация в поле \"Кому:\" [можно использовать %ТЭГИ% из дополнительных полей базы, например %EMAIL%] |\n| `track_opens` | {Y,N} - следить за открыванием |\n| `track_clicks` | {Y,N} - отслеживать клики |\n| `plain_clicks` | {Y,N} - отслеживать клики в текстовой версии |\n| `analytics` | {google,N} - добавить Yandex.Метрике для отслеживания всех URLs |\n| `analytics_tag` | текстовый тег, как рассылка будет отображаться в Yandex.Метрике |\n| `analytics_source` | utm_source для отображения кликов в Yandex.Метрике |\n| `analytics_medium` | utm_medium для отображения кликов в Yandex.Метрике |\n| `analytics_content` | utm_content для отображения кликов в Yandex.Метрике |\n| `analytics_term` | utm_term для отображения кликов в Yandex.Метрике |\n| `html` | код html-версии письма |\n| `plain_text` | текстовая версия письма |\n| `delivery_time` | время отправки рассылки |\n| `auto` | статус для авторассылки (0 - не активна, 1 - активна, 2 - в архиве) |\n| `limit` | лимит отправки писем на рассылку или, в случае задания wait_time для плавной отправки, на временной период |\n| `wait_time` | временной период в секундах для ожидания перед отправкой следующей части отправкой частями |\n| `allow_time_zone` | {Y,N} - учитывать локальное время подписчика при запланированной на определенное время отправке |\n| `allow_best_time` | {Y,N} - оптимизировать время получения письма, функция \"лучшее время доставки\" |\n| `emails_sent` | общее число отправленных писем в рамках этой рассылки |\n\n[Метод в документации](https://dashamail.ru/api/v1/campaigns/#campaigns.get)" }, "response": [] }, { "name": "campaigns.create", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=campaigns.create", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "campaigns.create", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Создаем рассылку.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `list_id` | serialized array, обязательный | индексный массив адресных баз, по которым будет создана рассылка. Структура: порядковый номер (от нуля) => id базы. Массив можно передавать в сериализованном виде или в формате json. |\n| `name` | string | название рассылки |\n| `subject` | string | заголовок письма [должно соответствовать содержанию письма и не отталкивать] |\n| `from_name` | string | от кого письмо? [используйте что-нибудь запоминающееся, например, название вашей компании] |\n| `from_email` | string | обратный адрес [ответы ваших подписчиков будут приходить на этот адрес] |\n| `personalizeToEmail` | string | {on/off} - включить/выключить персонализацию в поле \"Кому:\" [default: off] |\n| `to_email` | string | персонализация в поле \"Кому:\" [можно использовать %ТЭГИ% из дополнительных полей базы, например %EMAIL%] |\n| `track_opens` | string | {Y,N} - следить за открыванием [default: Y] |\n| `track_clicks` | string | {Y,N} - отслеживать клики [default: Y] |\n| `plain_clicks` | string | {Y,N} - отслеживать клики в текстовой версии [default: N] |\n| `no_images_add` | string | {0,1} - не прикладывать картинки к письму. [default: 0] - по умолчанию прикладываются. помогает проходить спам-фильтры и отображает картинки даже у тех получателей, у кого они по умолчанию отключены |\n| `analytics` | string | {google,N} - добавить Google Analytics™ для отслеживания всех URLs [default: N] |\n| `analytics_tag` | string | текстовый тег, как рассылка будет отображаться в Google Analytics™, например: Рассылка_9_17_2011 |\n| `html` | string | код html-версии письма. Либо id сохраненного html-шаблона. Либо сохраненный шаблон из ЛК (из раздела Шаблоны) в формате tmpl1234, где 1234 это id шаблона |\n| `plain_text` | string | текстовая версия письма |\n| `esegment` | serialized array | сегменты баз для рассылки. Структура массива: id базы => массив сегмента. Структура массивов сегмента: [match] = {any\\|all} - должны выполняться все или любые из условия. [c] - массив условий. Содержит поля: [field] - тип поля (email, merge_{1..10}), [op] - условие {is, is not, contains, notcontain, starts, ends, greater, less}, [value] - значение поля. Например: array['match']='any';array['c'][0]['field']='email';array['c'][0]['op']='is';array['c'][0]['value']='support@dashamail.ru'; Массив можно передавать в сериализованном виде или в формате json. |\n\n**Что возвращается**\n\nid созданной рассылки\n\n[Метод в документации](https://dashamail.ru/api/v1/campaigns/#campaigns.create)", "body": { "mode": "raw", "raw": "{\n \"list_id\": 128341\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "campaigns.create_auto", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=campaigns.create_auto", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "campaigns.create_auto", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Создаем авторассылку.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `list_id` | serialized array | индексный массив адресных баз, на события в которых будет реагировать авторассылка. Структура: порядковый номер (от нуля) => id базы. Только для событий добавления в базу и изменения доп. полей. Массив можно передавать в сериализованном виде или в формате json. |\n| `name` | string | название рассылки |\n| `subject` | string | заголовок письма [должно соответствовать содержанию письма и не отталкивать] |\n| `from_name` | string | от кого письмо? [используйте что-нибудь запоминающееся, например, название вашей компании] |\n| `from_email` | string | обратный адрес [ответы ваших подписчиков будут приходить на этот адрес] |\n| `personalizeToEmail` | string | {on/off} - включить/выключить персонализацию в поле \"Кому:\" [default: off] |\n| `to_email` | string | персонализация в поле \"Кому:\" [можно использовать %ТЭГИ% из дополнительных полей базы, например %EMAIL%] |\n| `track_opens` | string | {Y,N} - следить за открыванием [default: Y] |\n| `track_clicks` | string | {Y,N} - отслеживать клики [default: Y] |\n| `plain_clicks` | string | {Y,N} - отслеживать клики в текстовой версии [default: N] |\n| `no_images_add` | string | {0,1} - не прикладывать картинки к письму. [default: 0] - по умолчанию прикладываются. помогает проходить спам-фильтры и отображает картинки даже у тех получателей, у кого они по умолчанию отключены |\n| `analytics` | string | {google,N} - добавить Google Analytics™ для отслеживания всех URLs [default: N] |\n| `analytics_tag` | string | текстовый тег, как рассылка будет отображаться в Google Analytics™, например: Рассылка_9_17_2011 |\n| `html` | string | код html-версии письма. Либо id сохраненного html-шаблона. Либо сохраненный шаблон из ЛК (из раздела Шаблоны) в формате tmpl1234, где 1234 это id шаблона |\n| `plain_text` | string | текстовая версия письма |\n| `action` | string | события, на которые реагирует авторассылка. допустимые значения: open - открытие письма, edit - изменение доп. полей подписчика или любая (перечислять через запятую) комбинация из {form - подписка через форму, add - ручное добавление, upload - импорт}. по умолчанию - подписка через форму |\n| `delay_1` | int | время задержки |\n| `delay_2` | string | {hour, day, week} - единица измерения времени задержки |\n| `schedule_time` | string | назначенное время отправки при срабатывании \"важной даты\". например, 10:00:00 |\n| `campaigns` | string | перечисленные через запятую id рассылок, на открытия в которых должна реагировать авторассылка - для события open или номера полей, на изменение которых должна реагировать авторассылка - для события edit |\n| `auto` | int | {0, 1, 2} - состояние авторассылки: 0 - черновик, 1 - активна, 2 - в архиве |\n\n**Что возвращается**\n\nid созданной рассылки\n\n[Метод в документации](https://dashamail.ru/api/v1/campaigns/#campaigns.create_auto)", "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "campaigns.update", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=campaigns.update", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "campaigns.update", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Обновляем параметры рассылки.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `campaign_id` | int, обязательный | id обновляемой кампании |\n| `list_id` | serialized array | индексный массив адресных баз, по которым будет создана рассылка. Структура: порядковый номер (от нуля) => id базы. Массив можно передавать в сериализованном виде или в формате json. |\n| `name` | string | название рассылки |\n| `subject` | string | заголовок письма [должно соответствовать содержанию письма и не отталкивать] |\n| `from_name` | string | от кого письмо? [используйте что-нибудь запоминающееся, например, название вашей компании] |\n| `from_email` | string | обратный адрес [ответы ваших подписчиков будут приходить на этот адрес] |\n| `personalizeToEmail` | string | {on/off} - включить/выключить персонализацию в поле \"Кому:\" [default: off] |\n| `to_email` | string | персонализация в поле \"Кому:\" [можно использовать %ТЭГИ% из дополнительных полей базы, например %EMAIL%] |\n| `track_opens` | string | {Y,N} - следить за открыванием [default: Y] |\n| `track_clicks` | string | {Y,N} - отслеживать клики [default: Y] |\n| `plain_clicks` | string | {Y,N} - отслеживать клики в текстовой версии [default: N] |\n| `no_images_add` | string | {0,1} - не прикладывать картинки к письму. [default: 0] - по умолчанию прикладываются. помогает проходить спам-фильтры и отображает картинки даже у тех получателей, у кого они по умолчанию отключены |\n| `analytics` | string | {google,N} - добавить Google Analytics™ для отслеживания всех URLs [default: N] |\n| `analytics_tag` | string | текстовый тег, как рассылка будет отображаться в Google Analytics™, например: Рассылка_9_17_2011 |\n| `html` | string | код html-версии письма. Либо id сохраненного html-шаблона. Либо сохраненный шаблон из ЛК (из раздела Шаблоны) в формате tmpl1234, где 1234 это id шаблона |\n| `plain_text` | string | текстовая версия письма |\n| `status` | string | [DRAFT, SCHEDULE, MODERATING] - перевод в статус SCHEDULE или MODERATING возможен только если рассылка удовлетворяет ряду условий: - заданы $subject, $from_name, $from_email - задана $html или $plain_text версия письма - есть ссылка на отписку для подписчиков вида [отписаться](%ОТПИСАТЬСЯ%) для html-версии и %ОТПИСАТЬСЯ% для plain-text версии if (status=SCHEDULE) : delivery_time в формате mysql: YYYY-MM-DD HH:MM:SS |\n| `esegment` | serialized array | сегменты баз для рассылки. Структура массива: id базы => массив сегмента. Структура массивов сегмента: [match] = {any\\|all} - должны выполняться все или любые из условия. [c] - массив условий. Содержит поля: [field] - тип поля (email, merge_{1..10}), [op] - условие {is, is not, contains, notcontain, starts, ends, greater, less}, [value] - значение поля. Например: array['match']='any';array['c'][0]['field']='email';array['c'][0]['op']='is';array['c'][0]['value']='support@dashamail.ru'; Массив можно передавать в сериализованном виде или в формате json. |\n\n**Что возвращается**\n\nЕсли `msg.err_code` равен нулю, операция прошла успешно.\n\n[Метод в документации](https://dashamail.ru/api/v1/campaigns/#campaigns.update)", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": 5512\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "campaigns.update_auto", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=campaigns.update_auto", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "campaigns.update_auto", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Обновляем параметры авторассылки.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `campaign_id` | int, обязательный | id обновляемой кампании |\n| `list_id` | serialized array | индексный массив адресных баз, на события в которых будет реагировать авторассылка. Структура: порядковый номер (от нуля) => id базы. Только для событий добавления в базу и изменения доп. полей. Массив можно передавать в сериализованном виде или в формате json. |\n| `name` | string | название рассылки |\n| `subject` | string | заголовок письма [должно соответствовать содержанию письма и не отталкивать] |\n| `from_name` | string | от кого письмо? [используйте что-нибудь запоминающееся, например, название вашей компании] |\n| `from_email` | string | обратный адрес [ответы ваших подписчиков будут приходить на этот адрес] |\n| `personalizeToEmail` | string | {on/off} - включить/выключить персонализацию в поле \"Кому:\" [default: off] |\n| `to_email` | string | персонализация в поле \"Кому:\" [можно использовать %ТЭГИ% из дополнительных полей базы, например %EMAIL%] |\n| `track_opens` | string | {Y,N} - следить за открыванием [default: Y] |\n| `track_clicks` | string | {Y,N} - отслеживать клики [default: Y] |\n| `plain_clicks` | string | {Y,N} - отслеживать клики в текстовой версии [default: N] |\n| `no_images_add` | string | {0,1} - не прикладывать картинки к письму. [default: 0] - по умолчанию прикладываются. помогает проходить спам-фильтры и отображает картинки даже у тех получателей, у кого они по умолчанию отключены |\n| `analytics` | string | {google,N} - добавить Google Analytics™ для отслеживания всех URLs [default: N] |\n| `analytics_tag` | string | текстовый тег, как рассылка будет отображаться в Google Analytics™, например: Рассылка_9_17_2011 |\n| `html` | string | код html-версии письма. Либо id сохраненного html-шаблона. Либо сохраненный шаблон из ЛК (из раздела Шаблоны) в формате tmpl1234, где 1234 это id шаблона |\n| `plain_text` | string | текстовая версия письма |\n| `delay_1` | int | время задержки |\n| `delay_2` | string | {hour, day, week} - единица измерения времени задержки |\n| `campaigns` | string | перечисленные через запятую id рассылок, на открытия в которых должна реагировать авторассылка - для события open или номера полей, на изменение которых должна реагировать авторассылка - для события edit |\n| `auto` | int | {0, 1, 2} - состояние авторассылки: 0 - черновик, 1 - активна, 2 - в архиве |\n\n**Что возвращается**\n\nЕсли `msg.err_code` равен нулю, операция прошла успешно.\n\n[Метод в документации](https://dashamail.ru/api/v1/campaigns/#campaigns.update_auto)", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": 5512\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "campaigns.delete", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=campaigns.delete", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "campaigns.delete", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Удаляем рассылку\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `campaign_id` | int, обязательный | id удаляемой рассылки |\n\n**Что возвращается**\n\nЕсли `msg.err_code` равен нулю, операция прошла успешно.\n\n[Метод в документации](https://dashamail.ru/api/v1/campaigns/#campaigns.delete)", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": 5512\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "campaigns.delete_automation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=campaigns.delete_automation", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "campaigns.delete_automation", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Удаляем рассылку в автоматизации\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `campaign_id` | int, обязательный | id удаляемой рассылки в автоматизации |\n\n**Что возвращается**\n\nЕсли `msg.err_code` равен нулю, операция прошла успешно.\n\n[Метод в документации](https://dashamail.ru/api/v1/campaigns/#campaigns.delete_automation)", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": 5512\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "campaigns.copy", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=campaigns.copy", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "campaigns.copy", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Копируем рассылку\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `campaign_id` | int, обязательный | id копируемой рассылки |\n\n**Что возвращается**\n\nid новой скопированной рассылки\n\n[Метод в документации](https://dashamail.ru/api/v1/campaigns/#campaigns.copy)", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": 5512\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "campaigns.attach", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=campaigns.attach", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "campaigns.attach", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Добавляем вложение\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `campaign_id` | int, обязательный | id рассылки |\n| `url` | string, обязательный | адрес файла |\n| `name` | string | название файла после загрузки (полезно при динамической генерации контента). Указывается вместе с расширением. |\n\n**Что возвращается**\n\nid приложенного файла\n\n[Метод в документации](https://dashamail.ru/api/v1/campaigns/#campaigns.attach)", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": 5512,\n \"url\": \"https://example.com/\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "campaigns.get_attachments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=campaigns.get_attachments&campaign_id=5512", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "campaigns.get_attachments", "description": "(обязательный) Имя вызываемого метода." }, { "key": "campaign_id", "value": "5512", "description": "(обязательный, int) id рассылки" } ] }, "description": "Получаем приложенные файлы\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `campaign_id` | int, обязательный | id рассылки |\n\n**Что возвращается**\n\nМассив строк адресных баз с различными параметрами. Вложенный массив подразумевается сериализорованным.\n\n| Поле | Описание |\n| --- | --- |\n| `id` | id файла |\n| `campaign_id` | id рассылки |\n| `name` | название файла |\n| `size` | размер файла в байтах |\n| `updated_at` | время добавления |\n\n[Метод в документации](https://dashamail.ru/api/v1/campaigns/#campaigns.get_attachments)" }, "response": [] }, { "name": "campaigns.delete_attachment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=campaigns.delete_attachment", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "campaigns.delete_attachment", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Удаляем приложенный файл\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `campaign_id` | int, обязательный | id рассылки |\n| `id` | int, обязательный | id файла |\n\n**Что возвращается**\n\nЕсли `msg.err_code` равен нулю, операция прошла успешно.\n\n[Метод в документации](https://dashamail.ru/api/v1/campaigns/#campaigns.delete_attachment)", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": 5512,\n \"id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "campaigns.get_saved_templates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=campaigns.get_saved_templates", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "campaigns.get_saved_templates", "description": "(обязательный) Имя вызываемого метода." }, { "key": "name", "value": "Клиенты интернет-магазина", "description": "название шаблона", "disabled": true }, { "key": "id", "value": "1", "description": "(int) id шаблона", "disabled": true } ] }, "description": "Получаем шаблоны из ЛК\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `name` | string | название шаблона |\n| `id` | int | id шаблона |\n\n**Что возвращается**\n\nМассив шаблонов с параметрами.\n\n| Поле | Описание |\n| --- | --- |\n| `id` | id шаблона |\n| `name` | название шаблона |\n\n[Метод в документации](https://dashamail.ru/api/v1/campaigns/#campaigns.get_saved_templates)" }, "response": [] }, { "name": "campaigns.add_template", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=campaigns.add_template", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "campaigns.add_template", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Добавляем html шаблон\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `name` | string, обязательный | название шаблона |\n| `template` | string, обязательный | html-код либо id рассылки, откуда взять html |\n\n**Что возвращается**\n\nid нового шаблона\n\n[Метод в документации](https://dashamail.ru/api/v1/campaigns/#campaigns.add_template)", "body": { "mode": "raw", "raw": "{\n \"name\": \"Клиенты интернет-магазина\",\n \"template\": \"значение\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "campaigns.delete_template", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=campaigns.delete_template", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "campaigns.delete_template", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Удаляем html шаблон\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `id` | int, обязательный | id шаблона |\n\n**Что возвращается**\n\nЕсли `msg.err_code` равен нулю, операция прошла успешно.\n\n[Метод в документации](https://dashamail.ru/api/v1/campaigns/#campaigns.delete_template)", "body": { "mode": "raw", "raw": "{\n \"id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "campaigns.force_auto", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=campaigns.force_auto", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "campaigns.force_auto", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Принудительно вызываем срабатывание авторассылки (при этом она должна быть активна)\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `campaign_id` | int, обязательный | id авторассылки |\n| `member_id` | int, обязательный | id получателя в адресной базе. |\n| `delay` | int | время задержки отправки (в мс) |\n\n**Что возвращается**\n\nЕсли `msg.err_code` равен нулю, операция прошла успешно.\n\n[Метод в документации](https://dashamail.ru/api/v1/campaigns/#campaigns.force_auto)", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": 5512,\n \"member_id\": 90412881\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "campaigns.get_folders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=campaigns.get_folders", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "campaigns.get_folders", "description": "(обязательный) Имя вызываемого метода." }, { "key": "name", "value": "Клиенты интернет-магазина", "description": "имя папки", "disabled": true }, { "key": "id", "value": "1", "description": "(int) id папки", "disabled": true } ] }, "description": "Получаем папки рассылок\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `name` | string | имя папки |\n| `id` | int | id папки |\n\n**Что возвращается**\n\nМассив папок.\n\n| Поле | Описание |\n| --- | --- |\n| `id` | id папки |\n| `name` | имя папки |\n\n[Метод в документации](https://dashamail.ru/api/v1/campaigns/#campaigns.get_folders)" }, "response": [] }, { "name": "campaigns.move_to_folder", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=campaigns.move_to_folder", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "campaigns.move_to_folder", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Перемещаем рассылку в папку\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `campaign_id` | int, обязательный | id рассылки |\n| `folder_id` | int, обязательный | id папки куда переместить. |\n\n**Что возвращается**\n\nЕсли `msg.err_code` равен нулю, операция прошла успешно.\n\n[Метод в документации](https://dashamail.ru/api/v1/campaigns/#campaigns.move_to_folder)", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": 5512,\n \"folder_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "campaigns.get_automations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=campaigns.get_automations", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "campaigns.get_automations", "description": "(обязательный) Имя вызываемого метода." }, { "key": "id", "value": "1", "description": "(int) id запрашиваемой автоматизации или потока", "disabled": true } ] }, "description": "Получаем список всех автоматизаций и потоков\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `id` | int | id запрашиваемой автоматизации или потока |\n\n**Что возвращается**\n\nМассив автоматизаций с параметрами\n\n| Поле | Описание |\n| --- | --- |\n| `id` | id автоматизации |\n| `name` | название автоматизации |\n| `last_edit_time` | время последнего редактирования |\n| `priority` | приоритет (0 - нормальный, 1 - высокий, 2 - критический) |\n| `type` | automation (автоматизация) или workflow (поток старого типа) |\n\n[Метод в документации](https://dashamail.ru/api/v1/campaigns/#campaigns.get_automations)" }, "response": [] } ] }, { "name": "Отчёты", "description": "Открытия, клики, возвраты и сводная статистика по рассылкам.", "item": [ { "name": "reports.sent", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=reports.sent", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "reports.sent", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Список отправленных писем в рассылке\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `campaign_id` | int, обязательный | id запрашиваемой рассылки |\n| `start` | int | номер записи с которой начинать вывод. defaults: 0 |\n| `limit` | int | количество записей для вывода. defaults: 100 |\n| `order` | string | [ex: \"email desc\"] - поле по которому можно сортировать и порядок сортировки (asc,desc). |\n\n**Что возвращается**\n\nМассив писем c параметрами каждого.\n\n| Поле | Описание |\n| --- | --- |\n| `id` | id письма |\n| `member_id` | id подписчика |\n| `campaign_id` | id рассылки |\n| `list_id` | id адресной базы из которой подписчик |\n| `bounce_code` | smtp-код ошибки в случае возврата сообщения |\n| `bounce_reason` | расшифровка bounce_code в данном конкретном случае |\n| `email` | email получателя |\n| `sent_time` | время доставки письма |\n| `open_time` | время открытия письма |\n| `click_time` | время перехода по ссылке |\n\n[Метод в документации](https://dashamail.ru/api/v1/reports/#reports.sent)", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": 5512\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "reports.delivered", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=reports.delivered", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "reports.delivered", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Список доставленных писем в рассылке\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `campaign_id` | int, обязательный | id запрашиваемой рассылки |\n| `start` | int | номер записи с которой начинать вывод. defaults: 0 |\n| `limit` | int | количество записей для вывода. defaults: 100 |\n| `order` | string | [ex: \"email desc\"] - поле по которому можно сортировать и порядок сортировки (asc,desc). |\n\n**Что возвращается**\n\nМассив писем c параметрами каждого.\n\n| Поле | Описание |\n| --- | --- |\n| `id` | id письма |\n| `member_id` | id подписчика |\n| `campaign_id` | id рассылки |\n| `list_id` | id адресной базы из которой подписчик |\n| `bounce_code` | smtp-код ошибки в случае возврата сообщения |\n| `bounce_reason` | расшифровка bounce_code в данном конкретном случае |\n| `email` | email получателя |\n| `sent_time` | время доставки письма |\n| `open_time` | время открытия письма |\n| `click_time` | время перехода по ссылке |\n\n[Метод в документации](https://dashamail.ru/api/v1/reports/#reports.delivered)", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": 5512\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "reports.opened", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=reports.opened", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "reports.opened", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Список открытых писем в рассылке\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `campaign_id` | int, обязательный | id запрашиваемой рассылки |\n| `start` | int | номер записи с которой начинать вывод. defaults: 0 |\n| `limit` | int | количество записей для вывода. defaults: 100 |\n| `order` | string | [ex: \"email desc\"] - поле по которому можно сортировать и порядок сортировки (asc,desc). |\n\n**Что возвращается**\n\nМассив писем c параметрами каждого.\n\n| Поле | Описание |\n| --- | --- |\n| `id` | id письма |\n| `member_id` | id подписчика |\n| `campaign_id` | id рассылки |\n| `list_id` | id адресной базы из которой подписчик |\n| `bounce_code` | smtp-код ошибки в случае возврата сообщения |\n| `bounce_reason` | расшифровка bounce_code в данном конкретном случае |\n| `email` | email получателя |\n| `sent_time` | время доставки письма |\n| `open_time` | время открытия письма |\n| `click_time` | время перехода по ссылке |\n\n[Метод в документации](https://dashamail.ru/api/v1/reports/#reports.opened)", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": 5512\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "reports.clicked", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=reports.clicked", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "reports.clicked", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Список писем в рассылке, где адресат перешел по любой ссылке\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `campaign_id` | int, обязательный | id запрашиваемой рассылки |\n| `start` | int | номер записи с которой начинать вывод. defaults: 0 |\n| `limit` | int | количество записей для вывода. defaults: 100 |\n| `order` | string | [ex: \"email desc\"] - поле по которому можно сортировать и порядок сортировки (asc,desc). |\n\n**Что возвращается**\n\nМассив писем c параметрами каждого.\n\n| Поле | Описание |\n| --- | --- |\n| `id` | id письма |\n| `member_id` | id подписчика |\n| `campaign_id` | id рассылки |\n| `list_id` | id адресной базы из которой подписчик |\n| `bounce_code` | smtp-код ошибки в случае возврата сообщения |\n| `bounce_reason` | расшифровка bounce_code в данном конкретном случае |\n| `email` | email получателя |\n| `sent_time` | время доставки письма |\n| `open_time` | время открытия письма |\n| `click_time` | время перехода по ссылке |\n\n[Метод в документации](https://dashamail.ru/api/v1/reports/#reports.clicked)", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": 5512\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "reports.unsubscribed", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=reports.unsubscribed", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "reports.unsubscribed", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Список писем отписавшихся подписчиков в рассылке\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `campaign_id` | int, обязательный | id запрашиваемой рассылки |\n| `start` | int | номер записи с которой начинать вывод. defaults: 0 |\n| `limit` | int | количество записей для вывода. defaults: 100 |\n| `order` | string | [ex: \"email desc\"] - поле по которому можно сортировать и порядок сортировки (asc,desc). |\n\n**Что возвращается**\n\nМассив писем c параметрами каждого.\n\n| Поле | Описание |\n| --- | --- |\n| `id` | id письма |\n| `member_id` | id подписчика |\n| `campaign_id` | id рассылки |\n| `list_id` | id адресной базы из которой подписчик |\n| `bounce_code` | smtp-код ошибки в случае возврата сообщения |\n| `bounce_reason` | расшифровка bounce_code в данном конкретном случае |\n| `email` | email получателя |\n| `sent_time` | время доставки письма |\n| `open_time` | время открытия письма |\n| `click_time` | время перехода по ссылке |\n\n[Метод в документации](https://dashamail.ru/api/v1/reports/#reports.unsubscribed)", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": 5512\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "reports.bounced", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=reports.bounced", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "reports.bounced", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Список возвратившихся писем в рассылке\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `campaign_id` | int, обязательный | id запрашиваемой рассылки |\n| `start` | int | номер записи с которой начинать вывод. defaults: 0 |\n| `limit` | int | количество записей для вывода. defaults: 100 |\n| `order` | string | [ex: \"email desc\"] - поле по которому можно сортировать и порядок сортировки (asc,desc). |\n\n**Что возвращается**\n\nМассив писем c параметрами каждого.\n\n| Поле | Описание |\n| --- | --- |\n| `id` | id письма |\n| `member_id` | id подписчика |\n| `campaign_id` | id рассылки |\n| `list_id` | id адресной базы из которой подписчик |\n| `bounce_code` | smtp-код ошибки в случае возврата сообщения |\n| `bounce_reason` | расшифровка bounce_code в данном конкретном случае |\n| `email` | email получателя |\n| `sent_time` | время доставки письма |\n| `open_time` | время открытия письма |\n| `click_time` | время перехода по ссылке |\n\n[Метод в документации](https://dashamail.ru/api/v1/reports/#reports.bounced)", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": 5512\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "reports.clickstat", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=reports.clickstat", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "reports.clickstat", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "статистика по кликам по различным url в письме\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `campaign_id` | int, обязательный | id запрашиваемой рассылки |\n\n**Что возвращается**\n\nМассив url c количеством кликов\n\n| Поле | Описание |\n| --- | --- |\n| `url` | адрес ссылки |\n| `clicks` | общее число кликов по данной ссылке в рамках рассылки |\n\n[Метод в документации](https://dashamail.ru/api/v1/reports/#reports.clickstat)", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": 5512\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "reports.userclicks", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=reports.userclicks", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "reports.userclicks", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "статистика по кликам по указанному url в письме\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `campaign_id` | int, обязательный | id запрашиваемой рассылки |\n| `url` | string, обязательный | адрес ссылки |\n\n**Что возвращается**\n\nМассив с информацией обо всех переходах по данной ссылке\n\n| Поле | Описание |\n| --- | --- |\n| `url` | адрес ссылки |\n| `email` | email перешедшего |\n| `click_time` | время перехода |\n\n[Метод в документации](https://dashamail.ru/api/v1/reports/#reports.userclicks)", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": 5512,\n \"url\": \"https://example.com/\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "reports.bouncestat", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=reports.bouncestat", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "reports.bouncestat", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "статистика по всевозможным причинам возврата письма\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `campaign_id` | int, обязательный | id запрашиваемой рассылки |\n\n**Что возвращается**\n\nМассив ошибок возвращенных писем в рассылке\n\n| Поле | Описание |\n| --- | --- |\n| `bounce_code` | smtp код ошибки |\n| `count` | количество писем с такой ошибкой |\n| `description` | типовое краткое описание ошибки |\n\n[Метод в документации](https://dashamail.ru/api/v1/reports/#reports.bouncestat)", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": 5512\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "reports.summary", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=reports.summary", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "reports.summary", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "краткая статистка по рассылке\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `campaign_id` | int, обязательный | id запрашиваемой рассылки |\n\n**Что возвращается**\n\nМассив с краткой информацией о рассылке\n\n| Поле | Описание |\n| --- | --- |\n| `bounced` | число возвращенных писем |\n| `unsubscribed` | число отписавшихся подписчиков |\n| `delivered` | число доставленных сообщений |\n| `sent` | число отправленных сообщений |\n| `clicks` | общее число кликов |\n| `opened` | число точно открытых писем |\n\n[Метод в документации](https://dashamail.ru/api/v1/reports/#reports.summary)", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": 5512\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "reports.clients", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=reports.clients", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "reports.clients", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "статистика по браузерам, ОС и почтовым клиентам\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `campaign_id` | int, обязательный | id запрашиваемой рассылки |\n\n**Что возвращается**\n\nмассив вида \"название браузера, ОС, клиента\" => количество открытий (только если ненулевое)\n\n| Поле | Описание |\n| --- | --- |\n| `ie` | число пользователей ie > 6 |\n| `ie6` | число пользователей ie6 |\n| `chrome` | число пользователей chrome |\n| `opera` | число пользователей opera |\n| `firefox` | число пользователей firefox |\n| `safari` | число пользователей safari |\n| `mail` | число пользователей mail.ru |\n| `yandex` | число пользователей yandex.ru |\n| `outlook` | число пользователей outlook |\n| `win` | число пользователей Windows |\n| `linux` | число пользователей Linux |\n| `mac` | число пользователей Mac |\n\n[Метод в документации](https://dashamail.ru/api/v1/reports/#reports.clients)", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": 5512\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "reports.geo", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=reports.geo", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "reports.geo", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "статистика по регионам открытия\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `campaign_id` | int, обязательный | id запрашиваемой рассылки |\n\n**Что возвращается**\n\nмассив вида \"город или регион\" => количество открытий (только если ненулевое)\n\n| Поле | Описание |\n| --- | --- |\n| `название города или региона` | число открытий |\n\n[Метод в документации](https://dashamail.ru/api/v1/reports/#reports.geo)", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": 5512\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "reports.events", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=reports.events", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "reports.events", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Список событий с письмами в рамках рассылки за определенный период\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `campaign_id` | int, обязательный | id запрашиваемой рассылки |\n| `time_start` | datetime | время начала выгрузки событий в формате YYYY-DD-MM HH:ii:ss (по-умолчанию: 00:00:00 текущего дня) |\n| `time_end` | datetime | время конца выгрузки событий в формате YYYY-DD-MM HH:ii:ss (по-умолчанию: 23:59:59 текущего дня) |\n| `merge` | JSON-array, обязательный | JSON-массив полей из адресных баз. Например, [\"merge_1\",\"merge_3\",\"rating\"]. Помимо дополнительных полей merge_{1..N} можно получать значения optin_time, rating и gender |\n| `email` | string | email необходимого подписчика |\n| `start` | int | номер записи с которой начинать вывод. defaults: 0 |\n| `limit` | int | количество записей для вывода. defaults: 100 |\n| `order` | string | [ex: \"email desc\"] - поле по которому можно сортировать и порядок сортировки (asc,desc). |\n\n**Что возвращается**\n\nМассив писем c параметрами каждого.\n\n| Поле | Описание |\n| --- | --- |\n| `event_date` | дата события |\n| `event_time` | время события |\n| `event_type` | тип события [SENT, BOUNCED, OPENED, CLICKED, PREVIEW, UNSUBSCRIBED, COMPLAINED] |\n| `bounce_category` | [hrd, sft, blk, spm] |\n| `bounce_code` | код ошибки доставки |\n| `bounce_reason` | расшифровка ошибки доставки |\n| `email` | email-адрес получателя |\n| `domain` | домен получателя |\n| `user_id` | id клиента |\n| `campaign_id` | id рассылки |\n| `member_id` | id подписчика в системе Dashamail |\n| `list_id` | id адресной базы |\n| `url_hash` | хэш url в случае клика |\n| `url_pers` | ссылка персонализированная |\n| `url_original` | ссылка оригинальная из макета |\n| `ip` | ip-адрес |\n| `ip_aton` | ip-адрес в формате ATON |\n| `region` | регион |\n| `OS` | операционная система |\n| `browser` | браузер |\n| `webservice` | почтовый веб-сервис |\n| `user_agent` | User Agent полный устройства |\n| `referer` | источник перехода |\n| `language` | язык пользователя на устройстве |\n| `device` | устройство |\n| `dark_mode` | 0 - светлый режим, 1 - темный режим |\n\n[Метод в документации](https://dashamail.ru/api/v1/reports/#reports.events)", "body": { "mode": "raw", "raw": "{\n \"campaign_id\": 5512,\n \"merge\": \"значение\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Аккаунт", "description": "Настройки и состояние аккаунта.", "item": [ { "name": "account.get_balance", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=account.get_balance", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "account.get_balance", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "текущий баланс\n\n**Что возвращается**\n\n| Поле | Описание |\n| --- | --- |\n| `limit_members` | максимальное количество подписчиков, которое можно хранить на аккаунте (если не ограничено, этот параметр равен нулю) |\n| `limit_emails` | доступное клоичество писем |\n| `members` | актуальное количество подписчиков на аккаунте (уникальных) |\n\n[Метод в документации](https://dashamail.ru/api/v1/account/#account.get_balance)" }, "response": [] } ] }, { "name": "Диалоги", "description": "Переписка с подписчиками — Даша.Диалоги.", "item": [ { "name": "dialogs.list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=dialogs.list", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "dialogs.list", "description": "(обязательный) Имя вызываемого метода." }, { "key": "status", "value": "значение", "description": "фильтр по статусу: open, closed, all. По-умолчанию: open", "disabled": true }, { "key": "unread_only", "value": "1", "description": "(int) только непрочитанные: 1 или 0. По-умолчанию: 0", "disabled": true }, { "key": "campaign_id", "value": "5512", "description": "(int) id кампании для фильтрации", "disabled": true }, { "key": "list_id", "value": "128341", "description": "(int) id адресной базы для фильтрации", "disabled": true }, { "key": "q", "value": "значение", "description": "поисковый запрос (по email подписчика, теме письма или названию кампании)", "disabled": true }, { "key": "limit", "value": "1", "description": "(int) количество результатов (1-200). По-умолчанию: 50", "disabled": true }, { "key": "offset", "value": "1", "description": "(int) смещение для пагинации. По-умолчанию: 0", "disabled": true } ] }, "description": "Получаем список диалогов\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `status` | string | фильтр по статусу: open, closed, all. По-умолчанию: open |\n| `unread_only` | int | только непрочитанные: 1 или 0. По-умолчанию: 0 |\n| `campaign_id` | int | id кампании для фильтрации |\n| `list_id` | int | id адресной базы для фильтрации |\n| `q` | string | поисковый запрос (по email подписчика, теме письма или названию кампании) |\n| `limit` | int | количество результатов (1-200). По-умолчанию: 50 |\n| `offset` | int | смещение для пагинации. По-умолчанию: 0 |\n\n**Что возвращается**\n\nМассив диалогов с параметрами.\n\n| Поле | Описание |\n| --- | --- |\n| `id` | id диалога |\n| `user_id` | id аккаунта |\n| `sub_id` | id субаккаунта |\n| `campaign_id` | id кампании |\n| `list_id` | id адресной базы |\n| `member_id` | id подписчика |\n| `subscriber_email` | email подписчика |\n| `subject` | тема письма |\n| `status` | статус диалога: open или closed |\n| `unread_count` | количество непрочитанных сообщений |\n| `last_message_at` | дата и время последнего сообщения |\n| `last_inbound_at` | дата и время последнего входящего сообщения |\n| `created_at` | дата и время создания диалога |\n| `campaign_name` | название кампании |\n| `last_message_preview` | превью последнего сообщения (до 250 символов) |\n| `has_attachments` | есть ли вложения в диалоге (true/false) |\n\n[Метод в документации](https://dashamail.ru/api/v1/dialogs/#dialogs.list)" }, "response": [] }, { "name": "dialogs.get", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=dialogs.get&dialog_id=1", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "dialogs.get", "description": "(обязательный) Имя вызываемого метода." }, { "key": "dialog_id", "value": "1", "description": "(обязательный, int) id диалога" } ] }, "description": "Получаем данные конкретного диалога\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `dialog_id` | int, обязательный | id диалога |\n\n**Что возвращается**\n\nДанные диалога.\n\n| Поле | Описание |\n| --- | --- |\n| `id` | id диалога |\n| `user_id` | id аккаунта |\n| `sub_id` | id субаккаунта |\n| `campaign_id` | id кампании |\n| `list_id` | id адресной базы |\n| `member_id` | id подписчика |\n| `subscriber_email` | email подписчика |\n| `subject` | тема письма |\n| `status` | статус диалога: open или closed |\n| `unread_count` | количество непрочитанных сообщений |\n| `last_message_at` | дата и время последнего сообщения |\n| `created_at` | дата и время создания диалога |\n| `campaign_name` | название кампании |\n\n[Метод в документации](https://dashamail.ru/api/v1/dialogs/#dialogs.get)" }, "response": [] }, { "name": "dialogs.messages", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=dialogs.messages", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "dialogs.messages", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Получаем сообщения диалога\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `dialog_id` | int, обязательный | id диалога |\n| `limit` | int | количество сообщений (1-200). По-умолчанию: 100 |\n| `offset` | int | смещение для пагинации. По-умолчанию: 0 |\n\n**Что возвращается**\n\nМассив сообщений и событий диалога в хронологическом порядке.\n\n| Поле | Описание |\n| --- | --- |\n| `id` | id сообщения |\n| `dialog_id` | id диалога |\n| `direction` | направление: in (входящее) или out (исходящее) |\n| `author_user_id` | id автора (для исходящих) |\n| `from_email` | email отправителя |\n| `from_name` | имя отправителя |\n| `subject` | тема письма |\n| `body_text_clean` | текстовое тело (без цитат) |\n| `body_html_clean` | HTML-тело (без цитат) |\n| `is_read` | прочитано или нет (0/1) |\n| `created_at` | дата и время сообщения |\n| `attachments` | массив вложений (id, filename, content_type, size_bytes) |\n| `kind` | тип записи: message или event (closed/opened) |\n\n[Метод в документации](https://dashamail.ru/api/v1/dialogs/#dialogs.messages)", "body": { "mode": "raw", "raw": "{\n \"dialog_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "dialogs.reply", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=dialogs.reply", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "dialogs.reply", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Отправляем ответ в диалог\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `dialog_id` | int, обязательный | id диалога |\n| `body_html` | string, обязательный | HTML-тело ответа |\n| `body_text` | string, обязательный | текстовое тело ответа |\n| `quote_original` | int | цитировать исходное сообщение: 1 или 0. По-умолчанию: 1 |\n\n**Что возвращается**\n\nДанные отправленного сообщения.\n\n| Поле | Описание |\n| --- | --- |\n| `message_id` | id созданного сообщения |\n| `dialog_id` | id диалога |\n\n[Метод в документации](https://dashamail.ru/api/v1/dialogs/#dialogs.reply)", "body": { "mode": "raw", "raw": "{\n \"dialog_id\": 1,\n \"body_html\": \"значение\",\n \"body_text\": \"значение\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "dialogs.markRead", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=dialogs.markRead", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "dialogs.markRead", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Помечаем диалог прочитанным\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `dialog_id` | int, обязательный | id диалога |\n| `message_id` | int | id конкретного сообщения (если не указано - помечает все) |\n\n**Что возвращается**\n\nРезультат операции.\n\n| Поле | Описание |\n| --- | --- |\n| `success` | true при успехе |\n\n[Метод в документации](https://dashamail.ru/api/v1/dialogs/#dialogs.markRead)", "body": { "mode": "raw", "raw": "{\n \"dialog_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "dialogs.markUnread", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=dialogs.markUnread", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "dialogs.markUnread", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Помечаем диалог непрочитанным\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `dialog_id` | int, обязательный | id диалога |\n\n**Что возвращается**\n\nРезультат операции.\n\n| Поле | Описание |\n| --- | --- |\n| `success` | true при успехе |\n\n[Метод в документации](https://dashamail.ru/api/v1/dialogs/#dialogs.markUnread)", "body": { "mode": "raw", "raw": "{\n \"dialog_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "dialogs.close", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=dialogs.close", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "dialogs.close", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Закрываем диалог\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `dialog_id` | int, обязательный | id диалога |\n\n**Что возвращается**\n\nРезультат операции.\n\n| Поле | Описание |\n| --- | --- |\n| `success` | true при успехе |\n\n[Метод в документации](https://dashamail.ru/api/v1/dialogs/#dialogs.close)", "body": { "mode": "raw", "raw": "{\n \"dialog_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "dialogs.open", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=dialogs.open", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "dialogs.open", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Открываем диалог\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `dialog_id` | int, обязательный | id диалога |\n\n**Что возвращается**\n\nРезультат операции.\n\n| Поле | Описание |\n| --- | --- |\n| `success` | true при успехе |\n\n[Метод в документации](https://dashamail.ru/api/v1/dialogs/#dialogs.open)", "body": { "mode": "raw", "raw": "{\n \"dialog_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "dialogs.unreadCount", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=dialogs.unreadCount", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "dialogs.unreadCount", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Получаем количество непрочитанных диалогов\n\n**Что возвращается**\n\nКоличество непрочитанных диалогов.\n\n| Поле | Описание |\n| --- | --- |\n| `total` | общее количество непрочитанных диалогов |\n| `by_status` | количество по статусам: {open, closed} |\n\n[Метод в документации](https://dashamail.ru/api/v1/dialogs/#dialogs.unreadCount)", "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "dialogs.attachment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=dialogs.attachment", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "dialogs.attachment", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Получаем ссылку для скачивания вложения\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `attachment_id` | int, обязательный | id вложения |\n\n**Что возвращается**\n\nДанные для скачивания вложения.\n\n| Поле | Описание |\n| --- | --- |\n| `url` | pre-signed URL для скачивания (действует 15 минут) |\n| `filename` | имя файла |\n| `content_type` | MIME-тип |\n| `size_bytes` | размер в байтах |\n\n[Метод в документации](https://dashamail.ru/api/v1/dialogs/#dialogs.attachment)", "body": { "mode": "raw", "raw": "{\n \"attachment_id\": 5\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Входящие: Управление доменами", "description": "Системный поддомен выдан автоматически, кастомные — добавляются с MX-проверкой", "item": [ { "name": "router.domainsList", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=router.domainsList", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "router.domainsList", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Список всех доменов аккаунта: системный (default) и кастомные. Default-домен выдан автоматически и всегда verified.\n\n**Что возвращается**\n\nМассив доменов аккаунта.\n\n| Поле | Описание |\n| --- | --- |\n| `id` | идентификатор домена |\n| `domain` | полный поддомен |\n| `kind` | тип: default (системный) или custom (клиентский) |\n| `verify_status` | pending / verified / failed |\n| `verified_at` | дата и время последней успешной проверки |\n| `created_at` | дата создания |\n\n[Метод в документации](https://dashamail.ru/router/#router.domainsList)" }, "response": [] }, { "name": "router.domainsCreate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=router.domainsCreate", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "router.domainsCreate", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Добавить кастомный поддомен. После создания verify_status=pending — нужно настроить MX-запись на mta.dashasender.ru и вызвать domainsVerify.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `domain` | string, обязательный | клиентский поддомен (только ASCII, минимум один уровень, без trailing dot). Например, inbound.your-domain.com |\n\n**Что возвращается**\n\nОбъект созданного домена со структурой как в domainsList.\n\n[Метод в документации](https://dashamail.ru/router/#router.domainsCreate)", "body": { "mode": "raw", "raw": "{\n \"domain\": \"значение\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "router.domainsVerify", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=router.domainsVerify", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "router.domainsVerify", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "DNS-проверка MX-записи кастомного домена. При успехе verify_status переходит в verified и домен автоматически регистрируется в Даше.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `domain_id` | int, обязательный | id домена из domainsList |\n\n**Что возвращается**\n\nОбъект домена с обновлённым verify_status.\n\n[Метод в документации](https://dashamail.ru/router/#router.domainsVerify)", "body": { "mode": "raw", "raw": "{\n \"domain_id\": 42\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "router.domainsDelete", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=router.domainsDelete", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "router.domainsDelete", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Удалить кастомный поддомен. Default-домен удалить нельзя. Маршруты, привязанные к домену, не удаляются — но письма на этот домен перестают приниматься.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `domain_id` | int, обязательный | id домена |\n\n**Что возвращается**\n\n| Поле | Описание |\n| --- | --- |\n| `deleted` | true при успехе |\n| `id` | id удалённого домена |\n\n[Метод в документации](https://dashamail.ru/router/#router.domainsDelete)", "body": { "mode": "raw", "raw": "{\n \"domain_id\": 42\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "router.mxInstructions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=router.mxInstructions", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "router.mxInstructions", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Параметры MX-записи для настройки DNS своего поддомена. Используется UI и сторонними клиентами для генерации инструкции.\n\n**Что возвращается**\n\n| Поле | Описание |\n| --- | --- |\n| `mx_target` | hostname MTA — куда настроить MX-запись |\n| `priority` | рекомендуемый приоритет MX (10) |\n| `example` | объект с примером DNS-записи: host, type=MX, priority, value, ttl |\n| `note` | подсказка для клиента про пропагацию DNS |\n\n[Метод в документации](https://dashamail.ru/router/#router.mxInstructions)" }, "response": [] } ] }, { "name": "Входящие: Маршруты", "description": "CRUD маршрутов с фильтрами и действиями. Mailgun-совместимая семантика", "item": [ { "name": "router.routesList", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=router.routesList", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "router.routesList", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Все маршруты аккаунта, отсортированные по приоритету (по возрастанию).\n\n**Что возвращается**\n\n| Поле | Описание |\n| --- | --- |\n| `id` | id маршрута |\n| `priority` | приоритет (целое; меньше = выше в очереди) |\n| `description` | пользовательское описание |\n| `filter` | canonical JSON фильтра ({combinator, conditions[]}) |\n| `expression` | Mailgun-совместимая строка фильтра |\n| `actions` | массив действий (webhook/store/forward/stop) |\n| `signing_key` | HMAC-секрет (64 hex) для верификации подписи webhook |\n| `is_active` | true/false |\n| `match_count` | счётчик матчей маршрута |\n| `last_matched_at` | время последнего матча |\n| `created_at` | дата создания |\n| `updated_at` | дата последнего обновления |\n\n[Метод в документации](https://dashamail.ru/router/#router.routesList)" }, "response": [] }, { "name": "router.routesGet", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=router.routesGet&route_id=7", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "router.routesGet", "description": "(обязательный) Имя вызываемого метода." }, { "key": "route_id", "value": "7", "description": "(обязательный, int) id маршрута" } ] }, "description": "Получить один маршрут по id (включая signing_key).\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `route_id` | int, обязательный | id маршрута |\n\n**Что возвращается**\n\nОбъект маршрута со структурой как в routesList.\n\n[Метод в документации](https://dashamail.ru/router/#router.routesGet)" }, "response": [] }, { "name": "router.routesCreate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=router.routesCreate", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "router.routesCreate", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Создать маршрут. Возвращает объект созданного маршрута с автоматически сгенерированным signing_key.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `description` | string | описание маршрута, до 255 символов |\n| `expression` | string | Mailgun-совместимый фильтр одной строкой. Поддерживаемые функции: match_recipient(value), match_header(name,value), catch_all(). Объединение через and/or (один тип на выражение). Альтернатива — параметр filter |\n| `filter` | json | фильтр в canonical-JSON формате: {\"combinator\":\"and\\|or\",\"conditions\":[{field,op,value,name?}]}. Поля: recipient/from/sender/header. Ops: matches (PCRE)/equals/contains. Пустой conditions — catch_all |\n| `actions` | json, обязательный | массив действий, максимум 5. Типы: webhook (url + опц. attachments: off/url/inline), store (опц. ttl_days 1-30 и notify_url), forward (email — пересылка письма, только на платных тарифах, списывает 1 транзакционное письмо с баланса), stop |\n| `is_active` | bool | 1 = маршрут активен (по умолчанию), 0 = выключен |\n| `priority` | int | целое; маршруты обрабатываются по возрастанию. По умолчанию — следующее число после max существующего |\n\n**Что возвращается**\n\nОбъект созданного маршрута.\n\n[Метод в документации](https://dashamail.ru/router/#router.routesCreate)", "body": { "mode": "raw", "raw": "{\n \"actions\": \"[]\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "router.routesUpdate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=router.routesUpdate", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "router.routesUpdate", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Partial-update маршрута. Обновляются только переданные поля.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `route_id` | int, обязательный | id маршрута |\n| `description` | string | новое описание |\n| `expression` | string | новый фильтр (Mailgun-строка) |\n| `filter` | json | новый фильтр (canonical JSON) |\n| `actions` | json | новый массив действий |\n| `is_active` | bool | новое состояние |\n| `priority` | int | новый приоритет |\n\n**Что возвращается**\n\nОбъект обновлённого маршрута.\n\n[Метод в документации](https://dashamail.ru/router/#router.routesUpdate)", "body": { "mode": "raw", "raw": "{\n \"route_id\": 7\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "router.routesDelete", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=router.routesDelete", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "router.routesDelete", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Удалить маршрут. Логи доставки (InboundDeliveries) с этого маршрута остаются для аудита.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `route_id` | int, обязательный | id маршрута |\n\n**Что возвращается**\n\n| Поле | Описание |\n| --- | --- |\n| `deleted` | true |\n| `id` | id удалённого маршрута |\n\n[Метод в документации](https://dashamail.ru/router/#router.routesDelete)", "body": { "mode": "raw", "raw": "{\n \"route_id\": 7\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "router.routesRegenerateKey", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=router.routesRegenerateKey", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "router.routesRegenerateKey", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Сгенерировать новый signing_key (при компроментации). In-flight доставки, опубликованные ранее, остаются со снапшотом старого ключа — клиентский endpoint должен их пропустить через старый секрет.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `route_id` | int, обязательный | id маршрута |\n\n**Что возвращается**\n\nОбъект маршрута с обновлённым signing_key.\n\n[Метод в документации](https://dashamail.ru/router/#router.routesRegenerateKey)", "body": { "mode": "raw", "raw": "{\n \"route_id\": 7\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "router.routesReorder", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=router.routesReorder", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "router.routesReorder", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Bulk-обновление приоритетов нескольких маршрутов (для drag-and-drop в UI). Маршрут на позиции i получает priority = i.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `order` | json, обязательный | JSON-массив id маршрутов в желаемом порядке. Например, [3,1,2] |\n\n**Что возвращается**\n\n| Поле | Описание |\n| --- | --- |\n| `updated` | число обновлённых маршрутов |\n\n[Метод в документации](https://dashamail.ru/router/#router.routesReorder)", "body": { "mode": "raw", "raw": "{\n \"order\": \"[]\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Входящие: Хранилище сообщений", "description": "Retrieve писем, сохранённых action store. TTL по умолчанию 3 дня", "item": [ { "name": "router.messagesList", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=router.messagesList", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "router.messagesList", "description": "(обязательный) Имя вызываемого метода." }, { "key": "route_id", "value": "7", "description": "(int) фильтр по маршруту", "disabled": true }, { "key": "recipient", "value": "значение", "description": "LIKE-поиск по получателю", "disabled": true }, { "key": "since", "value": "2026-08-01 00:00:00", "description": "(datetime) от даты, формат YYYY-MM-DD HH:MM:SS", "disabled": true }, { "key": "until", "value": "2026-08-01 00:00:00", "description": "(datetime) до даты", "disabled": true }, { "key": "limit", "value": "1", "description": "(int) размер страницы (1-200, по умолчанию 50)", "disabled": true }, { "key": "offset", "value": "1", "description": "(int) смещение для пагинации (по умолчанию 0)", "disabled": true } ] }, "description": "Список сохранённых писем (от маршрутов с action store). Возвращает {items, total, limit, offset} для пагинации. Элементы — лёгкая мета (без body, без attachment-bytes); полная карточка — через messagesGet.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `route_id` | int | фильтр по маршруту |\n| `recipient` | string | LIKE-поиск по получателю |\n| `since` | datetime | от даты, формат YYYY-MM-DD HH:MM:SS |\n| `until` | datetime | до даты |\n| `limit` | int | размер страницы (1-200, по умолчанию 50) |\n| `offset` | int | смещение для пагинации (по умолчанию 0) |\n\n**Что возвращается**\n\n| Поле | Описание |\n| --- | --- |\n| `items` | массив сообщений `id` — id сообщения; `route_id` — id маршрута, который сохранил; `recipient` — SMTP RCPT TO; `from` — email отправителя; `subject` — тема, декодированная из MIME; `message_id` — заголовок Message-Id; `attachments_count` — число вложений; `raw_size` — размер сырого EML в байтах; `expires_at` — время автоматического удаления; `retrieved_at` — время первого retrieve через API (или null); `created_at` — время приёма письма |\n| `total` | общее количество с учётом фильтров |\n| `limit` | применённый лимит |\n| `offset` | применённое смещение |\n\n[Метод в документации](https://dashamail.ru/router/#router.messagesList)" }, "response": [] }, { "name": "router.messagesGet", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=router.messagesGet&message_id=9001", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "router.messagesGet", "description": "(обязательный) Имя вызываемого метода." }, { "key": "message_id", "value": "9001", "description": "(обязательный, int) id сообщения" } ] }, "description": "Полная карточка сообщения. Включает свежие presigned-ссылки (TTL 1 час) на raw EML и каждое вложение — регенерируются на каждый вызов, не храним. На первом обращении помечает retrieved_at.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `message_id` | int, обязательный | id сообщения |\n\n**Что возвращается**\n\n| Поле | Описание |\n| --- | --- |\n| `id` | id |\n| `route_id` | id маршрута |\n| `recipient` | получатель |\n| `from` | отправитель |\n| `subject` | тема |\n| `message_id` | Message-Id |\n| `body_text` | plain-текст письма |\n| `body_html` | HTML-версия (или null) |\n| `parsed` | parsed_json — снимок payload, как был бы отдан webhook |\n| `raw_eml_url` | presigned URL для скачивания сырого EML (TTL 1ч) |\n| `raw_size` | размер EML в байтах |\n| `attachments` | массив вложений `id` — id вложения; `filename` — имя файла; `content_type` — MIME-тип; `size` — размер в байтах; `content_id` — Content-ID для inline-картинок (или null); `url` — presigned URL для скачивания (TTL 1ч) |\n| `expires_at` | время TTL-удаления |\n| `retrieved_at` | время первого retrieve |\n| `created_at` | время приёма |\n\n[Метод в документации](https://dashamail.ru/router/#router.messagesGet)" }, "response": [] }, { "name": "router.messagesDelete", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=router.messagesDelete", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "router.messagesDelete", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Удалить сохранённое сообщение раньше TTL. Снимает raw EML и вложения из S3, удаляет строки БД.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `message_id` | int, обязательный | id сообщения |\n\n**Что возвращается**\n\n| Поле | Описание |\n| --- | --- |\n| `deleted` | true |\n| `id` | id удалённого сообщения |\n\n[Метод в документации](https://dashamail.ru/router/#router.messagesDelete)", "body": { "mode": "raw", "raw": "{\n \"message_id\": 9001\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "router.messagesAttachment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=router.messagesAttachment", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "router.messagesAttachment", "description": "(обязательный) Имя вызываемого метода." } ] }, "description": "Прямой presigned URL конкретного вложения. Удобен когда не нужна полная карточка письма — например, для скачивания файла по ссылке.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `message_id` | int, обязательный | id сообщения |\n| `attachment_id` | int, обязательный | id вложения (из массива attachments в messagesGet) |\n\n**Что возвращается**\n\n| Поле | Описание |\n| --- | --- |\n| `filename` | имя файла |\n| `content_type` | MIME-тип |\n| `size` | размер в байтах |\n| `url` | presigned URL (TTL 1ч) |\n\n[Метод в документации](https://dashamail.ru/router/#router.messagesAttachment)", "body": { "mode": "raw", "raw": "{\n \"message_id\": 9001,\n \"attachment_id\": 5\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Входящие: Логи доставки", "description": "Лог попыток доставки webhook'ов — статусы, ретраи, response_excerpt", "item": [ { "name": "router.deliveriesList", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=router.deliveriesList", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "router.deliveriesList", "description": "(обязательный) Имя вызываемого метода." }, { "key": "route_id", "value": "7", "description": "(int) фильтр по маршруту", "disabled": true }, { "key": "status", "value": "значение", "description": "фильтр: pending / delivered / failed / retrying", "disabled": true }, { "key": "recipient", "value": "значение", "description": "LIKE-поиск по получателю", "disabled": true }, { "key": "since", "value": "2026-08-01 00:00:00", "description": "(datetime) от даты", "disabled": true }, { "key": "until", "value": "2026-08-01 00:00:00", "description": "(datetime) до даты", "disabled": true }, { "key": "limit", "value": "1", "description": "(int) 1-200, default 50", "disabled": true }, { "key": "offset", "value": "1", "description": "(int) пагинация", "disabled": true } ] }, "description": "История попыток доставки webhook'ов. Без чувствительных полей (signing_key, payload_json) — только метаданные для отладки. Возвращает {items, total, limit, offset}.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `route_id` | int | фильтр по маршруту |\n| `status` | string | фильтр: pending / delivered / failed / retrying |\n| `recipient` | string | LIKE-поиск по получателю |\n| `since` | datetime | от даты |\n| `until` | datetime | до даты |\n| `limit` | int | 1-200, default 50 |\n| `offset` | int | пагинация |\n\n**Что возвращается**\n\n| Поле | Описание |\n| --- | --- |\n| `items` | массив попыток доставки `id` — id попытки; `route_id` — id маршрута, который триггерил доставку; `target_url` — URL клиентского endpoint; `recipient` — получатель письма; `message_id` — Message-Id входящего письма; `attempt` — номер текущей попытки (1-based); `http_status` — HTTP-код ответа (или null если transport-error); `response_excerpt` — первые ~1KB ответа клиента; `status` — pending / delivered / failed / retrying; `next_retry_at` — время следующей попытки (или null); `created_at` — время первой попытки; `updated_at` — время последней попытки |\n| `total` | общее количество с учётом фильтров |\n| `limit` | применённый лимит |\n| `offset` | применённое смещение |\n\n[Метод в документации](https://dashamail.ru/router/#router.deliveriesList)" }, "response": [] }, { "name": "router.deliveriesGet", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/?method=router.deliveriesGet&delivery_id=5512", "host": [ "{{base_url}}" ], "path": [], "query": [ { "key": "method", "value": "router.deliveriesGet", "description": "(обязательный) Имя вызываемого метода." }, { "key": "delivery_id", "value": "5512", "description": "(обязательный, int) id попытки доставки" } ] }, "description": "Детали одной попытки доставки. Используется для отладки 5xx-ответов клиентского endpoint.\n\n**Параметры**\n\n| Параметр | Тип | Описание |\n| --- | --- | --- |\n| `delivery_id` | int, обязательный | id попытки доставки |\n\n**Что возвращается**\n\nОбъект попытки со структурой как в deliveriesList.items.\n\n[Метод в документации](https://dashamail.ru/router/#router.deliveriesGet)" }, "response": [] } ] } ] }