{"info":{"_postman_id":"a411460e-16ae-4bc9-97ef-60a77ac22b4f","name":"DashaMail. API documentation.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"21816851","collectionId":"a411460e-16ae-4bc9-97ef-60a77ac22b4f","publishedId":"UzQxMPZq","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-07-18T21:34:52.000Z"},"item":[{"name":"Краткое руководство","item":[{"name":"Использование Postman","item":[],"id":"d74cabd4-262a-4aed-9e7c-7ab297fc2882","description":"

Вы можете протестировать весь текущий функционал, описанный в документации. Для быстрого тестирования нажмите на кнопку \"Run in Postman\" в правом верхнем углу страницы. После чего Вам будет предложено войти в Вашу учетную запись Postman и импортировать в нее текущую версию документации*. После успешного импорта вы сможете отправлять запросы к API из своей учетной записи.

*Документация в Postman называется коллекцией (Collection)

\n","_postman_id":"d74cabd4-262a-4aed-9e7c-7ab297fc2882"},{"name":"Отправка писем через API","item":[{"name":"Домен отправки","item":[],"id":"1840a964-9a57-4f02-a9f5-1569b8cd2118","description":"

Для получения доступа к методам транзакционного API необходимо настроить собственный домен отправки (DKIM&SPF). Настройка проводится в разделе \"Аккаунт\" => \"Мои домены\".

Что дает настройка своего домена отправки?

Улучшается доставляемость писем
Улучшается проходимость спам-фильтров
В качестве обратного адреса будет указан только адрес на Вашем собственном домене
Создается положительная репутация Вашего домена

\n","_postman_id":"1840a964-9a57-4f02-a9f5-1569b8cd2118"},{"name":"Отправка запроса","item":[],"id":"6756c055-73c3-4ff3-981f-78bf8edb66c9","description":"

Для отправки запроса Вам потребуется персональный ключ - api_key. Его можно найти в разделе \"Аккаунт\" => \"Интеграции\". Api_key будет использоваться в качестве одного из обязательных параметров при составлении запроса к API.

Возможно использование протоколов HTTP или HTTPS. Кодировка: UTF-8.

\n","_postman_id":"6756c055-73c3-4ff3-981f-78bf8edb66c9"},{"name":"Составление запросa к API","item":[{"name":"transactional.send","id":"4ae15255-7aab-45cd-829c-3405f3e602db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.dashamail.com/?method=transactional.send&api_key=YOUR_API_KEY&to=YOUR_RECIPIENT_EMAIL@DOMAIN.COM&from_email=SENDER@DOMAIN.COM&subject=YOUR_SUBJECT&message=YOUR_MESSAGE","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Используемый метод

\n","type":"text/plain"},"key":"method","value":"transactional.send"},{"description":{"content":"

Ваш API-ключ. Его можно найти в разделе \"Аккаунт\" => \"Интеграции\"

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

Email адресата

\n","type":"text/plain"},"key":"to","value":"YOUR_RECIPIENT_EMAIL@DOMAIN.COM"},{"description":{"content":"

Email отправителя

\n","type":"text/plain"},"key":"from_email","value":"SENDER@DOMAIN.COM"},{"description":{"content":"

Тема письма

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

html-код сообщения или id рассылки или шаблона, откуда его взять

\n","type":"text/plain"},"key":"message","value":"YOUR_MESSAGE"}],"variable":[]}},"response":[{"id":"f85efc0d-9d5e-4908-8853-0dac49457021","name":"transactional.send example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com/?method=transactional.send&api_key=YOUR_API_KEY&to=YOUR_RECIPIENT_EMAIL@DOMAIN.COM&from_email=SENDER@DOMAIN.COM&subject=YOUR_SUBJECT&message=YOUR_MESSAGE","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"method","value":"transactional.send","description":"Используемый метод"},{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ. Его можно найти в разделе \"Аккаунт\" => \"Интеграции\""},{"key":"to","value":"YOUR_RECIPIENT_EMAIL@DOMAIN.COM","description":"Email адресата"},{"key":"from_email","value":"SENDER@DOMAIN.COM","description":"Email отправителя"},{"key":"subject","value":"YOUR_SUBJECT","description":"Тема письма"},{"key":"message","value":"YOUR_MESSAGE","description":"html-код сообщения или id рассылки или шаблона, откуда его взять","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Thu, 01 Sep 2022 09:20:41 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": {\n \"transaction_id\": MESSAGE_ID_(NUMBER)\n }\n }\n}"}],"_postman_id":"4ae15255-7aab-45cd-829c-3405f3e602db"}],"id":"52c7e71c-8a39-415d-9f25-9065885755c9","description":"

Авторизация производится с помощью параметра api_key.

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

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

Название	Тип данных	Описание
api_key	text	ключ для авторизации (можно найти в разделе «Аккаунт\" => Интеграции»)
method	text	вызываемый метод API (например transactional.send)
to	email	email-адрес получателя. В случае задания нескольких получателей разделяются через запятую. Возможен формат с именем, например, Даша Савицкая <dasha@dashamail.ru>
from_email	email	email-адрес отправителя. Важно! Обратный адрес, используемый в поле From («От кого»), должен быть подтвержден в разделе «Доставляемость» => «Подтвержденные отправители»)
subject	text	заголовок «Тема письма». В случае, если в message передается ID рассылки, то параметр необязателен и подставляется из темы письма указанной рассылки. В параметре также допустимы теги динамического контента
message	html; number	html-код сообщения или id рассылки или шаблона, откуда его взять

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

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

Название	Тип данных	Описание
plain_text	text	plain_text версия вашего письма. Если параметр не задан или пуст, будет сгенерирована автоматически из html
from_name	text	имя отправителя для заголовка «От кого»
cc	email; text+email	email-адреса в поле «Копия». В случае задания нескольких получателей разделяются через запятую. Возможен формат с именем, например, Владимир Владимирович
bcc	email; text+email	email-адреса в поле «Скрытая копия». В случае задания нескольких получателей разделяются через запятую. Возможен формат с именем, например, Феликс Эдмундович
message_id	number	id сообщения, по которому вы потом сможете идентифицировать вебхук
delivery_time	number	timestamp времени, когда письмо должно быть доставлено
replace	array; JSON	сериализованный массив замен в шаблоне. Также может быть в формате JSON. В случае использования нескольких email-адресов в параметре to можно использовать ассоциативный массив с замен с email-адресами в качестве ключей
domain	text	домен отправки, который будет использоваться для DKIM/SPF подписей. По-умолчанию используется первый в списке в разделе «Аккаунт» => «Мои домены»
campaign_id	number	пользовательский id кампании для группировки статистики по транзакционным письмам
no_track_opens	-	передается для отключения трекинга открытий
no_track_clicks	-	передается для отключения трекинга (подмены) ссылок
headers	JSON	JSON-объект, содержащий произвольные заголовки письма. Например, {\"Reply-To\":\"Test Reply \", \"CustomHeader\": \"any value\"}
template_data	JSON	JSON-объект, содержащий данные для условных операторов {{}}. Например, {\"name\":\"Иван\", \"phone\": \"79999999999\"}. Подробнее о динамическом контенте и условных операторах
attachments	JSON	JSON-массив, содержащий прикладываемые файлы в base64-кодировке. Наример, [{\"name\": \"image1.png\", \"filebody\": \"base64encoded_content_1\"},{\"name\": \"image2.png\", \"filebody\": \"base64encoded_content_2\"}]
inline	JSON	JSON-массив, содержащий прикладываемые к письму изображения. Изображения размещаются внутри письма с помощью Content-ID идентификаторов, например, src=\"cid:\". Объекты изображений в JSON-массиве передаются со следующими параметрами: mime_type – MIME тип изображения, поддерживаются: image/jpeg, image/png и image/gif; filename – файловое имя изображения, например, victory.png; body – base64-encoded содержимое файла картинки; cid – идентификатор Content-ID который добавлен в тело письма для подстановки

Параметры запроса могут передаваться как в виде get- или post-параметров, так и в формате JSON в теле POST-запроса.

Возвращаемые данные

Ответ может быть в одном из нескольких форматов. Для его задания используйте переменную format:

JSON (default)
JSONP
XML

Даша возвращает данные структурированные следующим образом:

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

Наименование	Тип данных	Описание
msg	text; number	сообщение о выполнении действия в виде массива с ключами: - числовой код ошибки (0 - нет ошибок); - текстовое сообщение; - тип сообщения (message – нет ошибок, notice и error – ошибки) сообщение о выполнении действия (в случае успеха принимает значение ОК)
data	number	transaction_id - уникальный id сообщения, по которому потом можно проверить статус

Пример запроса:

\n","_postman_id":"52c7e71c-8a39-415d-9f25-9065885755c9"}],"id":"5952ce88-1fdd-4f87-8ae6-5c6e4d7aede8","_postman_id":"5952ce88-1fdd-4f87-8ae6-5c6e4d7aede8","description":""},{"name":"Получение отчетов (вебхуки)","item":[],"id":"1317ef9a-2806-48c3-8274-e52c0b90413c","description":"

Отчеты о различных событиях, которые происходят с отправляемыми письмами, реализованы в виде вебхуков (webhooks). В разделе \"Интеграции\"=>\"Транзакционные письма\" вы можете задать адреса скриптов, которые будут вызываться при наступлении определенных событий (возврат, жалоба на спам или невозможность доставки).

\n","_postman_id":"1317ef9a-2806-48c3-8274-e52c0b90413c"}],"id":"162c8127-db91-4950-8b6e-dfaccf606c73","description":"

Как быстро составить запросы и начать использовать транзакционное API для отправки писем.

\n","_postman_id":"162c8127-db91-4950-8b6e-dfaccf606c73"},{"name":"Транзакционное API","item":[{"name":"Домен отправки","item":[],"id":"0f083e6e-9aaa-4e2f-b917-3e6d2932d86a","description":"

Описание процесса настройки собственного домена для отправки писем.

Методы транзакционного API доступны всем клиентам сервиса на платных тарифных планах, которые настроили собственный домен отправки (DKIM&SPF) в разделе \"Аккаунт\"=>\"Мои домены\".

\n","_postman_id":"0f083e6e-9aaa-4e2f-b917-3e6d2932d86a"},{"name":"Отправка писем через API","item":[{"name":"Составление запросов к API","item":[{"name":"transactional.send","id":"e4cb5f00-775d-4432-a37a-4a0d78f94fdd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"YOUR_RECIPIENT_EMAIL@DOMAIN.COM\",\n \"subject\": \"YOUR_SUBJECT\",\n \"from_email\": \"SENDER@DOMAIN.COM\",\n \"message\": \"<\\/head><\\/body><\\/html>\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dashamail.com/?method=transactional.send&api_key=YOUR_API_KEY&format=FORMAT_RESPONSE","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Используемый метод

\n","type":"text/plain"},"key":"method","value":"transactional.send"},{"description":{"content":"

Ваш API-ключ. Его можно найти в разделе \"Аккаунт\" => \"Интеграции\"

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

формат ответа на запрос. может быть JSON (default), JSONP, XML

\n","type":"text/plain"},"key":"format","value":"FORMAT_RESPONSE"}],"variable":[]}},"response":[{"id":"25ef1c87-0e1c-4ac9-8c74-c2d205f54813","name":"transactional.send example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"raw","raw":"{\n \"to\": \"YOUR_RECIPIENT_EMAIL@DOMAIN.COM\",\n \"subject\": \"YOUR_SUBJECT\",\n \"from_email\": \"SENDER@DOMAIN.COM\",\n \"message\": \"<\\/head><\\/body><\\/html>\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.dashamail.com/?method=transactional.send&api_key=YOUR_API_KEY&format=FORMAT_RESPONSE&headers=X-Dashamail-Variables","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"method","value":"transactional.send","description":"Используемый метод"},{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ. Его можно найти в разделе \"Аккаунт\" => \"Интеграции\""},{"key":"format","value":"FORMAT_RESPONSE","description":"формат ответа на запрос. может быть JSON (default), JSONP, XML)"},{"key":"headers","value":"X-Dashamail-Variables","description":"Опционально. Если передать в данном параметре \"X-Dashamail-Variables\",то в связанных с отправкой вебхуках будет возвращаться его значение в параметре custom_vars","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Thu, 01 Sep 2022 09:20:41 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": {\n \"transaction_id\": MESSAGE_ID_(STRING)\n }\n }\n}"}],"_postman_id":"e4cb5f00-775d-4432-a37a-4a0d78f94fdd"}],"id":"8abfae5e-97f7-43ae-810b-55659242982c","description":"

Авторизация производится с помощью параметра api_key.

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

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

Название	Тип данных	Описание
api_key	text	ключ для авторизации (можно найти в разделе «Аккаунт\" => Интеграции»)
method	text	вызываемый метод API (в данном случае это transactional.send)
to	email	email-адрес получателя. В случае задания нескольких получателей, адреса разделяются через запятую. Возможен формат с именем, например, Даша Савицкая <dasha@dashamail.ru> Важно! Если отправка разрешена не на все адреса, то получатели в поле to должны быть добавлены в \"разрешенные\" Добавить адреса в разрешенные можно в разделе \"Аккаунт\" => \"Безопасность\" => \"Разрешенные email-адреса\" Если отправка разрешена на любые адреса, то поле \" Разрешенные email-адреса\" нужно оставить пустым
from_email	email	email-адрес отправителя. Важно! Обратный адрес, используемый в поле From («От кого»), должен быть подтвержден в разделе «Доставляемость» => «Подтвержденные отправители»)
subject	text	заголовок «Тема письма». В случае, если в message передается ID рассылки, то параметр необязателен и подставляется из темы письма указанной рассылки. В параметре также допустимы теги динамического контента
message	html; number	html-код сообщения или id рассылки или шаблона, откуда его взять. В случае, если задан параметр plain_text, то параметр message необязателен

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

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

Название	Тип данных	Описание
plain_text	text	plain_text версия вашего письма. Если параметр не задан или пуст, будет сгенерирована автоматически из html
multi_to	email	если задан данный параметр, то при задании нескольких адресов в поле «Кому» (to) через запятую они будут отображаться в соответствующем заголовке письма. По-умолчанию – не отображаются.
from_name	text	имя отправителя для заголовка «От кого»
cc	email; text+email	email-адреса в поле «Копия». В случае задания нескольких получателей разделяются через запятую. Возможен формат с именем, например, Владимир Владимирович
bcc	email; text+email	email-адреса в поле «Скрытая копия». В случае задания нескольких получателей разделяются через запятую. Возможен формат с именем, например, Феликс Эдмундович
message_id	string	id сообщения, по которому вы потом сможете идентифицировать вебхук
delivery_time	number	timestamp времени, когда письмо должно быть доставлено
replace	array; JSON	сериализованный массив замен в шаблоне. В случае использования нескольких email-адресов в параметре to можно использовать ассоциативный массив с замен с email-адресами в качестве ключей. Также может быть в формате JSON, например: replace={\"%ТЭГ_ПОДСТАНОВКИ%\":\"ЗНАЧЕНИЕ}
domain	text	домен отправки, который будет использоваться для DKIM/SPF подписей. По-умолчанию используется первый в списке в разделе «Аккаунт» => «Мои домены»
campaign_id	string	пользовательский id кампании для группировки статистики по транзакционным письмам
no_track_opens	-	передается для отключения трекинга открытий
no_track_clicks	-	передается для отключения трекинга (подмены) ссылок
headers	JSON	JSON-объект, содержащий произвольные заголовки письма. Например, {\"Reply-To\":\"Test Reply \", \"CustomHeader\": \"any value\"} Если задан заголовок \"X-Dashamail-Variables\" с произвольными параметрами, их значения будут прилетать обратно в связанном с запросом вебхуке событий в custom_vars
template_data	JSON	JSON-объект, содержащий данные для условных операторов {{}}. Например, {\"name\":\"Иван\", \"phone\": \"79999999999\"}. Подробнее о динамическом контенте и условных операторах
attachments	JSON	JSON-массив, содержащий прикладываемые файлы в base64-кодировке. Наример, [{\"name\": \"image1.png\", \"filebody\": \"base64encoded_content_1\"},{\"name\": \"image2.png\", \"filebody\": \"base64encoded_content_2\"}]
ip	string	задается определенный ip для отправки письма в случае использования выделенных ip-адресов. Если адрес подключен на вашем аккаунте, то он используется.
inline	JSON	JSON-массив, содержащий прикладываемые к письму изображения. Изображения размещаются внутри письма с помощью Content-ID идентификаторов, например, src=\"cid:\". Объекты изображений в JSON-массиве передаются со следующими параметрами: mime_type – MIME тип изображения, поддерживаются: image/jpeg, image/png и image/gif; filename – файловое имя изображения, например, victory.png; body – base64-encoded содержимое файла картинки; cid – идентификатор Content-ID который добавлен в тело письма для подстановки
format	-	формат ответа на запрос. может быть JSON (default), JSONP, XML
stat_domain	string	позволяет явно задавать домен статистики для замены ссылок отслеживания. Домен будет использоваться если он валиден (т.е. подтвержден через CNAME-запись). По умолчанию используется первый из списка настроенных доменов статистики
ignore_delivery_policy	-	передается для игнорирования единой политики коммуникаций на аккаунте.
headers_unsub	num	задавая значение = 1, автоматически добавляет ссылку отписаться в заголовок List-Unsubscribe, что позволяет обрабатывать отписки из мобильных и десктопных приложений почтовых провайдеров.
detailed_answer	num	если он задан и равен 1, то формат ответа превращается в следующий вид \"email\" => \"message_id (transaction_id)\".

Параметры запроса могут передаваться как в виде post-параметров, так и в формате JSON в теле POST-запроса.

Возвращаемые данные

Ответ может быть в одном из нескольких форматов. Для его задания используйте в параметрах запроса переменную format:

JSON (default)
\n
JSONP
\n
XML
\n

Даша возвращает данные, структурированные следующим образом:

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

Наименование	Тип данных	Описание
msg	text; number	сообщение о выполнении действия в виде массива с ключами: - числовой код ошибки (0 - нет ошибок); - текстовое сообщение; - тип сообщения (message – нет ошибок, notice и error – ошибки) сообщение о выполнении действия (в случае успеха принимает значение ОК)
data	text	transaction_id - уникальный id сообщения, по которому потом можно проверить статус письма

Пример запроса:

\n","_postman_id":"8abfae5e-97f7-43ae-810b-55659242982c"},{"name":"Изменение шаблонов писем","item":[{"name":"transactional.send с изменением шаблонов","id":"fd74d7f0-673d-4465-a9ed-10f7c752746f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": \"YOUR_RECIPIENT_EMAIL@DOMAIN.COM\",\n \"subject\": \"YOUR_SUBJECT\",\n \"from_email\": \"SENDER@DOMAIN.COM\",\n \"message\": \"<\\/head><\\/body><\\/html>\",\n \"replace\": \n {\"%ТЭГ1%\":\"ЗНАЧЕНИЕ1\",\n \"%ТЭГ2%\":\"ЗНАЧЕНИЕ2\",\n \"%ТЭГ3%\":\"ЗНАЧЕНИЕ3\"}\n \n}","options":{"raw":{"language":"json"}}},"url":"https://api.dashamail.com/?method=transactional.send&api_key=YOUR_API_KEY&format=FORMAT_RESPONSE","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Используемый метод

\n","type":"text/plain"},"key":"method","value":"transactional.send"},{"description":{"content":"

Ваш API-ключ. Его можно найти в разделе \"Аккаунт\" => \"Интеграции\"

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

формат ответа на запрос. может быть JSON (default), JSONP, XML

\n","type":"text/plain"},"key":"format","value":"FORMAT_RESPONSE"}],"variable":[]}},"response":[{"id":"2c838267-0c0d-42de-88c4-d85df52be333","name":"transactional.send example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"to\": \"YOUR_RECIPIENT_EMAIL@DOMAIN.COM\",\n \"subject\": \"YOUR_SUBJECT\",\n \"from_email\": \"SENDER@DOMAIN.COM\",\n \"message\": \"<\\/head><\\/body><\\/html>\",\n \"replace\": [\n {\"%ТЭГ1%\":\"ЗНАЧЕНИЕ1\"},\n {\"%ТЭГ2%\":\"ЗНАЧЕНИЕ2\"},\n {\"%ТЭГ3%\":\"ЗНАЧЕНИЕ3\"}\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.dashamail.com/?method=transactional.send&api_key=YOUR_API_KEY&format=FORMAT_RESPONSE","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"method","value":"transactional.send","description":"Используемый метод"},{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ. Его можно найти в разделе \"Аккаунт\" => \"Интеграции\""},{"key":"format","value":"FORMAT_RESPONSE","description":"формат ответа на запрос. может быть JSON (default), JSONP, XML","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Thu, 01 Sep 2022 09:20:41 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": {\n \"transaction_id\": MESSAGE_ID_(NUMBER)\n }\n }\n}"}],"_postman_id":"fd74d7f0-673d-4465-a9ed-10f7c752746f"}],"id":"7c7948ab-aff4-4184-8aab-99664cbe5a4c","description":"

Замена значений в теле шаблона.

Допустима произвольная замена значений в шаблоне с помощью массива, передаваемого в параметре replace.

Ключи массива – искомые значения (needle) для замены.
Значения массива являются значениями замены.

Например, передав массив replace = array('%ИМЯ%'=>'Даша') мы произведем замену всех вхождений строки %ИМЯ% на строку Даша.

Формат параметра в запросе: replace={\"%ТЭГ%\":\"ЗНАЧЕНИЕ\"}

\n","_postman_id":"7c7948ab-aff4-4184-8aab-99664cbe5a4c"},{"name":"Отправка файлов","item":[{"name":"transactional.send + attachments","id":"2ac723f7-cbf5-4689-8b2e-61d7ee4db6cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"attachments[0]","type":"file","src":"hYUDE6uSi/index.log"}]},"url":"https://api.dashamail.com/?method=transactional.send&api_key=YOUR_API_KEY&to=YOUR_RECIPIENT_EMAIL@DOMAIN.COM&from_email=SENDER@DOMAIN.COM&subject=YOUR_SUBJECT&message=YOUR_MESSAGE","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Используемый метод

\n","type":"text/plain"},"key":"method","value":"transactional.send"},{"description":{"content":"

Ваш API-ключ. Его можно найти в разделе \"Аккаунт\" => \"Интеграции\"

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

Email получателя. Должен быть разрешен. Его можно добавить в разрешенные в разделе \"Аккаунт\" => \"Безопасность\" => \"Разрешенные email-адреса\"

\n","type":"text/plain"},"key":"to","value":"YOUR_RECIPIENT_EMAIL@DOMAIN.COM"},{"description":{"content":"

Email отправителя. Должен быть подтвержден. Его можно добавить в подтвержденные в разделе \"Аккаунт\" => \"Доставляемость\" => \"Подтвержденные отправители\"

\n","type":"text/plain"},"key":"from_email","value":"SENDER@DOMAIN.COM"},{"description":{"content":"

Тема письма

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

id рассылки или шаблона, откуда его взять

\n","type":"text/plain"},"key":"message","value":"YOUR_MESSAGE"}],"variable":[]}},"response":[{"id":"b2d00e3b-4f94-4f49-9adc-5a07480b696a","name":"transactional.send + attachments example","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"attachments[0]","type":"file","src":"N_xmzpZ-p/index.log"}]},"url":{"raw":"https://api.dashamail.com/?method=transactional.send&api_key=YOUR_API_KEY&to=YOUR_RECIPIENT_EMAIL@DOMAIN.COM&from_email=SENDER@DOMAIN.COM&subject=YOUR_SUBJECT&message=YOUR_MESSAGE","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"method","value":"transactional.send","description":"Используемый метод"},{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ. Его можно найти в разделе \"Аккаунт\" => \"Интеграции\""},{"key":"to","value":"YOUR_RECIPIENT_EMAIL@DOMAIN.COM","description":"Email получателя. Должен быть разрешен. Его можно добавить в разрешенные в разделе \"Аккаунт\" => \"Безопасность\" => \"Разрешенные email-адреса\""},{"key":"from_email","value":"SENDER@DOMAIN.COM","description":"Email отправителя. Должен быть подтвержден. Его можно добавить в подтвержденные в разделе \"Аккаунт\" => \"Доставляемость\" => \"Подтвержденные отправители\""},{"key":"subject","value":"YOUR_SUBJECT","description":"Тема письма"},{"key":"message","value":"YOUR_MESSAGE","description":"html-код сообщения или id рассылки или шаблона, откуда его взять"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Thu, 01 Sep 2022 09:23:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"transaction_id\": MESSAGE_ID_(NUMBER)\n }\n ]\n }\n}"}],"_postman_id":"2ac723f7-cbf5-4689-8b2e-61d7ee4db6cb"}],"id":"6091fab3-bef6-4362-825e-66712afb649d","description":"

Прикладывание файлов к письмам

К каждому письму вы можете приложить сколько угодно файлов суммарным объемом до 5 Мб. Допускаются любые файлы, кроме *.exe и *.php. Имена файлов могут содержать только латиницу и цифры. Файлы отправляются стандартным образом в теле POST запроса при обращении к API.

Важно! Именем параметра при этом должен быть массив attachments. Например, при отправке запроса с помощью CURL, это будет выглядеть следующим образом:

$post['attachments[0]'] = '@index.log';
$post['attachments[1]'] = '@index1.log';

Даже если прикладываемый файл всего один, он должен передаваться в $post['attachments[0]'], а не в $post['attachments'].

Если запрос формируется в Postman, параметр с файлом прописывается в Body - form-data:

attachments[0] (file) = (select Files)/index.log

attachments[1] (file) = (select Files)/index1.log

Пример запроса:

\n","_postman_id":"6091fab3-bef6-4362-825e-66712afb649d"}],"id":"7d2aa0e5-9e71-4aa2-9f37-e28c0914ea2c","description":"

Работа с API осуществляется при помощи отправки HTTP-запросов (методы GET, POST) по адресу:

api.dashamail.ru

Возможно использование протоколов HTTP либо HTTPS. Кодировка: UTF-8.

Для отправки писем используется метод transactional.send

\n","_postman_id":"7d2aa0e5-9e71-4aa2-9f37-e28c0914ea2c"},{"name":"Вебхуки (Webhooks)","item":[{"name":"account.get_tr_webhooks","id":"3c10783a-8a54-45b5-b352-94d063370b6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.get_tr_webhooks&event_name=EVENT_NAME","description":"

Получение вебхуков.

account.get_tr_webhooks (string event_name)

Получить список всех заданных webhooks или webhook по определенному событию в транзакционных API

Категория метода

Account

Параметры

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

Наименование	Тип данных	Описание
event_name	string	опционально - событие {open, click, hard, spam, unsub, delivered, send, dropped}

Возвращаемые значения (значения data)

array массив настроенных webhooks:

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

Наименование	Тип данных	Описание
open	string	открытия
click	string	клики
hard	string	возвраты
spam	string	нажатия \"это спам\"
unsub	string	отписки
delivered	string	доставки
send	string	отправки
dropped*	string	не отправлено с сервиса

*самые распространенные причины события:

Нет кампании с таким campaign_id
\n
Некорректные заголовки письма
\n
Недостаточно средств на балансе
\n
Аккаунт заблокирован за спам
\n
Превышен лимит на подписчиков в месячном плане
\n
Блокировка по единой политике коммуникаций
\n
Не настроен домен
\n
Некорректный email-адрес
\n
Нет в списке разрешенных email-адресов
\n
Ранее получен жесткий возврат
\n
Пользователь уже отписан
\n
Email-адрес не подтвержден в качестве отправителя
\n
Недопустимый формат файла
\n
Файл слишком большой
\n
Невозможно прочитать файл
\n

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"account.get_tr_webhooks"},{"description":{"content":"

Событие (опционально)

\n","type":"text/plain"},"key":"event_name","value":"EVENT_NAME"},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"648d5c91-1e53-4190-a60b-83d85d9beb14","name":"account.get_webhooks example","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.get_tr_webhooks&event_name=EVENT_NAME","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"account.get_tr_webhooks","description":"Используемый метод"},{"key":"event_name","value":"EVENT_NAME","description":"Событие (опционально)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Wed, 31 Aug 2022 06:40:25 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"open\": \"OPEN_EVENT_URL\",\n \"click\": \"CLICK_EVENT_URL\",\n \"hard\": \"RETURN_EVENT_URL\",\n \"spam\": \"SPAM_EVENT_URL\",\n \"unsub\": \"UNSUBSCRIBE_EVENT_URL\",\n \"delivered\": \"delivered_EVENT_URL\",\n \"send\": \"send_EVENT_URL\",\n \"dropped\": \"dropped_EVENT_URL\"\n }\n ]\n }\n}"}],"_postman_id":"3c10783a-8a54-45b5-b352-94d063370b6d"},{"name":"account.add_tr_webhooks","id":"6b5eda22-e4e4-4e9d-9590-31ae2146e4b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.add_tr_webhooks&open=OPEN_EVENT_URL","description":"

Добавление вебхуков.

account.add_webhooks (string open, string click, string hard, string spam, string unsub, string send, string delivered, string dropped)

Обновить или добавить webhooks для событий в транзакционных API

Категория метода

Account

Параметры

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

Наименование	Тип данных	Описание
open	string	опционально - url для события \"открытие\"
click	string	опционально - url для события \"клик
hard	string	опционально - url для события \"возвраты\"
spam	string	опционально - url для события \"это спам\"
unsub	string	опционально - url для события \"отписки\"
send	string	опционально - url для события \"отправлено\"
delivered	string	опционально - url для события \"доставлено\"
dropped*	string	опционально - url для события \"не отправлено с сервиса\"

*самые распространенные причины события:

Нет кампании с таким campaign_id
\n
Некорректные заголовки письма
\n
Недостаточно средств на балансе
\n
Аккаунт заблокирован за спам
\n
Превышен лимит на подписчиков в месячном плане
\n
Блокировка по единой политике коммуникаций
\n
Не настроен домен
\n
Некорректный email-адрес
\n
Нет в списке разрешенных email-адресов
\n
Ранее получен жесткий возврат
\n
Пользователь уже отписан
\n
Email-адрес не подтвержден в качестве отправителя
\n
Недопустимый формат файла
\n
Файл слишком большой
\n
Невозможно прочитать файл
\n

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"account.add_tr_webhooks"},{"description":{"content":"

URL для события \"открытие\" (опционально)

\n","type":"text/plain"},"key":"open","value":"OPEN_EVENT_URL"}],"variable":[]}},"response":[{"id":"fe2073e0-66cc-4d59-a1e3-c2763e152558","name":"account.add_webhooks example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.add_tr_webhooks&open=OPEN_EVENT_URL","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"account.add_tr_webhooks","description":"Используемый метод"},{"key":"open","value":"OPEN_EVENT_URL","description":"URL для события \"открытие\" (опционально)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Wed, 31 Aug 2022 06:40:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"6b5eda22-e4e4-4e9d-9590-31ae2146e4b9"},{"name":"account.delete_tr_webhooks","id":"9d5b1310-3807-4846-b041-4915fd78100e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.delete_tr_webhooks&event_name=EVENT_NAME","description":"

Удаление вебхуков.

account.delete_webhooks (string event_name)

Удаляем вебхуки для событий в транзакционных API

Категория метода

Account

Параметры

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

Наименование	Тип данных	Описание
event_name	string	опционально - событие {open, click, hard, spam, unsub, send, delivered, dropped}

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"account.delete_tr_webhooks"},{"description":{"content":"

Опционально - событие (open, click, hard, spam, unsub, sent, delivered, dropped)

\n","type":"text/plain"},"key":"event_name","value":"EVENT_NAME"}],"variable":[]}},"response":[{"id":"13ed5a9c-f009-4072-a036-fb3cbbcadd6e","name":"account.delete_webhooks example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.delete_tr_webhooks&event_name=EVENT_NAME","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"account.delete_tr_webhooks","description":"Используемый метод"},{"key":"event_name","value":"EVENT_NAME","description":"Опционально - событие (open, click, hard, spam, unsub, send, delivered, dropped)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Wed, 31 Aug 2022 06:46:27 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"9d5b1310-3807-4846-b041-4915fd78100e"}],"id":"c3ce43f6-a14f-4e98-8c9e-9b592bb3eed7","description":"

Отчеты о различных событиях, которые происходят с отправляемыми письмами, реализованы в виде вебхуков (webhooks). В разделе \"Аккаунт\"=>\"Доставляемость\"=>\"Вебхуки событий\" вы можете задать адреса скриптов, которые будут вызываться при наступлении определенных событий (возврат, жалоба на спам или невозможность доставки).

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

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

Событие	POST-запрос
Возврат (Bounce)	$_POST['event'] значение 'bounced'
Жалоба на спам (Spam Complaints)	$_POST['event'] значение 'complained'
Открытие (Opens)	$_POST['event'] значение 'opened'
Клик (Clicks)	$_POST['event'] значение 'clicked'
Отписка (Unsubscribe)	$_POST['event'] значение 'unsubscribed' (только если в письме присутствует ссылка отписки с id или class=\"unsub_link\"

Дополнительно могут передаваться:

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

POST-запрос	Описание
$_POST['email']	адрес получателя
$_POST['code']	код ошибки
$_POST['description'], $_POST['error'], $_POST['reason']	описание и причины ошибки
$_POST['event_time']	время события
$_POST['message_id']	id сообщения
$_POST['custom_vars']	JSON-массив пользовательских переменных из заголовка X-Dashamail-Variables*
$_POST['secret']	ключ для проверки валидности вебхука, формируется как md5($_POST['email'].$_POST['message_id'].$webhook_key), где $webhook_key – ключ, который можно найти в разделе \"Интеграции\"=>\"Транзакционные письма\"

*Если в запросе transactional.send задан служебный заголовок \"X-Dashamail-Variables\" с произвольными параметрами в формате JSON-массива, значения параметров будут прилетать обратно в связанном с запросом вебхуке событий

Например, если возврат произошел после многократных попыток доставить, $_POST['reason'] имеет значение 'old', а если есть четкая причина возврата, то 'hardfail'. При этом сам текст ошибки будет содержаться в $_POST['description']. Обычно, коды ошибок, начинающиеся с 5, относятся к \"жестким\" возвратам (несуществующий или заблокированный ящик и т.п.), а начинающиеся с 4 - к \"мягким\" (временная невозможность доставки). В случае нажатия кнопки \"это спам\" чаще всего возвращается код 9.9.9.

\n","_postman_id":"c3ce43f6-a14f-4e98-8c9e-9b592bb3eed7"},{"name":"Проверка статуса письма","item":[{"name":"transactional.check","id":"fa4d595d-0051-4b68-a39d-394ef85ef0a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.dashamail.com/?method=transactional.check&api_key=YOUR_API_KEY&transaction_id=YOUR_TRANSACTION_ID","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Используемый метод

\n","type":"text/plain"},"key":"method","value":"transactional.check"},{"description":{"content":"

Ваш API-ключ. Его можно найти в разделе \"Аккаунт\" => \"Интеграции\"

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

ID транзакции, полученный при отправке письма методом transactional.send

\n","type":"text/plain"},"key":"transaction_id","value":"YOUR_TRANSACTION_ID"}],"variable":[]}},"response":[{"id":"f92d37e6-220a-441f-9e5a-d0867ffcd0eb","name":"transactional.check example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com/?method=transactional.send&api_key=YOUR_API_KEY&transaction_id=YOUR_TRANSACTION_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"method","value":"transactional.send","description":"Используемый метод"},{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ. Его можно найти в разделе \"Аккаунт\" => \"Интеграции\""},{"key":"transaction_id","value":"YOUR_TRANSACTION_ID","description":"D транзакции, полученный при отправке письма методом transactional.send"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Thu, 01 Sep 2022 09:20:41 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": {\n \"data\": {\n \"date\": \"2022-09-27 11:00:39\",\n \"datesent\": \"2022-09-27 11:00:39\",\n \"to\": \"EMAIL ОТПРАВИТЕЛЯ\",\n \"status\": 5,\n \"statusname\": \"Sent\",\n \"statuschangedate\": \"2022-09-27 11:00:39\"\n },\n \"success\": true\n }\n }\n}"}],"_postman_id":"fa4d595d-0051-4b68-a39d-394ef85ef0a0"}],"id":"a1da4676-c9b4-4aae-b046-ef383758f250","description":"

Проверить статус отправленного письма можно методом transactional.check, который принимает в качестве параметра transaction_id, полученный при отправке письма.

В качестве параметра принимает:

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

Наименование	Тип данных	Описание
method	text	Используемый метод (transactional.check)
api_key	text	Ваш API-ключ
transaction_id	text	ID транзакции, полученный при отправке письма методом transactional.send

Возвращаемые значения (значения data)

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

Наименование	Тип данных	Описание
date	datetime	время в формате datetime данного события (yyyy-mm-dd hh:mm:ss)
datesent	datetime	время в формате datetime данного события (yyyy-mm-dd hh:mm:ss)
to	text	email получателя
status	number	числовой идентификатор статуса сообщения
statusname	text	статус сообщения (sent, opened, clicked, bounced, unsubscribed, complained)
statuschangedate	datetime	время в формате datetime данного события (yyyy-mm-dd hh:mm:ss)

Пример запроса:

\n","_postman_id":"a1da4676-c9b4-4aae-b046-ef383758f250"},{"name":"Получение логов событий","item":[{"name":"transactional.get_log","id":"463b1c9d-131d-46da-8800-0ffc971248f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"event_type\": \"NAME_OF_EVENT_TYPE\",\n \"emails\": [{\"email1\":\"EMAIL1@DOMAIN.COM\"}, \n {\"email2\":\"EMAIL2@DOMAIN.COM\"},\n {\"email3\":\"EMAIL3@DOMAIN.COM\"}\n ],\n \"sort\": \"SORT_TYPE\",\n \"campaign_id\": \"CAMPAIGN_ID\",\n \"start\":\"NUMBER\",\n \"limit\":\"NUMBER\",\n \"from\":\"YYYY-MM-DD HH:MM:SS\",\n \"to\":\"YYYY-MM-DD HH:MM:SS\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dashamail.com/?method=transactional.get_log&api_key=YOUR_API_KEY","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Используемый метод

\n","type":"text/plain"},"key":"method","value":"transactional.get_log"},{"description":{"content":"

Ваш API-ключ

\n","type":"text/plain"},"key":"api_key","value":"YOUR_API_KEY"},{"disabled":true,"description":{"content":"

Тип события (all, sent, opened, clicked, bounced, unsubscribed, complained). Возможно задать несколько событий через запятую.

\n","type":"text/plain"},"key":"event_type","value":"NAME_OF_EVENT_TYPE"},{"disabled":true,"description":{"content":"

Email адреса получателей

\n","type":"text/plain"},"key":"emails","value":"EMAIL1@DOMAIN.COM,EMAIL2@DOMAIN.COM"},{"disabled":true,"description":{"content":"

Тип сортировки результата по времени: desc или asc (по event_time)

\n","type":"text/plain"},"key":"sort","value":"SORT_TYPE"},{"disabled":true,"description":{"content":"

фильтр по дополнительному параметру campaign_id

\n","type":"text/plain"},"key":"campaign_id","value":"CAMPAIGN_ID"},{"disabled":true,"description":{"content":"

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

\n","type":"text/plain"},"key":"url","value":"https://example.com/?test_param"},{"disabled":true,"description":{"content":"

с какой позиции начинать

\n","type":"text/plain"},"key":"start ","value":"NUMBER"},{"disabled":true,"description":{"content":"

сколько позиций выводить

\n","type":"text/plain"},"key":"limit","value":"NUMBER"},{"disabled":true,"description":{"content":"

с какого event_time выводить (формат yyyy-mm-dd hh:mm:ss)

\n","type":"text/plain"},"key":"from","value":"YYYY-MM-DD HH:MM:SS"},{"disabled":true,"description":{"content":"

до какого event_time выводить (формат yyyy-mm-dd hh:mm:ss)

\n","type":"text/plain"},"key":"to","value":"YYYY-MM-DD HH:MM:SS"}],"variable":[]}},"response":[{"id":"6938f84d-e8e9-4e73-a533-57299cfcdb11","name":"transactional.get_log","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"event_type\": \"NAME_OF_EVENT_TYPE\",\n \"emails\": [{\"email1\":\"EMAIL1@DOMAIN.COM\"}, \n {\"email2\":\"EMAIL2@DOMAIN.COM\"},\n {\"email3\":\"EMAIL3@DOMAIN.COM\"}\n ],\n \"sort\": \"SORT_TYPE\",\n \"campaign_id\": \"CAMPAIGN_ID\",\n \"start\":\"NUMBER\",\n \"limit\":\"NUMBER\",\n \"from\":\"YYYY-MM-DD HH:MM:SS\",\n \"to\":\"YYYY-MM-DD HH:MM:SS\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.dashamail.com/?method=transactional.get_log&api_key=YOUR_API_KEY","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"method","value":"transactional.get_log","description":"Используемый метод"},{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"event_type","value":"NAME_OF_EVENT_TYPE","description":"Тип события","disabled":true},{"key":"emails","value":"EMAIL1@DOMAIN.COM,EMAIL2@DOMAIN.COM","description":"Email адреса получателей","disabled":true},{"key":"sort","value":"SORT_TYPE","description":"Тип сортировки результата по времени","disabled":true},{"key":"campaign_id","value":"CAMPAIGN_ID","description":"фильтр по дополнительному параметру campaign_id","disabled":true},{"key":"url","value":"https://example.com/?test_param","description":"фильтр, позволяющий выводить только клики по конкретной ссылке, переданной в параметре","type":"text","disabled":true},{"key":"start ","value":"NUMBER","description":"с какой позиции начинать и сколько выводить","disabled":true},{"key":"limit","value":"NUMBER","description":"сколько позиций выводить","disabled":true},{"key":"from","value":"YYYY-MM-DD HH:MM:SS","description":"с какого event_time выводить (формат yyyy-mm-dd hh:mm:ss)","disabled":true},{"key":"to","value":"YYYY-MM-DD HH:MM:SS","description":"до какого event_time выводить (формат yyyy-mm-dd hh:mm:ss)","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"event_date\": \"2023-10-07\",\n \"event_time\": \"2023-10-07 10:30:24\",\n \"event_type\": \"SENT\",\n \"bounce_category\": \"hrd\",\n \"bounce_code\": \"\",\n \"bounce_reason\": \"\",\n \"email\": \"EMAIL1\",\n \"domain\": \"domain\",\n \"user_id\": \"user_id\",\n \"campaign_id\": \"333\",\n \"external_campaign_id\": \"\",\n \"campaign_channel_id\": \"\",\n \"subject\": \"Напоминание об окончании выделенного ip-адреса\",\n \"message_id\": \"message_id\",\n \"body_size\": \"2152\",\n \"url_pers\": \"\",\n \"url_original\": \"\",\n \"ip\": \"\",\n \"ip_aton\": \"\",\n \"region\": \"\",\n \"country_code\": \"\",\n \"OS\": \"\",\n \"browser\": \"\",\n \"webservice\": \"\",\n \"user_agent\": \"\",\n \"referer\": \"\",\n \"language\": \"\",\n \"device\": \"\",\n \"from_email\": \"EMAIL2\",\n \"send_domain\": \"send_domain\"\n },\n {\n \"event_date\": \"2023-10-07\",\n \"event_time\": \"2023-10-07 10:30:21\",\n \"event_type\": \"SENT\",\n \"bounce_category\": \"hrd\",\n \"bounce_code\": \"\",\n \"bounce_reason\": \"\",\n \"email\": \"EMAIL1\",\n \"domain\": \"domain\",\n \"user_id\": \"user_id\",\n \"campaign_id\": \"campaign_id\",\n \"external_campaign_id\": \"\",\n \"campaign_channel_id\": \"\",\n \"subject\": \"Напоминание об окончании месячного тарифного плана\",\n \"message_id\": \"message_id\",\n \"body_size\": \"2187\",\n \"url_pers\": \"\",\n \"url_original\": \"\",\n \"ip\": \"\",\n \"ip_aton\": \"\",\n \"region\": \"\",\n \"country_code\": \"\",\n \"OS\": \"\",\n \"browser\": \"\",\n \"webservice\": \"\",\n \"user_agent\": \"\",\n \"referer\": \"\",\n \"language\": \"\",\n \"device\": \"\",\n \"from_email\": \"EMAIL2\",\n \"send_domain\": \"send_domain\"\n }\n ]\n }\n}"}],"_postman_id":"463b1c9d-131d-46da-8800-0ffc971248f9"}],"id":"d7ccb4d4-e91a-4cbc-a232-2f99accd709b","description":"

Получить лог событий по транзакционным письмам (отправки, открытия, клики и так далее) можно методом transactional.get_log.
В качестве параметров принимает (все параметры опциональные):

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

Наименование	Тип данных	Описание
event_type	text	тип события (all, sent, opened, clicked, bounced, unsubscribed, complained)
emails	email	список email получателей, разделенных запятой
campaign_id	number	фильтр по дополнительному параметру campaign_id
url	text	фильтр, позволяющий выводить только клики по конкретной ссылке, переданной в параметре
sort	text	desc или asc (по event_time)
start	number	с какой позиции начинать
limit	number	сколько позиций выводить
from	date	с какого event_time выводить (формат yyyy-mm-dd hh:mm:ss)
to	date	до какого event_time выводить (формат yyyy-mm-dd hh:mm:ss)

По умолчанию выводит 500 последних событий (любых типов) за последние 30 дней в обратной сортировке.

\n","_postman_id":"d7ccb4d4-e91a-4cbc-a232-2f99accd709b"},{"name":"Получение статистики по событиям за период","item":[{"name":"transactional.get_stat","id":"d30800b1-f4ac-4b18-b4e2-2c4c64953254","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.dashamail.com/?method=transactional.get_stat&format=XML&api_key=YOUR_API_KEY&period=CUSTOM&start_date=YYYY-MM-DD&finish_date=YYYY-MM-DD%HH:MM:SS&groupby=DAY&campaign_id=CAMPAIIGN_ID","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Используемый метод

\n","type":"text/plain"},"key":"method","value":"transactional.get_stat"},{"key":"format","value":"XML"},{"description":{"content":"

Ваш API-ключ

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

период выборки

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

с какого event_time выводить

\n","type":"text/plain"},"key":"start_date","value":"YYYY-MM-DD"},{"description":{"content":"

до какого event_time выводить

\n","type":"text/plain"},"key":"finish_date","value":"YYYY-MM-DD%HH:MM:SS"},{"description":{"content":"

размер временного слота

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

фильтр по дополнительному параметру campaign_id

\n","type":"text/plain"},"key":"campaign_id","value":"CAMPAIIGN_ID"}],"variable":[]}},"response":[{"id":"b161abd5-a49c-43e9-9f6a-d451432ec120","name":"transactional.get_stat","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?method=transactional.get_stat&format=XML&api_key=YOUR_API_KEY&period=CUSTOM&start_date=YYYY-MM-DD&finish_date=YYYY-MM-DD%HH:MM:SS&groupby=DAY&campaign_id=CAMPAIIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"method","value":"transactional.get_stat"},{"key":"format","value":"XML"},{"key":"api_key","value":"YOUR_API_KEY"},{"key":"period","value":"CUSTOM"},{"key":"start_date","value":"YYYY-MM-DD"},{"key":"finish_date","value":"YYYY-MM-DD%HH:MM:SS"},{"key":"groupby","value":"DAY"},{"key":"campaign_id","value":"CAMPAIIGN_ID"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"\n\n0\nOK\nmessage\n\n\n\n2023-09-01\n59\n12\n3\n0\n0\n0\n129510\n\n\n2023-09-02\n51\n3\n0\n0\n0\n0\n111496\n\n\n2023-09-03\n42\n9\n0\n0\n0\n0\n91827\n\n\n\n"}],"_postman_id":"d30800b1-f4ac-4b18-b4e2-2c4c64953254"}],"id":"1d4a9621-477c-418d-838e-585234ce2c31","description":"

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

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

Наименование	Тип данных	Описание
period	text	период выборки, возможные значения ['1h','24h','7d','30d','custom']. По-умолчанию: 1h
campaign_id	number	дополнительно. фильтр по дополнительному параметру campaign_id
groupby	text	задается, если используется период со значением custom. размер временного слота, возможные значения: ['hour','day','week','month']
start_date	date	задается, если используется период со значением custom. с какого event_time выводить (произвольный машиночитаемый формат, например, yyyy-mm-dd hh:mm:ss). Если не время не задано, то считается 00:00:00
finish_date	date	задается, если используется период со значением custom. до какого event_time выводить (произвольный машиночитаемый формат, например, yyyy-mm-dd hh:mm:ss). Если не время не задано, то считается 00:00:00

Возвращаемые значения (значения data)

Массив числа событий SENT, OPENED, CLICKED, UNSUBSCRIBED, COMPLAINED, BOUNCED и суммарный объем траффика (в байтах) по временным слотам. В случае использования готовых периодов временные слоты группируемых событий такие:

1h – 5 минут
24h - 1 час
7d - 1 день
30d – 1 день

\n","_postman_id":"1d4a9621-477c-418d-838e-585234ce2c31"}],"id":"0798aa0b-5636-4aeb-a11b-da3d3ff28c42","_postman_id":"0798aa0b-5636-4aeb-a11b-da3d3ff28c42","description":""},{"name":"Общее API","item":[{"name":"Lists","item":[{"name":"Адресные базы","item":[{"name":"lists.get","id":"2c0e4cdd-2b84-45ce-bcee-39e4e9c63d37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=lists.get&list_id=18893","description":"

Получение списка баз пользователя.

lists.get(int list_id, int merge_json)

Получаем список баз пользователя

Категория метода

Lists

Параметры

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

Наименование	Тип данных	Описание
list_id	int	опционально - id запрашиваемой адресной базы
merge_json	int	опционально - вывод параметров дополнительных полей (merge_{1..10}) в формате JSON вместо сериализованного массива

Возвращаемые значения (значения data)

array: Массив строк адресных баз с различными параметрами. Вложенный массив подразумевается сериализорованным.

Наименование	Тип данных	Описание
id	number	id адресной базы
name	text	название адресной базы
state	text	статус адресной базы: active, blocked (если идет процесс импорта) и archived
merge_{1..10}	array	Сериализированные массивы настроек дополнительных полей: title: название дополнительного поля; type: тип поля, возможные значения: text, date, choice; req: обязательно поле или нет? возможные значения: on,off; var: название шаблона
description	text	описание того, как подписчик может оказаться в этой базе
company	text	название вашей компании, владеющей адресной базой
abuse_name	text	имя человека, которому можно жаловаться на спам
phone	phone	контактный телефон
address	text	контактный адрес
city	text	город, где находится ваша компания
url	url	вашего сайта, где можно подписаться/отписаться на базу
count_active	number	количество активных подписчиков в базе
count_bounced	number	количество жестких возвратов в базе
count_inactive	number	количество неактивных подписчиков в базе
count_unconfirmed	number	количество неподтвержденных адресов в базе
count_unsubscribed	number	количество отписавшихся подписчиков в базе
count_all	number	общее количество подписчиков в базе
count	массив данных JSON	JSON-массив с агрегированной статистикой подписчиков в адресной базе
stat	массив данных JSON	JSON-массив с агрегированной статистикой рассылок (открытий, кликов итд) по данной адресной базе

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"lists.get"},{"description":{"content":"

ID запрашиваемой базы

\n","type":"text/plain"},"key":"list_id","value":"18893"}],"variable":[]}},"response":[{"id":"9c32e19f-41d5-411b-af90-ecebbfd60b3c","name":"lists.get example","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=lists.get&list_id=98244","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"lists.get","description":"Используемый метод"},{"key":"list_id","value":"98244","description":"ID запрашиваемой базы"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Tue, 23 Aug 2022 15:10:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"id\": \"ID_ЗАПРАШИВАЕМОЙ_АДРЕСНОЙ_БАЗЫ\",\n \"state\": \"active/blocked/archived\",\n \"import_result\": \"\",\n \"name\": \"НАИМЕНОВАНИЕ_АДРЕСНОЙ_БАЗЫ\",\n \"public_name\": \"\",\n \"creation_date\": \"2022-07-19 01:08:05\",\n \"merge_1\": \"СЕРИАЛИЗОВАННЫЙ_МАССИВ_НАСТРОЕК_ДОПОЛНИТЕЛЬНОГО_ПОЛЯ_1\",\n \"merge_2\": \"СЕРИАЛИЗОВАННЫЙ_МАССИВ_НАСТРОЕК_ДОПОЛНИТЕЛЬНОГО_ПОЛЯ_2\",\n \"merge_3\": \"\",\n \"merge_4\": \"\",\n \"merge_5\": \"\",\n \"merge_6\": \"\",\n \"merge_7\": \"\",\n \"merge_8\": \"\",\n \"merge_9\": \"\",\n \"merge_10\": \"\",\n \"description\": \"\",\n \"company\": \"\",\n \"abuse_name\": \"\",\n \"abuse_email\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"url\": \"\",\n \"unsub\": \"0\",\n \"eng\": \"0\",\n \"de\": \"0\",\n \"redirect\": \"\",\n \"sub_redirect\": \"\",\n \"before_sub_redirect\": \"\",\n \"count\": \"a:6:{s:6:\\\"active\\\";s:1:\\\"4\\\";s:12:\\\"unsubscribed\\\";s:1:\\\"0\\\";s:11:\\\"unconfirmed\\\";s:1:\\\"0\\\";s:7:\\\"bounced\\\";s:1:\\\"0\\\";s:8:\\\"inactive\\\";s:1:\\\"0\\\";s:3:\\\"all\\\";i:4;}\",\n \"count_update_time\": \"2022-08-23 17:23:13\",\n \"common_rate\": \"0\",\n \"bounce_rate\": \"0\",\n \"updated\": \"1\",\n \"stat\": \"a:15:{s:5:\\\"opens\\\";i:0;s:6:\\\"clicks\\\";i:0;s:7:\\\"bounces\\\";i:0;s:6:\\\"unsubs\\\";i:0;s:4:\\\"sent\\\";i:0;s:7:\\\"preview\\\";i:0;s:7:\\\"forward\\\";i:0;s:5:\\\"vcard\\\";i:0;s:9:\\\"open_rate\\\";i:0;s:10:\\\"click_rate\\\";i:0;s:10:\\\"unsub_rate\\\";i:0;s:11:\\\"bounce_rate\\\";i:0;s:6:\\\"opened\\\";i:14;s:7:\\\"bounced\\\";i:0;s:12:\\\"unsubscribed\\\";i:0;}\",\n \"stat_update_time\": \"2022-07-19 03:38:23\",\n \"cogort_update_time\": \"2022-08-06 00:34:24\",\n \"notify\": \"0\",\n \"notify_unsub\": \"0\",\n \"bad_list\": \"0\",\n \"novalid_rate\": \"0\",\n \"default_list\": \"0\",\n \"notify_email\": \"\",\n \"default_logo\": \"\",\n \"show_unsub\": \"1\",\n \"floctory\": \"0\",\n \"region_export\": \"0\",\n \"selected_columns\": null,\n \"count_active\": \"4\",\n \"count_all\": 4,\n \"count_bounced\": \"0\",\n \"count_unsubscribed\": \"0\"\n }\n ]\n }\n}"}],"_postman_id":"2c0e4cdd-2b84-45ce-bcee-39e4e9c63d37"},{"name":"lists.add","id":"48284334-94b8-4e3a-ad0d-78fc86f0dbb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"ADDRESS_BASE_NAME\",\r\n \"fields\": [\r\n {\"title\":\"FirstName\",\"type\":\"text\",\"req\":\"off\",\"var\":\"FIRSTNAME\"},\r\n {\"title\":\"LastName\",\"type\":\"text\",\"req\":\"off\",\"var\":\"LASTNAME\"}, \r\n {\"title\":\"NickName\",\"type\":\"text\",\"req\":\"on\",\"var\":\"NICKNAME\"}]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.add","description":"

Добавление новой адресной базы

lists.get(string name, JSON fields, string abuse_email, string abuse_name, string company, string address, string city, string zip, string country, string url, string phone)

Добавляем адресную базу

Категория метода

Lists

Параметры

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

Наименование	Тип данных	Описание
name	string	название создаваемой базы
fields	JSON	опционально - JSON-массив с объектами полей из метода add_merge или update_merge
abuse_email	string	опционально - Email, по которому будут приниматься жалобы на спам
abuse_name	string	опционально - Имя человека, которому можно жаловаться на спам
company	string	опционально - название вашей компании, владеющей адресной базой
address	string	опционально - контактный адрес
city	string	опционально - город, где находится ваша компания
zip	string	опционально - почтовый индекс
country	string	опционально - страна, где вы находитесь
url	string	опционально - url вашего сайта, где можно подписаться/отписаться на базу
phone	string	опционально - контактный телефон

Возвращаемые значения (значения data)

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

Наименование	Тип данных	Описание
list_id	number	id добавленной базы

","urlObject":{"protocol":"https","host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"lists.add"},{"disabled":true,"description":{"content":"

Название создаваемой базы

\n","type":"text/plain"},"key":"name","value":"ADDRESS_BASE_NAME"},{"disabled":true,"description":{"content":"

JSON-массив с объектами полей

\n","type":"text/plain"},"key":"fields","value":"JSON_ARRAY"}],"variable":[]}},"response":[{"id":"0b9d181d-0d39-4abf-971a-52f077da12a6","name":"lists.add example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"ADDRESS_BASE_NAME\",\r\n \"fields\": [\r\n {\"title\":\"FirstName\",\"type\":\"text\",\"req\":\"off\",\"var\":\"FIRSTNAME\"},\r\n {\"title\":\"LastName\",\"type\":\"text\",\"req\":\"off\",\"var\":\"LASTNAME\"}, \r\n {\"title\":\"NickName\",\"type\":\"text\",\"req\":\"on\",\"var\":\"NICKNAME\"}]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.add","protocol":"https","host":["api","dashamail","com"],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"lists.add","description":"Используемый метод"},{"key":"name","value":"ADDRESS_BASE_NAME","description":"Название создаваемой базы","disabled":true},{"key":"fields","value":"[{\"title\":\"FirstName\",\"type\":\"text\",\"req\":\"off\",\"var\":\"FIRSTNAME\"},{\"title\":\"LastName\",\"type\":\"text\",\"req\":\"off\",\"var\":\"LASTNAME\"},{\"title\":\"NickName\",\"type\":\"text\",\"req\":\"on\",\"var\":\"NICKNAME\"}]","description":"JSON-массив с объектами полей","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Tue, 23 Aug 2022 17:52:27 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": {\n \"list_id\": \"ID_СОЗДАННОЙ_АДРЕСНОЙ_БАЗЫ_(INT)\"\n }\n }\n}"}],"_postman_id":"48284334-94b8-4e3a-ad0d-78fc86f0dbb2"},{"name":"lists.update","id":"1ee10f1c-96f6-49b3-afbd-cc635e78d875","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.update&list_id=YOUR_LIST_ID_FOR_UPDATE&name=NEW_BASE_NAME","description":"

Обновление контактной информации адресной базы.

lists.update(int list_id, string name, string abuse_email, string abuse_name, string company, string address, string city, string zip, string country, string url, string phone)

Обновляем контактную информацию адресной базы

Категория метода

Lists

Параметры

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

Наименование	Тип данных	Описание
list_id	int	id редактируемой адресной базы
name	string	опционально - Название базы
abuse_email	string	опционально - Email, по которому будут приниматься жалобы на спам
abuse_name	string	опционально - Имя человека, которому можно жаловаться на спам
company	string	опционально - название вашей компании, владеющей адресной базой
address	string	опционально - контактный адрес
city	string	опционально - город, где находится ваша компания
zip	string	опционально - почтовый индекс
country	string	опционально - страна, где вы находитесь
url	string	опционально - url вашего сайта, где можно подписаться/отписаться на базу
phone	string	опционально - контактный телефон

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"lists.update"},{"description":{"content":"

ID редактируемой адресной базы

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

Опционально. Название адресной базы

\n","type":"text/plain"},"key":"name","value":"NEW_BASE_NAME"}],"variable":[]}},"response":[{"id":"2e842493-17d6-4ebf-b2df-8285b948b925","name":"lists.update example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.update&list_id=YOUR_LIST_ID_FOR_UPDATE&name=NEW_BASE_NAME","protocol":"https","host":["api","dashamail","com"],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"lists.update","description":"Используемый метод"},{"key":"list_id","value":"YOUR_LIST_ID_FOR_UPDATE","description":"ID редактируемой адресной базы"},{"key":"name","value":"NEW_BASE_NAME","description":"Опционально. Название адресной базы"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Tue, 23 Aug 2022 18:07:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"1ee10f1c-96f6-49b3-afbd-cc635e78d875"},{"name":"lists.delete","id":"2c10e500-99d4-4df1-bdd7-cd8b0cf4f758","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.delete&list_id=YOUR_LIST_ID_FOR_DELETE","description":"

Удаление адресной базы и активных подписчиков.

lists.delete(int list_id)

Удаляем адресную базу и всех активных подписчиков в ней

Категория метода

Lists

Параметры

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

Наименование	Тип данных	Описание
list_id	int	id удаляемой адресной базы

Возвращаемые значения (значения data)

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

Наименование	Тип данных	Описание
deleted_members	number	количество удаленных активных подписчиков из удаленной базы

","urlObject":{"protocol":"https","host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"lists.delete"},{"description":{"content":"

ID удаляемой адресной базы

\n","type":"text/plain"},"key":"list_id","value":"YOUR_LIST_ID_FOR_DELETE"}],"variable":[]}},"response":[{"id":"938ed819-2e88-43b7-af4d-8a3f8172cc89","name":"lists.delete example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.delete&list_id=YOUR_LIST_ID_FOR_DELETE","protocol":"https","host":["api","dashamail","com"],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"lists.delete","description":"Используемый метод"},{"key":"list_id","value":"YOUR_LIST_ID_FOR_DELETE","description":"ID удаляемой адресной базы"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Tue, 23 Aug 2022 18:18:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": {\n \"deleted_members\": \"КОЛИЧЕСТВО_УДАЛЕННЫХ_ПОДПИСЧИКОВ_(NUMBER)\"\n }\n }\n}"}],"_postman_id":"2c10e500-99d4-4df1-bdd7-cd8b0cf4f758"}],"id":"a2e6509e-32a2-4ed7-9470-e4b4901b44bb","description":"

Манипуляции с Адресными базами.

\n","_postman_id":"a2e6509e-32a2-4ed7-9470-e4b4901b44bb"},{"name":"Подписчики","item":[{"name":"lists.get_members","id":"cda114ff-da37-4e71-aa3f-58816740105c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.get_members&list_id=YOUR_ADDRESS_BASE_ID&segment_id=SEGMENT_ID","description":"

Получение списка подписчиков адресной базы.

lists.get_members(int list_id, string state, int start, int limit, string order, int member_id, string email)

Получаем подписчиков в адресной базе с возможностью фильтра и регулировки выдачи

Категория метода

Lists

Параметры

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

Наименование	Тип данных	Описание
list_id	int	id адресной базы
state	string	опционально - статус подписчика, возможные варианты: active; unsubscribed; bounced
start	int	опционально - с какого номера начинать выдачу данных
limit	int	опционально - кол-во подписчиков в выдаваемом массиве. По умолчанию - 100
order	string	опционально - порядок сортировки, вида \"поле порядок\", например, \"id desc\"
member_id	int	опционально - id необходимого подписчика
email	string	опционально - email необходимого подписчика
segment_id	int	опционально - id сегмента подписчиков

Возвращаемые значения (значения data)

Массив подписчиков с параметрами:

Наименование	Тип данных	Описание
id	number	id подписчика
list_id	number	адресная база в которой он состоит
email	email	email-адрес подписчика
state	text	статус подписчика
merge_1	text; number; date	дополнительное поле №1
merge_2	text; number; date	дополнительное поле №2
merge_3	text; number; date	дополнительное поле №3
merge_4	text; number; date	дополнительное поле №4
merge_5	text; number; date	дополнительное поле №5
merge_6	text; number; date	дополнительное поле №6
merge_7	text; number; date	дополнительное поле №7
merge_8	text; number; date	дополнительное поле №8
merge_9	text; number; date	дополнительное поле №9
merge_10	text; number; date	дополнительное поле №10
optin_time	datetime	время добавления в базу
unsub_time	datetime	время отписки из базы
lastedit_time	datetime	время последнего редактирования
gender	text	пол подписчика {m - мужчина, f - женщина, n - неизвестно}
source	text	источник подписки
device	text	устройство, с которого читаются письма
rating	number	рейтинг подписчика

","urlObject":{"protocol":"https","host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"lists.get_members"},{"description":{"content":"

ID адресной базы

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

ID сегмента подписчиков

\n","type":"text/plain"},"key":"segment_id","value":"SEGMENT_ID"}],"variable":[]}},"response":[{"id":"c8bb7ad8-c684-4f18-846d-61baab2e9b52","name":"lists.get_members","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.get_members&list_id=YOUR_ADDRESS_BASE_ID","protocol":"https","host":["api","dashamail","com"],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"lists.get_members","description":"Используемый метод"},{"key":"list_id","value":"YOUR_ADDRESS_BASE_ID","description":"ID адресной базы"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Tue, 23 Aug 2022 19:22:54 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"id\": \"42\",\n \"list_id\": \"98244\",\n \"email\": \"old_user@domain.com\",\n \"state\": \"active\",\n \"merge_1\": \"Пользователь_1\",\n \"merge_2\": \"\",\n \"merge_3\": \"\",\n \"merge_4\": \"\",\n \"merge_5\": \"\",\n \"merge_6\": \"\",\n \"merge_7\": \"\",\n \"merge_8\": \"\",\n \"merge_9\": \"\",\n \"merge_10\": \"\",\n \"merge_11\": \"\",\n \"merge_12\": \"\",\n \"merge_13\": \"\",\n \"merge_14\": \"\",\n \"merge_15\": \"\",\n \"optin_time\": \"2022-08-23 17:21:49\",\n \"bounce_time\": \"0000-00-00 00:00:00\",\n \"unsub_time\": \"0000-00-00 00:00:00\",\n \"lastedit_time\": \"2022-08-23 17:23:35\",\n \"gender\": \"n\",\n \"source\": \"manual\",\n \"device\": \"\",\n \"rating\": \"50\",\n \"region\": \"0\"\n },\n {\n \"id\": \"43\",\n \"list_id\": \"98244\",\n \"email\": \"user@domain.com\",\n \"state\": \"active\",\n \"merge_1\": \"Пользователь_2\",\n \"merge_2\": \"\",\n \"merge_3\": \"\",\n \"merge_4\": \"\",\n \"merge_5\": \"\",\n \"merge_6\": \"\",\n \"merge_7\": \"\",\n \"merge_8\": \"\",\n \"merge_9\": \"\",\n \"merge_10\": \"\",\n \"merge_11\": \"\",\n \"merge_12\": \"\",\n \"merge_13\": \"\",\n \"merge_14\": \"\",\n \"merge_15\": \"\",\n \"optin_time\": \"2022-08-23 17:22:47\",\n \"bounce_time\": \"0000-00-00 00:00:00\",\n \"unsub_time\": \"0000-00-00 00:00:00\",\n \"lastedit_time\": \"0000-00-00 00:00:00\",\n \"gender\": \"n\",\n \"source\": \"manual\",\n \"device\": \"\",\n \"rating\": \"50\",\n \"region\": \"0\"\n },\n {\n \"id\": \"44\",\n \"list_id\": \"98244\",\n \"email\": \"new_user@domain.com\",\n \"state\": \"active\",\n \"merge_1\": \"Пользователь_3\",\n \"merge_2\": \"\",\n \"merge_3\": \"\",\n \"merge_4\": \"\",\n \"merge_5\": \"\",\n \"merge_6\": \"\",\n \"merge_7\": \"\",\n \"merge_8\": \"\",\n \"merge_9\": \"\",\n \"merge_10\": \"\",\n \"merge_11\": \"\",\n \"merge_12\": \"\",\n \"merge_13\": \"\",\n \"merge_14\": \"\",\n \"merge_15\": \"\",\n \"optin_time\": \"2022-08-23 17:23:13\",\n \"bounce_time\": \"0000-00-00 00:00:00\",\n \"unsub_time\": \"0000-00-00 00:00:00\",\n \"lastedit_time\": \"0000-00-00 00:00:00\",\n \"gender\": \"n\",\n \"source\": \"manual\",\n \"device\": \"\",\n \"rating\": \"50\",\n \"region\": \"0\"\n }\n ]\n }\n}"}],"_postman_id":"cda114ff-da37-4e71-aa3f-58816740105c"},{"name":"lists.get_unsubscribed","id":"a202d918-8ee9-4c6d-aadb-d5479f245e9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.get_unsubscribed&list_id=YOUR_ADDRESS_BASE_ID&date_start=DATE_START_FILTER&date_end=DATE_END_FILTER","description":"

Получение списка отписавшихся.

lists.get_unsubscribed(int start, int limit, string order, string list_id, datetime date_start, datetime date_end)

Получаем список отписавшихся подписчиков как из всех баз, так и в разрезе конкретной адресной базы

Категория метода

Lists

Параметры

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

Наименование	Тип данных	Описание
start	int	опционально - с какого номера начинать выдачу данных
limit	int	опционально - кол-во подписчиков в выдаваемом массиве
order	string	опционально - порядок сортировки, вида \"поле порядок\", например, \"id desc\"
list_id	string	опционально - ID адресной базы
date_start	datetime	опционально - фильтрует отписавшихся с определенного времени, например, 2022-02-22 22:00:22
date_end	datetime	опционально - фильтрует отписавшихся до определенного времени, например, 2022-02-22 22:00:22

Возвращаемые значения (значения data)

Массив подписчиков с параметрами:

Наименование	Тип данных	Описание
id	number	id подписчика
list_id	number	адресная база в которой он состоит
email	email	email-адрес подписчика
state	text	статус подписчика
merge_1	text; number; date	дополнительное поле №1
merge_2	text; number; date	дополнительное поле №2
merge_3	text; number; date	дополнительное поле №3
merge_4	text; number; date	дополнительное поле №4
merge_5	text; number; date	дополнительное поле №5
merge_6	text; number; date	дополнительное поле №6
merge_7	text; number; date	дополнительное поле №7
merge_8	text; number; date	дополнительное поле №8
merge_9	text; number; date	дополнительное поле №9
merge_10	text; number; date	дополнительное поле №10
optin_time	datetime	время добавления в базу
unsub_time	datetime	время отписки из базы
lastedit_time	datetime	время последнего редактирования
gender	text	пол подписчика {m - мужчина, f - женщина, n - неизвестно}
source	text	источник подписки
device	text	устройство, с которого читаются письма
rating	number	рейтинг подписчика

","urlObject":{"protocol":"https","host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"lists.get_unsubscribed"},{"description":{"content":"

ID адресной базы

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

Фильтр отписавшихся с определенного времени

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

Фильтр отписавшихся до определенного времени

\n","type":"text/plain"},"key":"date_end","value":"DATE_END_FILTER"}],"variable":[]}},"response":[{"id":"e329f807-a3f1-4ed0-837a-cfeac1b79fff","name":"lists.get_unsubscribed example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.get_unsubscribed&list_id=YOUR_ADDRESS_BASE_ID&date_start=DATE_START_FILTER&date_end=DATE_END_FILTER","protocol":"https","host":["api","dashamail","com"],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"lists.get_unsubscribed","description":"Используемый метод"},{"key":"list_id","value":"YOUR_ADDRESS_BASE_ID","description":"ID адресной базы"},{"key":"date_start","value":"DATE_START_FILTER","description":"Фильтр отписавшихся с определенного времени"},{"key":"date_end","value":"DATE_END_FILTER","description":"Фильтр отписавшихся до определенного времени"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Thu, 25 Aug 2022 18:34:58 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"id\": \"6\",\n \"list_id\": \"YOUR_ADDRESS_BASE_ID\",\n \"email\": \"UNSUBSCRIBED_USER_EMAIL_1\",\n \"state\": \"unsubscribed\",\n \"merge_1\": \"\",\n \"merge_2\": \"\",\n \"merge_3\": \"\",\n \"merge_4\": \"\",\n \"merge_5\": \"\",\n \"merge_6\": \"\",\n \"merge_7\": \"\",\n \"merge_8\": \"\",\n \"merge_9\": \"\",\n \"merge_10\": \"\",\n \"merge_11\": \"\",\n \"merge_12\": \"\",\n \"merge_13\": \"\",\n \"merge_14\": \"\",\n \"merge_15\": \"\",\n \"optin_time\": \"2022-08-17 12:38:12\",\n \"bounce_time\": \"0000-00-00 00:00:00\",\n \"unsub_time\": \"2022-08-25 21:34:25\",\n \"lastedit_time\": \"2022-08-25 21:32:56\",\n \"gender\": \"n\",\n \"source\": \"api\",\n \"device\": \"\",\n \"rating\": \"50\",\n \"region\": \"0\"\n },\n {\n \"id\": \"7\",\n \"list_id\": \"YOUR_ADDRESS_BASE_ID\",\n \"email\": \"UNSUBSCRIBED_USER_EMAIL_2\",\n \"state\": \"unsubscribed\",\n \"merge_1\": \"\",\n \"merge_2\": \"\",\n \"merge_3\": \"\",\n \"merge_4\": \"\",\n \"merge_5\": \"\",\n \"merge_6\": \"\",\n \"merge_7\": \"\",\n \"merge_8\": \"\",\n \"merge_9\": \"\",\n \"merge_10\": \"\",\n \"merge_11\": \"\",\n \"merge_12\": \"\",\n \"merge_13\": \"\",\n \"merge_14\": \"\",\n \"merge_15\": \"\",\n \"optin_time\": \"2022-08-17 13:41:41\",\n \"bounce_time\": \"0000-00-00 00:00:00\",\n \"unsub_time\": \"2022-08-25 21:34:25\",\n \"lastedit_time\": \"2022-08-25 21:33:23\",\n \"gender\": \"n\",\n \"source\": \"api\",\n \"device\": \"\",\n \"rating\": \"50\",\n \"region\": \"0\"\n },\n {\n \"id\": \"8\",\n \"list_id\": \"YOUR_ADDRESS_BASE_ID\",\n \"email\": \"UNSUBSCRIBED_USER_EMAIL_3\",\n \"state\": \"unsubscribed\",\n \"merge_1\": \"\",\n \"merge_2\": \"\",\n \"merge_3\": \"\",\n \"merge_4\": \"\",\n \"merge_5\": \"\",\n \"merge_6\": \"\",\n \"merge_7\": \"\",\n \"merge_8\": \"\",\n \"merge_9\": \"\",\n \"merge_10\": \"\",\n \"merge_11\": \"\",\n \"merge_12\": \"\",\n \"merge_13\": \"\",\n \"merge_14\": \"\",\n \"merge_15\": \"\",\n \"optin_time\": \"2022-08-17 14:07:38\",\n \"bounce_time\": \"0000-00-00 00:00:00\",\n \"unsub_time\": \"2022-08-25 21:34:25\",\n \"lastedit_time\": \"2022-08-25 21:34:12\",\n \"gender\": \"n\",\n \"source\": \"api\",\n \"device\": \"\",\n \"rating\": \"50\",\n \"region\": \"0\"\n }\n ]\n }\n}"}],"_postman_id":"a202d918-8ee9-4c6d-aadb-d5479f245e9c"},{"name":"lists.member_activity","id":"9f425ecd-6e76-4721-b327-17ce68b70f07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.member_activity&email=MEMBERS_EMAIL&filter=opened","description":"

Получение активности подписчика.

lists.member_activity(string email, string filter)

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

Категория метода

Lists

Параметры

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

Наименование	Тип данных	Описание
email	string	email подписчика
filter	string	опционально - Фильтр по типу события. Возможные значения: {sent, opened, clicked, bounced, unsubscribed}

Возвращаемые значения (значения data)

Массив событий, сортированный в обратном порядке по времени события:

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

Наименование	Тип данных	Описание
member_id	number	id подписчика
action_time	datetime	дата и время события
campaign_id	number	id рассылки, в которой произошло событие
list_id	number	id адресной базы, используемой при рассылке
action	text	тип события {campaign-sent, campaign-opened, campaign-clicked, unsubscribe, bounced, abuse-report}
action_text	text	расшифровка события
campaign_name	text	название рассылки, в которой произошло событие
bounce_category	text	[для возвратов] категория возврата письма {hrd,sft,blk,spm}
bounce_reason	text	[для возвратов] полный текст ошибки возврата письма

","urlObject":{"protocol":"https","host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"lists.member_activity"},{"description":{"content":"

Email подписчика

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

Фильтр по типу события (опционально)

\n","type":"text/plain"},"key":"filter","value":"opened"}],"variable":[]}},"response":[{"id":"1a421efd-6d0d-436d-997b-79bcb557f4dc","name":"lists.member_activity example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.member_activity&email=MEMBERS_EMAIL&filter=EVENT_TYPE","protocol":"https","host":["api","dashamail","com"],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"lists.member_activity","description":"Используемый метод"},{"key":"email","value":"MEMBERS_EMAIL","description":"Email подписчика"},{"key":"filter","value":"EVENT_TYPE","description":"Фильтр по типу события (опционально)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Thu, 25 Aug 2022 18:45:03 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"member_id\": \"1\",\n \"action_time\": \"2022-07-14 01:10:40\",\n \"campaign_id\": \"EVENT_CAMPAIGN_ID\",\n \"list_id\": \"ADDRESS_BASE_ID\",\n \"action\": \"campaign-opened\",\n \"action_text\": \"Открыто письмо\",\n \"campaign_name\": \"EVENT_CAMPAIGN_NAME\"\n }\n ]\n }\n}"}],"_postman_id":"9f425ecd-6e76-4721-b327-17ce68b70f07"},{"name":"lists.get_complaints","id":"4d756667-0036-4866-8a15-f8515d61355d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.get_complaints&list_id=YOUR_ADDRESS_BASE_ID&start=NUMBER&limit=NUMBER&order=SORT_ORDER","description":"

Получение списка пользователей, нажавших \"Спам\".

lists.get_complaints(int start, int limit, string order, int list_id)

Получаем список подписчиков, нажавших «Это Спам», как из всех баз, так и в разрезе конкретной базы

Категория метода

Lists

Параметры

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

Наименование	Тип данных	Описание
start	int	опционально - с какого номера начинать выдачу данных
limit	int	опционально - кол-во подписчиков в выдаваемом массиве
order	string	опционально - порядок сортировки, вида \"поле порядок\", например, \"id desc\"
list_id	int	опционально - ID адресной базы

Возвращаемые значения (значения data)

Массив подписчиков с параметрами:

Наименование	Тип данных	Описание
id	number	id подписчика
list_id	number	адресная база в которой он состоит
email	email	email-адрес подписчика
state	text	статус подписчика
merge_1	text; number; date	дополнительное поле №1
merge_2	text; number; date	дополнительное поле №2
merge_3	text; number; date	дополнительное поле №3
merge_4	text; number; date	дополнительное поле №4
merge_5	text; number; date	дополнительное поле №5
merge_6	text; number; date	дополнительное поле №6
merge_7	text; number; date	дополнительное поле №7
merge_8	text; number; date	дополнительное поле №8
merge_9	text; number; date	дополнительное поле №9
merge_10	text; number; date	дополнительное поле №10
optin_time	datetime	время добавления в базу
unsub_time	datetime	время отписки из базы
lastedit_time	datetime	время последнего редактирования
gender	text	пол подписчика {m - мужчина, f - женщина, n - неизвестно}
source	text	источник подписки
device	text	устройство, с которого читаются письма
rating	number	рейтинг подписчика

","urlObject":{"protocol":"https","host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"lists.get_complaints"},{"description":{"content":"

ID адресной базы (опционально)

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

С какого номера начинать выдачу данных (опционально)

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

Количество подписчиков в выдаваемом массиве (опционально)

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

Порядок сортировки (опционально)

\n","type":"text/plain"},"key":"order","value":"SORT_ORDER"}],"variable":[]}},"response":[{"id":"31d4ef31-c410-4d08-a734-76002ff9aabc","name":"lists.get_complaints example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.get_complaints&list_id=YOUR_ADDRESS_BASE_ID&start=NUMBER&limit=NUMBER&order=SORT_ORDER","protocol":"https","host":["api","dashamail","com"],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"lists.get_complaints","description":"Используемый метод"},{"key":"list_id","value":"YOUR_ADDRESS_BASE_ID","description":"ID адресной базы (опционально)"},{"key":"start","value":"NUMBER","description":"С какого номера начинать выдачу данных (опционально)"},{"key":"limit","value":"NUMBER","description":"Количество подписчиков в выдаваемом массиве (опционально)"},{"key":"order","value":"SORT_ORDER","description":"Порядок сортировки (опционально)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Thu, 25 Aug 2022 18:55:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"id\": \"6\",\n \"list_id\": \"YOUR_ADDRESS_BASE_ID\",\n \"email\": \"UNSUBSCRIBED_USER_EMAIL_1\",\n \"state\": \"unsubscribed\",\n \"merge_1\": \"\",\n \"merge_2\": \"\",\n \"merge_3\": \"\",\n \"merge_4\": \"\",\n \"merge_5\": \"\",\n \"merge_6\": \"\",\n \"merge_7\": \"\",\n \"merge_8\": \"\",\n \"merge_9\": \"\",\n \"merge_10\": \"\",\n \"merge_11\": \"\",\n \"merge_12\": \"\",\n \"merge_13\": \"\",\n \"merge_14\": \"\",\n \"merge_15\": \"\",\n \"optin_time\": \"2022-08-17 12:38:12\",\n \"bounce_time\": \"0000-00-00 00:00:00\",\n \"unsub_time\": \"2022-08-25 21:34:25\",\n \"lastedit_time\": \"2022-08-25 21:32:56\",\n \"gender\": \"n\",\n \"source\": \"api\",\n \"device\": \"\",\n \"rating\": \"50\",\n \"region\": \"0\"\n },\n {\n \"id\": \"7\",\n \"list_id\": \"YOUR_ADDRESS_BASE_ID\",\n \"email\": \"UNSUBSCRIBED_USER_EMAIL_2\",\n \"state\": \"unsubscribed\",\n \"merge_1\": \"\",\n \"merge_2\": \"\",\n \"merge_3\": \"\",\n \"merge_4\": \"\",\n \"merge_5\": \"\",\n \"merge_6\": \"\",\n \"merge_7\": \"\",\n \"merge_8\": \"\",\n \"merge_9\": \"\",\n \"merge_10\": \"\",\n \"merge_11\": \"\",\n \"merge_12\": \"\",\n \"merge_13\": \"\",\n \"merge_14\": \"\",\n \"merge_15\": \"\",\n \"optin_time\": \"2022-08-17 13:41:41\",\n \"bounce_time\": \"0000-00-00 00:00:00\",\n \"unsub_time\": \"2022-08-25 21:34:25\",\n \"lastedit_time\": \"2022-08-25 21:33:23\",\n \"gender\": \"n\",\n \"source\": \"api\",\n \"device\": \"\",\n \"rating\": \"50\",\n \"region\": \"0\"\n },\n {\n \"id\": \"8\",\n \"list_id\": \"YOUR_ADDRESS_BASE_ID\",\n \"email\": \"UNSUBSCRIBED_USER_EMAIL_3\",\n \"state\": \"unsubscribed\",\n \"merge_1\": \"\",\n \"merge_2\": \"\",\n \"merge_3\": \"\",\n \"merge_4\": \"\",\n \"merge_5\": \"\",\n \"merge_6\": \"\",\n \"merge_7\": \"\",\n \"merge_8\": \"\",\n \"merge_9\": \"\",\n \"merge_10\": \"\",\n \"merge_11\": \"\",\n \"merge_12\": \"\",\n \"merge_13\": \"\",\n \"merge_14\": \"\",\n \"merge_15\": \"\",\n \"optin_time\": \"2022-08-17 14:07:38\",\n \"bounce_time\": \"0000-00-00 00:00:00\",\n \"unsub_time\": \"2022-08-25 21:34:25\",\n \"lastedit_time\": \"2022-08-25 21:34:12\",\n \"gender\": \"n\",\n \"source\": \"api\",\n \"device\": \"\",\n \"rating\": \"50\",\n \"region\": \"0\"\n }\n ]\n }\n}"}],"_postman_id":"4d756667-0036-4866-8a15-f8515d61355d"},{"name":"lists.upload","id":"1a490472-bec4-4534-8b3e-0f99706f16f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"file\": \"FILE_URL\",\r\n \"email\": 0,\r\n \"type\": \"FILE_EXTENSION\",\r\n \"merge_1\": 1,\r\n \"merge_2\": 2,\r\n \"merge_3\": 3,\r\n \"merge_4\": 4,\r\n \"merge_5\": 5,\r\n \"merge_6\": 6,\r\n \"merge_7\": 7,\r\n \"merge_8\": 8,\r\n \"merge_9\": 9,\r\n \"merge_10\": 10,\r\n \"gender\": n,\r\n \"update\": true,\r\n \"sheet_index\": 1,\r\n \"sheet_name\":\"name\",\r\n \"send_confirm\":true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.upload&list_id=YOUR_ADDRESS_BASE_ID","description":"

Импорт подписчиков из файла.

lists.upload(int list_id, string file, int email, int merge_1, int merge_2, int merge_3, int merge_4, int merge_5, int merge_6, int merge_7, int merge_8, int merge_9, int merge_10, enum gender, string type, string update, int sheet_index, string sheet_name, string send_confirm)

Импорт подписчиков из файла

Категория метода

Lists

Параметры

Наименование	Тип данных	Описание
list_id	int	id адресной базы
file	string	url импортируемого файла
email	int	номер столбца импортируемого файла, содержащего email (счет от 0)
merge_1	int	опционально - номер столбца дополнительного поля 1 (счет от 0; параметр обязателен, если поле является обязательным в базе)
merge_2	int	опционально - номер столбца дополнительного поля 2 (счет от 0; параметр обязателен, если поле является обязательным в базе)
merge_3	int	опционально - номер столбца дополнительного поля 3 (счет от 0; параметр обязателен, если поле является обязательным в базе)
merge_4	int	опционально - номер столбца дополнительного поля 4 (счет от 0; параметр обязателен, если поле является обязательным в базе)
merge_5	int	опционально - номер столбца дополнительного поля 5 (счет от 0; параметр обязателен, если поле является обязательным в базе)
merge_6	int	опционально - номер столбца дополнительного поля 6 (счет от 0; параметр обязателен, если поле является обязательным в базе)
merge_7	int	опционально - номер столбца дополнительного поля 7 (счет от 0; параметр обязателен, если поле является обязательным в базе)
merge_8	int	опционально - номер столбца дополнительного поля 8 (счет от 0; параметр обязателен, если поле является обязательным в базе)
merge_9	int	опционально - номер столбца дополнительного поля 9 (счет от 0; параметр обязателен, если поле является обязательным в базе)
merge_10	int	опционально - номер столбца дополнительного поля 10 (счет от 0; параметр обязателен, если поле является обязательным в базе)
gender	enum	опционально - пол подписчика, возможные значения: m - мужчина, f - женщина, n - неизвестно
type	string	расширение импортируемого файла (\"xls\",\"csv\",\"xlsx\",\"xml\",\"ods\",\"slk\",\"gnumeric\")
update	logical	опционально - обновлять существующие записи, если этот параметр задан (например, true)
sheet_index	int	опционально - номер листа в xls-книге (по умолчанию - первый)
sheet_name	string	опционально - название листа в xls-книге (по умолчанию - первый)
send_confirm	logical	опционально - отправлять письмо подтверждения, если этот параметр задан (например, true)
mode	string	опционально - сделать импорт в фоне, если mode=bg (при этом ответ будет быстрым \"Файл принят в обработку\". По окончании импорта вам придет вебхук, если задан параметр webhook
webhook	string	опционально - адрес, на который отправить вебхук по окончании фонового импорта Формат вебхука - $post['import_result'] = \"{'response': {'msg': {'err_code': 0, 'text': 'OK', 'type': 'message'}, 'data': {'task_id': '\".$params['task_id'].\"', 'text': '\".$answer['text'].\"', 'type': 'success', 'file_name': '\".$answer['file_name'].\"'}}}\" где task_id - произвольный id в вебхуке для его идентификации; answer['text'] - результат импорта

Возвращаемые значения (значения data)

\n","urlObject":{"protocol":"https","host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"lists.upload"},{"description":{"content":"

ID адресной базы

\n","type":"text/plain"},"key":"list_id","value":"YOUR_ADDRESS_BASE_ID"},{"disabled":true,"description":{"content":"

URL импортируемого файла

\n","type":"text/plain"},"key":"file","value":"FILE_URL"},{"disabled":true,"description":{"content":"

Номер столбца импортируемого файла, содержащего email (счет от 0)

\n","type":"text/plain"},"key":"email","value":"NUMBER"},{"disabled":true,"description":{"content":"

Расширение импортируемого файла

\n","type":"text/plain"},"key":"type","value":"FILE_EXTENSION"}],"variable":[]}},"response":[{"id":"af4122ee-5dd0-4055-bd2e-36b5e2207d33","name":"lists.upload example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"file\": \"FILE_URL\",\r\n \"email\": 0,\r\n \"type\": \"FILE_EXTENSION\",\r\n \"merge_1\": 1,\r\n \"merge_2\": 2,\r\n \"merge_3\": 3,\r\n \"merge_4\": 4,\r\n \"merge_5\": 5,\r\n \"merge_6\": 6,\r\n \"merge_7\": 7,\r\n \"merge_8\": 8,\r\n \"merge_9\": 9,\r\n \"merge_10\": 10,\r\n \"gender\": n,\r\n \"update\": true,\r\n \"sheet_index\": 1,\r\n \"sheet_name\":\"name\",\r\n \"send_confirm\":true\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.upload&list_id=YOUR_ADDRESS_BASE_ID&file=FILE_URL","protocol":"https","host":["api","dashamail","com"],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"lists.upload","description":"Используемый метод"},{"key":"list_id","value":"YOUR_ADDRESS_BASE_ID","description":"ID адресной базы"},{"key":"file","value":"FILE_URL","description":"URL импортируемого файла"},{"key":"email","value":"NUMBER","description":"Номер столбца импортируемого файла, содержащего email (счет от 0)","disabled":true},{"key":"type","value":"FILE_EXTENSION","description":"Расширение импортируемого файла","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Thu, 25 Aug 2022 19:20:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": {\n \"text\": \"Импортировано 1 получателей. Не прошло фильтры: 3 email. В черном списке: 0 email.\",\n \"type\": \"success\",\n \"file_name\": \"edit\"\n }\n }\n}"}],"_postman_id":"1a490472-bec4-4534-8b3e-0f99706f16f4"},{"name":"lists.add_member","id":"eb29418c-ccba-4213-9f11-e5da8160b4be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"list_id\":111,\r\n \"email\": \"email@mail.ru\",\r\n \"merge_1\": 1,\r\n \"merge_2\": 2,\r\n \"merge_3\": 3,\r\n \"merge_4\": 4,\r\n \"merge_5\": 5,\r\n \"merge_6\": 6,\r\n \"merge_7\": 7,\r\n \"merge_8\": 8,\r\n \"merge_9\": 9,\r\n \"merge_10\": 10,\r\n \"gender\": \"n\",\r\n \"update_tags\": \"on\",\r\n \"no_check\": \"ok\",\r\n \"state\":\"active\",\r\n \"send_confirm\":true,\r\n \"region\":98\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.add_member","description":"

Добавление подписчика в базу.

lists.add_member(int list_id, string email, string merge_1, string merge_2, string merge_3, string merge_4, string merge_5, string merge_6, string merge_7, string merge_8, string merge_9, string merge_10, enum gender, string update, string no_check, string state, string send_confirm)

Добавляем подписчика в базу

Категория метода

Lists

Параметры

Наименование	Тип данных	Описание
list_id	int	id адресной базы, в которую добавляется подписчик
email	string	email подписчика
merge_1	string	опционально - дополнительное поле 1
merge_2	string	опционально - дополнительное поле 2
merge_3	string	опционально - дополнительное поле 3
merge_4	string	опционально - дополнительное поле 4
merge_5	string	опционально - дополнительное поле 5
merge_6	string	опционально - дополнительное поле 6
merge_7	string	опционально - дополнительное поле 7
merge_8	string	опционально - дополнительное поле 8
merge_9	string	опционально - дополнительное поле 9
merge_10	string	опционально - дополнительное поле 10
gender	enum	опционально - пол подписчика, возможные значения: m - мужчина, f - женщина, n - неизвестно
update_tags	string	опционально: если параметр = on, то теги из запроса добавляются к текущим, если параметр = off – целиком заменяются
update	string	опционально - обновлять существующие записи, если этот параметр задан
no_check	string	опционально - не проверять валидность адреса, если этот параметр задан
state	string	опционально - статус подписчика, возможные значения: active – активен, inactive - неактивен. по-умолчанию: active
send_confirm	logical	опционально - отправлять письмо подтверждения, если этот параметр задан (например, true)
region	int	опционально - регион подписчика согласно кодам субъектов Российской Федерации, например, 77 – Москва

Возвращаемые значения (значения data)

Массив с данными:

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

Наименование	Тип данных	Описание
member_id	number	id добавленного подписчика
fixed_emails	array	информация об исправленном адресе: original: <первоначальный email> fixed: <исправленный email> \\ bounced

","urlObject":{"protocol":"https","host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"lists.add_member"},{"disabled":true,"description":{"content":"

ID адресной базы

\n","type":"text/plain"},"key":"list_id","value":"YOUR_ADDRESS_BASE_ID"},{"disabled":true,"description":{"content":"

Email подписчика

\n","type":"text/plain"},"key":"email","value":"USER_ID"}],"variable":[]}},"response":[{"id":"34766472-cd8c-4ada-a899-52f4b05d27b9","name":"lists.add_member example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"list_id\":111,\r\n \"email\": \"email@mail.ru\",\r\n \"merge_1\": 1,\r\n \"merge_2\": 2,\r\n \"merge_3\": 3,\r\n \"merge_4\": 4,\r\n \"merge_5\": 5,\r\n \"merge_6\": 6,\r\n \"merge_7\": 7,\r\n \"merge_8\": 8,\r\n \"merge_9\": 9,\r\n \"merge_10\": 10,\r\n \"gender\": \"n\",\r\n \"update_tags\": \"on\",\r\n \"no_check\": \"ok\",\r\n \"state\":\"active\",\r\n \"send_confirm\":true,\r\n \"region\":98\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.add_member&list_id=YOUR_ADDRESS_BASE_ID","protocol":"https","host":["api","dashamail","com"],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"lists.add_member","description":"Используемый метод"},{"key":"list_id","value":"YOUR_ADDRESS_BASE_ID","description":"ID адресной базы"},{"key":"email","value":"USER_ID","description":"Email подписчика","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Thu, 25 Aug 2022 19:38:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": {\n \"member_id\": 109,\n \"fixed_email\": false\n }\n }\n}"}],"_postman_id":"eb29418c-ccba-4213-9f11-e5da8160b4be"},{"name":"lists.add_member_batch","id":"f5bd656e-de19-4e9e-a668-5713beaeefde","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"list_id\": 888,\r\n \"batch\": [\r\n {\r\n \"email\": \"test1@dashamail.ru\",\r\n \"merge_1\": \"Ваня\",\r\n \"gender\": \"m\",\r\n \"region\": 17,\r\n \"state\": \"active\"\r\n },\r\n {\r\n \"email\": \"test2@inbox.ru\",\r\n \"merge_1\": \"Петя\",\r\n \"state\": \"inactive\"\r\n }\r\n ],\r\n \"update\": true,\r\n \"no_check\": true,\r\n \"send_confirm\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.add_member_batch","description":"

Добавление нескольких подписчиков в базу

lists.add_member_batch(int list_id, string batch, string update, string no_check, string send_confirm)

Добавляем несколько подписчиков в базу

Категория метода

Lists

Параметры

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

Наименование	Тип данных	Описание
list_id	int	id адресной базы, в которую добавляется подписчики
batch		JSON-массив добавляемых подписчиков: [{\"email\":\"test1@dashamail.ru\",\"merge_1\":\"Ваня\",\"gender\":\"m\",\"region\":17,\"state\":\"active\"},{\"email\":\"test2@inbox.ru\",\"merge_1\":\"Петя\",\"state\":\"inactive\"}]. Каждый JSON-объект подписчика может содержать следующие параметры: email (email-адрес подписчика), merge_xxx (значения дополнительных полей), state (active – активен, inactive - неактивен), gender (пол подписчика, возможные значения: m - мужчина, f - женщина, n - неизвестно), region (номер региона подписчика).
update	logical	опционально - обновлять существующие записи, если этот параметр задан
no_check	logical	опционально - не проверять валидность адреса, если этот параметр задан
send_confirm	logical	опционально - отправлять письмо подтверждения, если этот параметр задан (например, true)
background	logical	опционально - фоновое добавление, если этот параметр задан (не надо ждать полной загрузки, ответ API будет сразу, а загрузка - потом по мере возможности

Возвращаемые значения (значения data)

Массив с данными:

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

наименование	Тип данных	Описание
member_ids	number	id добавленных подписчиков через запятую
members	JSON	JSON-массив добавленных подписчиков вида содержащих соответствие id и email
fixed_emails	array	информация об исправленных адресах original: <первоначальный email> fixed: <исправленный email> \\ bounced
unsubscribed_emails	email	email уже отписанных подписчиков через запятую
unsubscribed_count	number	число уже отписанных подписчиков
bounced_emails	email	email неверных (ранее вернувшихся с жестким возвратом) подписчиков через запятую
bounced_count	number	число неверных (ранее вернувшихся с жестким возвратом) подписчиков
fake_emails	email	email подписчиков с одноразовыми email-адресами через запятую

","urlObject":{"protocol":"https","host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"lists.add_member_batch"}],"variable":[]}},"response":[{"id":"bb809e82-52b9-42a9-a7ac-fc38364e68f9","name":"lists.add_member_batch example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"list_id\":888,\r\n \"batch\":[\r\n {\"email\":\"test1@dashamail.ru\",\"merge_1\":\"Ваня\",\"gender\":\"m\",\"region\":17,\"state\":\"active\"},\r\n {\"email\":\"test2@inbox.ru\",\"merge_1\":\"Петя\",\"state\":\"inactive\"}],\r\n \"update\":true,\r\n \"no_check\":true,\r\n \"send_confirm\":true\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.add_member_batch","protocol":"https","host":["api","dashamail","com"],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"lists.add_member_batch","description":"Используемый метод"},{"key":"list_id","value":"YOUR_ADDRESS_BASE_ID","description":"ID адресной базы","disabled":true},{"key":"batch","value":"username@email.ru,fieldData1,fieldData2;username2@email.ru,fieldData1,fieldData2","description":"Строка подписчиков с разделителями ',' и ';'","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 07:11:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": {\n \"member_ids\": \"110,111\",\n \"members\": \"[{\\\"id\\\":USER_ID_1,\\\"email\\\":\\\"USERNAME_EMAIL_!\\\"},{\\\"id\\\":USER_ID_2,\\\"email\\\":\\\"USERNAME_EMAIL_2\\\"}]\",\n \"unsubscribed_count\": 0,\n \"unsubscribed_emails\": \"\",\n \"bounced_count\": 0,\n \"bounced_emails\": \"\",\n \"fake_count\": 0,\n \"fake_emails\": \"\",\n \"updated\": 0,\n \"fixed_emails\": []\n }\n }\n}"}],"_postman_id":"f5bd656e-de19-4e9e-a668-5713beaeefde"},{"name":"lists.move_member","id":"27d3d71d-9831-4fb0-ba84-d9489f155f8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.move_member","description":"

Перемещение подписчика в другую адресную базу.

lists.move_member (int member_id, int list_id)

Перемещаем подписчика в другую адресную базу

Категория метода

Lists

Параметры

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

Наименование	Тип данных	Описание
member_id	int	id отписываемого подписчика
list_id	int	id адресной базы в которую перемещаем подписчика

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"lists.move_member"},{"disabled":true,"description":{"content":"

ID перемещаемого подписчика

\n","type":"text/plain"},"key":"member_id","value":"MEMBERS_TO_MOVE_ID"},{"disabled":true,"description":{"content":"

ID адресной базы

\n","type":"text/plain"},"key":"list_id","value":"ADDRESS_BASE_ID"}],"variable":[]}},"response":[{"id":"0929ab08-cbc1-4eaa-844a-d57db2437b39","name":"lists.move_member example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.move_member&member_id=MEMBERS_TO_MOVE_ID&list_id=ADDRESS_BASE_ID","protocol":"https","host":["api","dashamail","com"],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"lists.move_member","description":"Используемый метод"},{"key":"member_id","value":"MEMBERS_TO_MOVE_ID","description":"ID перемещаемого подписчика"},{"key":"list_id","value":"ADDRESS_BASE_ID","description":"ID адресной базы"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 07:20:46 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"27d3d71d-9831-4fb0-ba84-d9489f155f8b"},{"name":"lists.copy_member","id":"ea72bd70-bbb1-4749-8999-0c8545530948","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.copy_member&member_id=MEMBER_TO_COPY_ID&list_id=INTO_ADDRESS_BASE_ID","description":"

Копирование подписчика в другую адресную базу.

lists.copy_member (int member_id, int list_id)

Копируем подписчика в другую адресную базу

Категория метода

Lists

Параметры

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

Наименование	Тип данных	Описание
member_id	int	id копируемого подписчика
list_id	int	id адресной базы в которую копируем подписчика

Возвращаемые значения (значения data)

copy_id: id подписчика-копии

\n","urlObject":{"protocol":"https","host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"lists.copy_member"},{"description":{"content":"

ID копируемого подписчика

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

ID адресной базы, в которую копируется подписчик

\n","type":"text/plain"},"key":"list_id","value":"INTO_ADDRESS_BASE_ID"}],"variable":[]}},"response":[{"id":"e4ed75d0-371b-4f86-a718-e3791edbd7a7","name":"lists.copy_member example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.copy_member&member_id=MEMBER_TO_COPY_ID&list_id=INTO_ADDRESS_BASE_ID","protocol":"https","host":["api","dashamail","com"],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"lists.copy_member","description":"Используемый метод"},{"key":"member_id","value":"MEMBER_TO_COPY_ID","description":"ID копируемого подписчика"},{"key":"list_id","value":"INTO_ADDRESS_BASE_ID","description":"ID адресной базы, в которую копируется подписчик"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 07:26:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": {\n \"copy_id\": \"COPIED_MEMBER_ID_(NUMBER)\"\n }\n }\n}"}],"_postman_id":"ea72bd70-bbb1-4749-8999-0c8545530948"},{"name":"lists.update_member","id":"7b841b3a-75ee-4d5a-a8f4-cbf2c8f9530a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"member_id\":444,\r\n \"email\":\"test1@dashamail.ru\",\r\n \"list_id\":555666,\r\n \"state\":\"active\",\r\n \"merge_1\":\"merge_1\",\r\n \"merge_2\":\"merge_2\",\r\n \"merge_3\":\"merge_3\",\r\n \"merge_4\":\"merge_4\",\r\n \"merge_5\":\"merge_5\",\r\n \"merge_6\":\"merge_6\",\r\n \"merge_7\":\"merge_7\",\r\n \"merge_8\":\"merge_8\",\r\n \"merge_9\":\"merge_9\",\r\n \"merge_10\":\"merge_10\",\r\n \"gender\":\"n\",\r\n \"region\":98,\r\n \"update_tags\":\"on\",\r\n \"source\":\"manual\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.update_member","description":"

Редактирование подписчика в базе

lists.update_member (int member_id, string email, int list_id, string merge_1, string merge_2, string merge_3, string merge_4, string merge_5, string merge_6, string merge_7, string merge_8, string merge_9, string merge_10, enum gender, int region)

Редактируем подписчика в базе

Категория метода

Lists

Параметры

Наименование	Тип данных	Описание
member_id	int	id подписчика [альтернативно email + list_id]
email	string	email подписчика совместно с list_id могут использоваться для выбора подписчика вместо member_id
list_id	int	list_id подписчика совместно с email могут использоваться для выбора подписчика вместо member_id
state	string	опционально: активировать подписчика - state=active, деактивировать - state=inaktive. параметр актуален только для тех клиентов, которым было выдано соответствующее разрешение в отделе тех.поддержки.
merge_1	string	опционально - дополнительное поле 1
merge_2	string	опционально - дополнительное поле 2
merge_3	string	опционально - дополнительное поле 3
merge_4	string	опционально - дополнительное поле 4
merge_5	string	опционально - дополнительное поле 5
merge_6	string	опционально - дополнительное поле 6
merge_7	string	опционально - дополнительное поле 7
merge_8	string	опционально - дополнительное поле 8
merge_9	string	опционально - дополнительное поле 9
merge_10	string	опционально - дополнительное поле 10
gender	enum	опционально - пол подписчика, возможные значения: m - мужчина, f - женщина, n - неизвестно
region	int	опционально - регион подписчика согласно кодам субъектов Российской Федерации, например, 77 – Москва
update_tags	string	опционально - если параметр = on, то теги из запроса добавляются к текущим, в противном случае – целиком заменяются
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'

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"lists.update_member"},{"disabled":true,"description":{"content":"

ID подписчика

\n","type":"text/plain"},"key":"member_id","value":"MEMBER_TO_UPDATE_ID"},{"disabled":true,"description":{"content":"

Дополнительное поле (опционально)

\n","type":"text/plain"},"key":"merge_1","value":"ADDITIONAL_FIELD_FOR_UPDATE"}],"variable":[]}},"response":[{"id":"3132d51c-d291-403a-9432-d4ffd244004b","name":"lists.update_member example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"member_id\":444,\r\n \"email\":\"test1@dashamail.ru\",\r\n \"list_id\":555666,\r\n \"state\":\"active\",\r\n \"merge_1\":\"merge_1\",\r\n \"merge_2\":\"merge_2\",\r\n \"merge_3\":\"merge_3\",\r\n \"merge_4\":\"merge_4\",\r\n \"merge_5\":\"merge_5\",\r\n \"merge_6\":\"merge_6\",\r\n \"merge_7\":\"merge_7\",\r\n \"merge_8\":\"merge_8\",\r\n \"merge_9\":\"merge_9\",\r\n \"merge_10\":\"merge_10\",\r\n \"gender\":\"n\",\r\n \"region\":98,\r\n \"update_tags\":\"on\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.update_member","protocol":"https","host":["api","dashamail","com"],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"lists.update_member","description":"Используемый метод"},{"key":"member_id","value":"MEMBER_TO_UPDATE_ID","description":"ID подписчика","disabled":true},{"key":"merge_1","value":"ADDITIONAL_FIELD_FOR_UPDATE","description":"Дополнительное поле (опционально)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 07:35:43 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"7b841b3a-75ee-4d5a-a8f4-cbf2c8f9530a"},{"name":"lists.delete_member","id":"0eb6e5ba-912c-4149-9fdd-a311b1d4f625","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.delete_member&member_id=MEMBER_FOR_DELETE_ID","description":"

Удаление подписчика из базы

lists.delete_member(int member_id)

Удаляем подписчика из базы

Категория метода

Lists

Параметры

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

Наименование	Тип данных	Описание
member_id	int	id удаляемого подписчика

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"lists.delete_member"},{"description":{"content":"

ID удаляемого подписчика

\n","type":"text/plain"},"key":"member_id","value":"MEMBER_FOR_DELETE_ID"}],"variable":[]}},"response":[{"id":"2468340b-350a-4b72-a07f-a20ee4eb449a","name":"lists.delete_member example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.delete_member&member_id=MEMBER_FOR_DELETE_ID","protocol":"https","host":["api","dashamail","com"],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"lists.delete_member","description":"Используемый метод"},{"key":"member_id","value":"MEMBER_FOR_DELETE_ID","description":"ID удаляемого подписчика"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 07:39:11 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"0eb6e5ba-912c-4149-9fdd-a311b1d4f625"},{"name":"lists.unsubscribe_member","id":"fa6d1294-0067-4bb9-b5d7-8ef38f44a358","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.unsubscribe_member&member_id=MEMBER_FOR_UNSUBSCRIBE_ID&email=UNSUBSCRIBE_USER@EMAIL.RU&list_id=YOUR_LIST_ID","description":"

Отписка подписчика из базы

lists.unsubscribe_member (int member_id, string email, string list_id)

Отписываем подписчика из базы

Категория метода

Lists

Параметры

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

Наименование	Тип данных	Описание
member_id	int	опционально - id отписываемого подписчика
email	string	опционально - email отписываемого подписчика
list_id	string	опционально - адресная база, из которой надо отписать подписчика. если не задано - отписывается из всевозможных баз

Возвращаемые значения (значения data)

unsubscribed: количество отписанных подписчиков (может быть больше 1, если подписчик был отписан из нескольких баз)

\n","urlObject":{"protocol":"https","host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"lists.unsubscribe_member"},{"description":{"content":"

ID отписываемого подписчика

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

Email отписываемого подписчика (опционально)

\n","type":"text/plain"},"key":"email","value":"UNSUBSCRIBE_USER@EMAIL.RU"},{"description":{"content":"

ID адресной базы, из которой будет отписан подписчик

\n","type":"text/plain"},"key":"list_id","value":"YOUR_LIST_ID"}],"variable":[]}},"response":[{"id":"c5e5e78c-37d2-4b3b-b91b-855d9c85ea04","name":"lists.unsubscribe_member example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.unsubscribe_member&member_id=MEMBER_FOR_UNSUBSCRIBE_ID&email=UNSUBSCRIBE_USER@EMAIL.RU&list_id=YOUR_LIST_ID","protocol":"https","host":["api","dashamail","com"],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"lists.unsubscribe_member","description":"Используемый метод"},{"key":"member_id","value":"MEMBER_FOR_UNSUBSCRIBE_ID","description":"ID отписываемого подписчика"},{"key":"email","value":"UNSUBSCRIBE_USER@EMAIL.RU","description":"Email отписываемого подписчика (опционально)"},{"key":"list_id","value":"YOUR_LIST_ID","description":"ID адресной базы, из которой будет отписан подписчик"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 07:44:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": {\n \"unsubscribed\": \"NUMBER_OF_UNSUBSCRIBED_MEMBERS_(NUMBER)\"\n }\n }\n}"}],"_postman_id":"fa6d1294-0067-4bb9-b5d7-8ef38f44a358"}],"id":"31fcce84-ce02-422e-a281-49478fbbe3e5","description":"

Манипуляции с подписчиками.

\n","_postman_id":"31fcce84-ce02-422e-a281-49478fbbe3e5"},{"name":"Доп. поля","item":[{"name":"lists.add_merge","id":"8176fb89-cbdf-458e-9ede-83a43cdadbff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"list_id\": 555,\r\n \"type\": \"choice\",\r\n \"choices\": [\r\n \"var1\",\r\n \"var2\",\r\n \"var3\"\r\n ],\r\n \"title\": \"name\",\r\n \"req\": \"on\",\r\n \"var\": \"ШАБЛОН1\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.add_merge","description":"

Добавление дополнительного поля в адресную базу.

lists.add_merge (int list_id, string type, serialized array/JSON choices, string title, string req, string var)

Добавить дополнительное поле в адресную базу

Категория метода

Lists

Параметры

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

Наименование	Тип данных	Описание
list_id	int	id адресной базы
type	string	string тип поля. возможные значения: text, date, choice.
choices	serialized array/JSON	сериализированный массив элементов списка. Также может быть в формате JSON. Обязателен, если type = choice
title	string	опционально - название поля
req	string	опционально - обязательно ли поле. возможные значения: on, off
var	string	опционально - название шаблона. Рекомендуем использовать заглавные буквы, например, ШАБЛОН

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"lists.add_merge"},{"disabled":true,"description":{"content":"

ID адресной базы

\n","type":"text/plain"},"key":"list_id","value":"YOUR_LIST_ID"},{"disabled":true,"description":{"content":"

Тип поля

\n","type":"text/plain"},"key":"type","value":"ADDITIONAL_FIELD_TYPE"},{"disabled":true,"description":{"content":"

Название поля (опционально)

\n","type":"text/plain"},"key":"title","value":"ADDITIONAL_FIELD_NAME"},{"disabled":true,"description":{"content":"

Обязательно ли поле (опционально)

\n","type":"text/plain"},"key":"req","value":"ON-OFF"},{"disabled":true,"description":{"content":"

Название шаблона (опционально)

\n","type":"text/plain"},"key":"var","value":"ADDITIONALFIELD"}],"variable":[]}},"response":[{"id":"18f0ece9-7e51-412c-829e-8c12b4267c59","name":"lists.add_merge example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"list_id\": 555,\r\n \"type\": \"choice\",\r\n \"choices\": [\r\n \"var1\",\r\n \"var2\",\r\n \"var3\"\r\n ],\r\n \"title\": \"name\",\r\n \"req\": \"on\",\r\n \"var\": \"ШАБЛОН1\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.add_merge","protocol":"https","host":["api","dashamail","com"],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"lists.add_merge","description":"Используемый метод"},{"key":"list_id","value":"YOUR_LIST_ID","description":"ID адресной базы","disabled":true},{"key":"type","value":"ADDITIONAL_FIELD_TYPE","description":"Тип поля","disabled":true},{"key":"title","value":"ADDITIONAL_FIELD_NAME","description":"Название поля (опционально)","disabled":true},{"key":"req","value":"ON-OFF","description":"Обязательно ли поле (опционально)","disabled":true},{"key":"var","value":"ADDITIONALFIELD","description":"Название шаблона (опционально)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 07:55:54 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"8176fb89-cbdf-458e-9ede-83a43cdadbff"},{"name":"lists.update_merge","id":"b8622b43-243d-4847-9b89-777a7df124d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"list_id\": 555,\r\n \"merge_id\":3,\r\n \"type\": \"choice\",\r\n \"choices\": [\r\n \"var1\",\r\n \"var2\",\r\n \"var3\"\r\n ],\r\n \"title\": \"name\",\r\n \"req\": \"on\",\r\n \"var\": \"ШАБЛОН1\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.update_merge","description":"

Обновление настройки дополнительного поля в адресной базе.

lists.update_merge (int list_id, int merge_id, string type, serialized array/JSON choices, string title, string req, string var)

Обновить настройки дополнительного поля в адресной базе

Категория метода

Lists

Параметры

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

Наименование	Тип данных	Описание
list_id	int	id адресной базы
merge_id	int	номер дополнительного поля. возможные значения: от 1 до 10
type	string	string тип поля. возможные значения: text, date, choice.
choices	serialized array/JSON	опционально - сериализированный массив элементов списка. Также может быть в формате JSON. Обязателен, если type = choice
title	string	опционально - название поля
req	string	опционально - обязательно ли поле. возможные значения: on, off
var	string	опционально - название шаблона. Рекомендуем использовать заглавные буквы, например, %ШАБЛОН%

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"lists.update_merge"},{"disabled":true,"description":{"content":"

ID адресной базы

\n","type":"text/plain"},"key":"list_id","value":"ADDRESS_BASE_ID"},{"disabled":true,"description":{"content":"

Номер дополнительного поля: от 1 до 10

\n","type":"text/plain"},"key":"merge_id","value":"MERGE_FOR_UPDATE_ID"},{"disabled":true,"description":{"content":"

Название поля (опционально)

\n","type":"text/plain"},"key":"title","value":"ADDITIONAL_FIELD_NAME"},{"disabled":true,"description":{"content":"

Обязательно ли поле (опционально)

\n","type":"text/plain"},"key":"req","value":"ON-OFF"},{"disabled":true,"description":{"content":"

Название шаблона (опционально)

\n","type":"text/plain"},"key":"var","value":"NEWADDITIONALFIELD"},{"disabled":true,"description":{"content":"

Тип поля

\n","type":"text/plain"},"key":"type","value":"ADDITIONAL_FIELD_TYPE"}],"variable":[]}},"response":[{"id":"7861a84a-50db-451f-b8b1-ae30122e5f57","name":"lists.update_merge example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"list_id\": 555,\r\n \"merge_id\":3,\r\n \"type\": \"choice\",\r\n \"choices\": [\r\n \"var1\",\r\n \"var2\",\r\n \"var3\"\r\n ],\r\n \"title\": \"name\",\r\n \"req\": \"on\",\r\n \"var\": \"ШАБЛОН1\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.update_merge","protocol":"https","host":["api","dashamail","com"],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"lists.update_merge","description":"Используемый метод"},{"key":"list_id","value":"ADDRESS_BASE_ID","description":"ID адресной базы","disabled":true},{"key":"merge_id","value":"MERGE_FOR_UPDATE_ID","description":"Номер дополнительного поля: от 1 до 10","disabled":true},{"key":"title","value":"ADDITIONAL_FIELD_NAME","description":"Название поля (опционально)","disabled":true},{"key":"req","value":"ON-OFF","description":"Обязательно ли поле (опционально)","disabled":true},{"key":"var","value":"NEWADDITIONALFIELD","description":"Название шаблона (опционально)","disabled":true},{"key":"type","value":"ADDITIONAL_FIELD_TYPE","description":"Тип поля","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 08:14:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"b8622b43-243d-4847-9b89-777a7df124d0"},{"name":"lists.delete_merge","id":"eba14336-3f2e-43f4-a99a-2886f12954a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.delete_merge&list_id=ADDRESS_BASE_ID&merge_id=MERGE_FOR_DELETE_ID","description":"

Удаление дополнительных полей из адресной базы

lists.delete_merge (int list_id, int merge_id)

Удалить дополнительное поле из адресной базы

Категория метода

Lists

Параметры

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

Наименование	Тип данных	Описание
list_id	int	id адресной базы
merge_id	int	номер дополнительного поля. возможные значения: от 1 до 10

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"lists.delete_merge"},{"description":{"content":"

ID адресной базы

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

Номер дополнительного поля: от 1 до 10

\n","type":"text/plain"},"key":"merge_id","value":"MERGE_FOR_DELETE_ID"}],"variable":[]}},"response":[{"id":"0ff73185-8c05-4587-abe5-90fed92c5034","name":"lists.delete_merge example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.delete_merge&list_id=ADDRESS_BASE_ID&merge_id=MERGE_FOR_DELETE_ID","protocol":"https","host":["api","dashamail","com"],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"lists.delete_merge","description":"Используемый метод"},{"key":"list_id","value":"ADDRESS_BASE_ID","description":"ID адресной базы"},{"key":"merge_id","value":"MERGE_FOR_DELETE_ID","description":"Номер дополнительного поля: от 1 до 10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 08:18:39 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"eba14336-3f2e-43f4-a99a-2886f12954a4"}],"id":"717d7294-8c1a-4f74-a091-d6de24edf5b2","description":"

Манипуляции с дополнительными полями адресной базы.

\n","_postman_id":"717d7294-8c1a-4f74-a091-d6de24edf5b2"},{"name":"lists.last_status","id":"e8406ea8-d26d-4b46-aac2-29702554965d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.last_status&email=USER_EMAIL&list_id=ADDRESS_BASE_ID","description":"

Получение статуса конкретного email-адреса.

lists.last_status (string email, int list_id)

Получить последний статус конкретного email в адресных базах

Категория метода

Lists

Параметры

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

Наименование	Тип данных	Описание
email	string	email-адрес подписчика
list_id	int	опционально - id адресной базы

Возвращаемые значения (значения data)

Массив подписчиков с параметрами:

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

Наименование	Тип данных	Описание
status	text	unsubscribed/bounced/clicked/opened/delivered
date	datetime	время в формате datetime данного события

","urlObject":{"protocol":"https","host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"lists.last_status"},{"description":{"content":"

Email подписчика

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

ID адресной базы (опционально)

\n","type":"text/plain"},"key":"list_id","value":"ADDRESS_BASE_ID"}],"variable":[]}},"response":[{"id":"216ce627-664d-46fc-a8c3-663a4ba0758d","name":"lists.last_status example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.last_status&email=USER_EMAIL&list_id=ADDRESS_BASE_ID","protocol":"https","host":["api","dashamail","com"],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"lists.last_status","description":"Используемый метод"},{"key":"email","value":"USER_EMAIL","description":"Email подписчика"},{"key":"list_id","value":"ADDRESS_BASE_ID","description":"ID адресной базы (опционально)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 08:24:51 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": {\n \"status\": \"clicked\",\n \"date\": \"0000-00-00 00:00:00\"\n }\n }\n}"}],"_postman_id":"e8406ea8-d26d-4b46-aac2-29702554965d"},{"name":"lists.get_import_history","id":"6a1b5218-d391-4332-9868-c36769bca921","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.get_import_history&list_id=ADDRESS_BASE_ID","description":"

Получение истории и результатов импорта адресной базы.

lists.get_import_history (int list_id)

Получить историю и результаты импорта адресной базы

Категория метода

Lists

Параметры

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

Наименование	Тип данных	Описание
list_id	int опционально - id адресной базы

Возвращаемые значения (значения data)

Массив результатов импортов с параметрами:

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

Наименование	Тип данных	Описание
id	number	id импорта
list_id	number	id адресной базы
username	text	имя пользователя, производившего импорт
message	text	результат импорта с ссылками на не прошедших фильтры, отписавшихся, в черном списке, список возвратов
type	text	{success,errors,in_progress}
file_name	text	имя импортируемого файла
time	time	время запуска импорта

","urlObject":{"protocol":"https","host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"lists.get_import_history"},{"description":{"content":"

ID адресной базы

\n","type":"text/plain"},"key":"list_id","value":"ADDRESS_BASE_ID"}],"variable":[]}},"response":[{"id":"7c482069-0cea-4bda-a8d5-672365b42da3","name":"lists.get_import_history example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.get_import_history&list_id=ADDRESS_BASE_ID","protocol":"https","host":["api","dashamail","com"],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"lists.get_import_history","description":"Используемый метод"},{"key":"list_id","value":"ADDRESS_BASE_ID","description":"ID адресной базы"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 10:37:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"id\": \"202247\",\n \"list_id\": \"102712\",\n \"username\": \"dbog@a25.ru\",\n \"message\": \"Импортировано 1 получателей. Не прошло фильтры: 3 email. В черном списке: 0 email.\",\n \"type\": \"success\",\n \"file_name\": \"edit\",\n \"time\": \"2022-08-25 22:20:35\"\n },\n {\n \"id\": \"202246\",\n \"list_id\": \"102712\",\n \"username\": \"dbog@a25.ru\",\n \"message\": \"Нет корректных получателей для импорта в эту базу. Не прошло фильтры: 2 email. В черном списке: 0 email.\",\n \"type\": \"errors\",\n \"file_name\": \"edit\",\n \"time\": \"2022-08-25 22:20:23\"\n },\n {\n \"id\": \"202245\",\n \"list_id\": \"102712\",\n \"username\": \"dbog@a25.ru\",\n \"message\": \"Нет корректных получателей для импорта в эту базу. Не прошло фильтры: 3 email. В черном списке: 0 email.\",\n \"type\": \"errors\",\n \"file_name\": \"edit\",\n \"time\": \"2022-08-25 22:20:13\"\n },\n {\n \"id\": \"202244\",\n \"list_id\": \"102712\",\n \"username\": \"dbog@a25.ru\",\n \"message\": \"Нет корректных получателей для импорта в эту базу. Не прошло фильтры: 3 email. В черном списке: 0 email.\",\n \"type\": \"errors\",\n \"file_name\": \"edit\",\n \"time\": \"2022-08-25 22:19:22\"\n },\n {\n \"id\": \"202243\",\n \"list_id\": \"102712\",\n \"username\": \"dbog@a25.ru\",\n \"message\": \"Нет корректных получателей для импорта в эту базу. Не прошло фильтры: 4 email. В черном списке: 0 email.\",\n \"type\": \"errors\",\n \"file_name\": \"edit\",\n \"time\": \"2022-08-25 22:18:10\"\n }\n ]\n }\n}"}],"_postman_id":"6a1b5218-d391-4332-9868-c36769bca921"},{"name":"lists.check_email","id":"4bab85b1-a21f-4f8c-b5e8-56dfae02004f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.check_email&email=EMAIL_FOR_CHECK&list_id=YOUR_ADDRESS_BASE_ID","description":"

Проверка валидности email-адреса.

lists.check_email (string email, int list_id)

Проверяет email-адрес на валидность и наличие в черных списках или статусе отписки

Категория метода

Lists

Параметры

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

Наименование	Тип данных	Описание
email	string	email-адрес для проверки
list_id	int	опционально - id адресной базы для проверки факта отписки

Возвращаемые значения (значения data)

valid: валидный исправленный email-адрес

\n","urlObject":{"protocol":"https","host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"lists.check_email"},{"description":{"content":"

Email-адрес для проверки

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

ID адресной базы для проверки факта отписки(опционально)

\n","type":"text/plain"},"key":"list_id","value":"YOUR_ADDRESS_BASE_ID"}],"variable":[]}},"response":[{"id":"c7aafcb2-cd7b-4fbe-a2d8-87ae2b95e4fe","name":"lists.check_email example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com?api_key=YOUR_API_KEY&method=lists.check_email&email=EMAIL_FOR_CHECK&list_id=YOUR_ADDRESS_BASE_ID","protocol":"https","host":["api","dashamail","com"],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"lists.check_email","description":"Используемый метод"},{"key":"email","value":"EMAIL_FOR_CHECK","description":"Email-адрес для проверки"},{"key":"list_id","value":"YOUR_ADDRESS_BASE_ID","description":"ID адресной базы для проверки факта отписки(опционально)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 10:46:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": {\n \"valid\": \"CHECKED_EMAIL\"\n }\n }\n}"}],"_postman_id":"4bab85b1-a21f-4f8c-b5e8-56dfae02004f"}],"id":"905176fa-f91d-4739-a9bf-6444c66c31d2","event":[{"listen":"prerequest","script":{"id":"765c05d1-8d42-4388-a377-3a0cfb3fc206","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5d549124-842d-4c79-9f3e-4785a835087c","type":"text/javascript","exec":[""]}}],"_postman_id":"905176fa-f91d-4739-a9bf-6444c66c31d2","description":""},{"name":"Campaigns","item":[{"name":"campaigns.get","id":"63a3916f-34b3-4e28-860c-41dacede97fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.get&campaign_id=YOUR_CAMPAIGN_ID","description":"

Получение списка рассылок пользователя.

campaigns.get(int campaign, string external_campaign_id, string status, int list_id, date start, date end , string type, int limit)

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

Категория метода

Campaigns

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	опционально - id запрашиваемой рассылки
workflow	int	опционально - id автоматизации. передается вместо ID запрашиваемой рассылки для получения списка всех писем автоматизации
member_id	int	опционально - в случае передачи в даннном параметре id подписчика вместе с campaign_id в результатах текстовой версии (plain_text) и html будут подставлены все теги персонализации, а также динамический контент для данного подписчика
external_campaign_id	string	опционально - внешний id запрашиваемой рассылки
status	string	опционально - {DRAFT, SCHEDULE, MODERATING, CREATED, PROCESSING, SENT, BLOCKED, SUBSCRIBE, BLOCKED-SPAM, NEED-FIX} - статус рассылки
list_id	int	опционально - фильтр рассылок по адресным базам
start	date	опционально - фильтр рассылок по времени, начальная дата, формат: YYYY-MM-DD
end	date	опционально - фильтр рассылок по времени, конечная дата, формат: YYYY-MM-DD
type	string	опционально - {online_builder, html} - тип кампании (онлайн-редактор, html-шаблон)
limit	int	опционально - количество записей для вывода. по-умолчанию: без ограничений

Возвращаемые значения (значения data)

array Массив рассылок с параметрами

Наименование	Тип данных	Описание
id	number	id рассылки
external_campaign_id	number	внешний id рассылки
channel	string	канал рассылки. возможные значения: email, sms, viber, whatsapp, telegram, notify, push, webpush
type	string	тип рассылки. возможные значения: online_builder, html
status	string	{DRAFT, SCHEDULE, MODERATING, CREATED, PROCESSING, SENT, BLOCKED} - статус рассылки
name	string	название рассылки
list_id	number	id адресной базы, по которой была отправлена рассылка
subject	string	заголовок письма
from_name	string	от кого письмо
from_email	string	обратный адрес
personalizeToEmail	string	{on/off} - включить/выключить персонализацию в поле \"Кому:\"
to_email	string; tag	персонализация в поле \"Кому:\" [можно использовать %ТЭГИ% из дополнительных полей базы, например %EMAIL%]
track_opens	string	{Y,N} - следить за открыванием
track_clicks	string	{Y,N} - отслеживать клики
plain_clicks	string	{Y,N} - отслеживать клики в текстовой версии
analytics	string	{google,N} - добавить Google Analytics™ для отслеживания всех URLs
analytics_tag	string	текстовый тег utm_campaign для отображения кликов в Google Analytics™
analytics_source	string	utm_source для отображения кликов в Google Analytics™
analytics_medium	string	utm_medium для отображения кликов в Google Analytics™
analytics_content	string	utm_content для отображения кликов в Google Analytics™
analytics_term	string	utm_term для отображения кликов в Google Analytics™
html	код-html	код html-версии письма
plain_text	string	текстовая версия письма
delivery_time	datetime	время отправки письма
auto	number	статус для авторассылки (0 - не активна, 1 - активна, 2 - в архиве)
limit	number	лимит отправки писем на рассылку или, в случае задания wait_time для плавной отправки, на временной период
wait_time	number	временной период в секундах для ожидания перед отправкой следующей части отправкой частями
allow_time_zone	string	{Y,N} - учитывать локальное время подписчика при запланированной на определенное время отправке
allow_best_time	string	{Y,N} - оптимизировать время получения письма, функция \"лучшее время доставки\"
emails_sent	int	общее число отправленных писем в рамках этой рассылки

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"campaigns.get"},{"description":{"content":"

ID запрашиваемой рассылки (опционально)

\n","type":"text/plain"},"key":"campaign_id","value":"YOUR_CAMPAIGN_ID"},{"disabled":true,"description":{"content":"

ID автоматизации (опционально)

\n","type":"text/plain"},"key":"workflow","value":"YOUR_AUTOMATISATION_ID"}],"variable":[]}},"response":[{"id":"351749ac-9b24-4d97-a26c-b9bdfa2dc865","name":"campaigns.get example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.get&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"campaigns.get","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID запрашиваемой рассылки (опционально)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 11:00:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"id\": \"YOUR_CAMPAIGN_ID\",\n \"type\": \"plain_text\",\n \"status\": \"DRAFT\",\n \"external_campaign_id\": \"\",\n \"channel\": \"email\",\n \"name\": \"YOUR_CAMPAIGN_NAME\",\n \"list_id\": \"a:1:{i:0;i:ADDRESS_BASE_ID;}\",\n \"subject\": \"LETTER_HEADER\",\n \"from_name\": \"MAIL_FROM\",\n \"from_email\": \"REPLY_EMAIL_ADDRESS\",\n \"replyto_add\": \"1\",\n \"replyto_name\": \"NAME\",\n \"replyto_email\": \"EMAIL\",\n \"personalizeToEmail\": \"off\",\n \"to_email\": \"\",\n \"track_opens\": \"Y\",\n \"track_clicks\": \"Y\",\n \"plain_clicks\": \"N\",\n \"analytics\": \"N\",\n \"analytics_tag\": \"\",\n \"analytics_split\": \"0\",\n \"analytics_source\": \"Dashamail\",\n \"analytics_medium\": \"email\",\n \"analytics_content\": \"\",\n \"analytics_term\": \"\",\n \"analytics_track\": \"0\",\n \"social\": \"off\",\n \"no_images_add\": \"0\",\n \"no_plain_text\": \"0\",\n \"WYSIWYG\": \"0\",\n \"creation_time\": \"0000-00-00 00:00:00\",\n \"delivery_time\": \"0000-00-00 00:00:00\",\n \"allow_time_zone\": \"0\",\n \"allow_best_time\": \"0\",\n \"ds_task_id\": \"0\",\n \"ds_sent\": \"0\",\n \"esegment\": \"SEGMENT_DATA\",\n \"sqleseg\": \"SQL_REQ_SEGMENT_DATA\",\n \"relay_id\": \"0\",\n \"problems\": \"\",\n \"style\": \"1\",\n \"order\": \"\",\n \"header\": \"0\",\n \"footer\": \"0\",\n \"limit\": \"0\",\n \"split\": \"\",\n \"split_cond\": \"0\",\n \"split_excluded\": \"0\",\n \"split_subject\": \"0\",\n \"split_from\": \"0\",\n \"split_html\": \"0\",\n \"split_time\": \"0\",\n \"time_window\": \"0\",\n \"spamtests\": \"0\",\n \"auto\": \"0\",\n \"emails_to_send\": \"1\",\n \"elapsed_time\": \"0\",\n \"email_size\": \"0\",\n \"show_preview\": \"1\",\n \"show_abstract\": \"1\",\n \"abstract\": \"\",\n \"show_provider\": \"1\",\n \"emails_sent\": \"0\",\n \"lang\": \"ru\",\n \"block_reason\": \"0\",\n \"archived\": \"0\",\n \"omnidesk_case\": \"\",\n \"paused_compensation\": \"0\",\n \"plain_text_links\": \"1\",\n \"last_edit_time\": \"2022-08-22 12:46:01\",\n \"workflow\": \"0\",\n \"abandoned\": \"0\",\n \"folder_id\": \"0\",\n \"wait_time\": \"86400\",\n \"stat_domain\": \"0\",\n \"resend_id\": \"0\",\n \"resend_schedule\": \"off\",\n \"resend_subject\": \"\",\n \"resend_time_num\": \"24\",\n \"resend_time_delay\": \"3600\",\n \"nch\": \"0\",\n \"speed\": \"0\",\n \"delivery_policy\": \"0\",\n \"delivery_policy_time\": \"0000-00-00 00:00:00\",\n \"session_id\": \"896\",\n \"session_update\": \"1660903554\",\n \"annotation\": \"\",\n \"html\": \"

\\r\\n\\tПривет!

\\r\\n

\\r\\n\\tЭто наш новый, расширенный текстовый редактор.

\\r\\n

\\r\\n\\tДобавьте какой-нибудь текст сюда.

\\r\\n

\\r\\n\\t

\\r\\n

\\r\\n\\tА25 | Санкт-Петербург,

\\r\\n

\\r\\n\\tВы получили это письмо, потому что: | Отписаться

\\r\\n\",\n \"css\": \"\",\n \"plain_text\": \"Привет!\\n\\nЭто наш новый, расширенный текстовый редактор.\\n\\nДобавьте какой-нибудь текст сюда.\\n\\n \\n\\n-------------------------\\n\\nА25 | Санкт-Петербург,\\n\\nВы получили это письмо, потому что: | Отписаться [%ОТПИСАТЬСЯ%/]\\n\"\n }\n ]\n }\n}"}],"_postman_id":"63a3916f-34b3-4e28-860c-41dacede97fe"},{"name":"campaigns.get_automations","id":"a593492a-6122-48de-9e62-5fb654ddabef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&campaign_id=YOUR_CAMPAIGN_ID&method=campaigns.get_automations","description":"

Получение списка всех автоматизаций и потоков пользователя.

campaigns.get_automations (int campaign_id)

Получаем список всех автоматизаций и потоков пользователя

Категория метода

Campaigns

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	опционально - id запрашиваемой автоматизации или потока

Возвращаемые значения (значения data)

array Массив автоматизаций с параметрами

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

Наименование	Тип данных	Описание
id	int	id автоматизации или потока
type	string	тип авторассылки. возможные значения: automation (автоматизация) или workflow (поток старого типа)
name	string	название автоматизации
last_edit_time	datetime	время последнего редактирования
priority	number	приорити (0 - нормаьлный, 1 - высокий, 2 - критический)

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

ID запрашиваемой автоматизации или потока (опционально)

\n","type":"text/plain"},"key":"campaign_id","value":"YOUR_CAMPAIGN_ID"},{"key":"method","value":"campaigns.get_automations"}],"variable":[]}},"response":[{"id":"cf7d87f3-481d-439a-8a4c-add7d4424cbf","name":"campaigns.get example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.get_automations&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"campaigns.get_automations","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID запрашиваемой автоматизации или потока (опционально)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 11:00:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"id\": \"YOUR_CAMPAIGN_ID\",\n \"name\": \"YOUR_CAMPAIGN_NAME\",\n \"last_edit_time\": \"0000-00-00 00:00:00\",\n \"priority\": 0,\n \"type\": \"automation/workflow\"\n }\n ]\n }\n}"}],"_postman_id":"a593492a-6122-48de-9e62-5fb654ddabef"},{"name":"campaigns.create","id":"f75e63ae-e14e-4db5-8d9c-ca45ab149681","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"list_id\": [\r\n {\r\n \"0\": 11111\r\n },\r\n {\r\n \"1\": 22222\r\n },\r\n {\r\n \"2\": 333333\r\n }\r\n ],\r\n \"name\": \"Праздничная\",\r\n \"status\": \"DRAFT\",\r\n \"subject\": \"С праздником\",\r\n \"from_name\": \"ООО Рога и Копыта\",\r\n \"personalizeToEmail\": \"on\",\r\n \"to_email\": \"email@email.ru\",\r\n \"track_opens\": \"Y\",\r\n \"track_clicks\": \"Y\",\r\n \"plain_clicks\": \"Y\",\r\n \"no_images_add\": \"0\",\r\n \"analytics\": \"N\",\r\n \"analytics_tag\": \"Рассылка1256_2024\",\r\n \"html\": \"<\\/head><\\/body><\\/html>\",\r\n \"esegment\": {\"22222\":\r\n {\r\n \"match\": \"any\",\r\n \"c\": [\r\n {\r\n \"field\": \"email\",\r\n \"op\": \"is\",\r\n \"value\": \"test@bk.ru\"\r\n }\r\n ]\r\n }\r\n },\r\n \"channel\": \"email\",\r\n \"limit\": 2000,\r\n \"wait_time\": 3600,\r\n \"allow_time_zone\": \"Y\",\r\n \"allow_best_time\": \"Y\",\r\n \"stat_domain\": \"statistics domain\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.create","description":"

Создание новой рассылки.

campaigns.create (serialized array list_id, string name, string status, string subject, string from_name, string from_email, string personalizeToEmail, string to_email, string track_opens, string track_clicks, string plain_clicks, string no_images_add, string analytics, string analytics_tag, string html, string plain_text, string amp, serialized array esegment, string external_campaign_id, string channel, int limit, int wait_time, string allow_time_zone, string allow_best_time, string stat_domain)

Создаем рассылку

Категория метода

Campaigns

Параметры

Наименование	Тип данных	Описание
list_id	serialized array	индексный массив адресных баз, по которым будет создана рассылка. Структура: порядковый номер (от нуля) => id базы. Массив можно передавать в сериализованном виде или в формате json [{\"0\":LIST_ID}]
name	string	опционально - название рассылки
status	string	опционально - {DRAFT, TEMPLATE} – статус рассылки, если передан TEMPLATE, то рассылка считается Шаблоном. [default: DRAFT]
subject	string	опционально - заголовок письма [должно соответствовать содержанию письма и не отталкивать]
from_name	string	опционально - от кого письмо? [используйте что-нибудь запоминающееся, например, название вашей компании]
from_email	string	опционально - обратный адрес [ответы ваших подписчиков будут приходить на этот адрес]
personalizeToEmail	string	опционально - {on/off} - включить/выключить персонализацию в поле \"Кому:\" [default: off]
to_email	string	опционально - персонализация в поле \"Кому:\" [можно использовать %ТЭГИ% из дополнительных полей базы, например %EMAIL%]
track_opens	string	опционально - {Y,N} - следить за открыванием [default: Y]
track_clicks	string	опционально - {Y,N} - отслеживать клики [default: Y]
plain_clicks	string	опционально - {Y,N} - отслеживать клики в текстовой версии [default: N]
no_images_add	string	опционально - {0,1} - не прикладывать картинки к письму. [default: 0] - по умолчанию прикладываются. помогает проходить спам-фильтры и отображает картинки даже у тех получателей, у кого они по умолчанию отключены
analytics	string	опционально - {google,N} - добавить Google Analytics™ для отслеживания всех URLs [default: N]
analytics_tag	string	опционально - текстовый тег, как рассылка будет отображаться в Google Analytics™, например: Рассылка_9_17_2011
html	string	опционально - код html-версии письма. Либо id сохраненного html-шаблона. Либо сохраненный шаблон из ЛК (из раздела Шаблоны) в формате tmpl1234, где 1234 это id шаблона
plain_text	string	опционально - текстовая версия письма
amp	string	опционально - код AMP-версии письма.
esegment	serialized array or array JSON	опционально - сегменты баз для рассылки. Структура массива: 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.
external_campaign_id	string	опционально - внешний идентификатор рассылки
channel	string	опционально - {email, sms, viber, whatsapp, telegram, notify, push, webpush} канал рассылки. [default: email]
limit	int	опционально - установить лимит отправки писем на рассылку или, в случае задания wait_time для плавной отправки, на временной период
wait_time	int	опционально - временной период в секундах для ожидания перед отправкой следующей части отправкой частями. Например, 3600 – плавная отправка limit писем раз в час
allow_time_zone	string	опционально - {Y,N} - учитывать локальное время подписчика при запланированной на определенное время отправке [default: N]
allow_best_time	string	опционально - {Y,N} - оптимизировать время получения письма, функция \"лучшее время доставки\" [default: N]
stat_domain	string	опционально - Домен статистики, который необходимо использовать в рассылке

Возвращаемые значения (значения data)

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

Наименование	Тип данных	Описание
campaign_id	number	id созданной рассылки

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"campaigns.create"},{"disabled":true,"description":{"content":"

Индексный массив адресных баз {\"0\":LIST_ID}

\n","type":"text/plain"},"key":"list_id","value":"YOUR_LIST_ID(S)"},{"disabled":true,"description":{"content":"

Название рассылки (опционально)

\n","type":"text/plain"},"key":"name","value":"YOUR_CAMPAIGN_NAME"}],"variable":[]}},"response":[{"id":"946bc3e5-c9fb-49ee-95e8-6d910efe6a3b","name":"campaigns.create example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"list_id\": [\r\n {\r\n \"0\": 23568\r\n },\r\n {\r\n \"1\": 45789\r\n },\r\n {\r\n \"2\": 879065\r\n }\r\n ],\r\n \"name\": \"Праздничная\",\r\n \"status\": \"DRAFT\",\r\n \"subject\": \"С праздником\",\r\n \"from_name\": \"ООО Рога и Копыта\",\r\n \"personalizeToEmail\": \"on\",\r\n \"to_email\": \"email@email.ru\",\r\n \"track_opens\": \"Y\",\r\n \"track_clicks\": \"Y\",\r\n \"plain_clicks\": \"Y\",\r\n \"no_images_add\": \"0\",\r\n \"analytics\": \"N\",\r\n \"analytics_tag\": \"Рассылка1256_2024\",\r\n \"html\": \"<\\/head><\\/body><\\/html>\",\r\n \"esegment\": {\"22222\":\r\n {\r\n \"match\": \"any\",\r\n \"c\": [\r\n {\r\n \"field\": \"email\",\r\n \"op\": \"is\",\r\n \"value\": \"test@bk.ru\"\r\n }\r\n ]\r\n }\r\n },\r\n \"channel\": \"email\",\r\n \"limit\": 2000,\r\n \"wait_time\": 3600,\r\n \"allow_time_zone\": \"Y\",\r\n \"allow_best_time\": \"Y\",\r\n \"stat_domain\": \"statistics domain\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.create","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"campaigns.create","description":"Используемый метод"},{"key":"list_id","value":"YOUR_LIST_ID(S)","description":"Индексный массив адресных баз","disabled":true},{"key":"name","value":"YOUR_CAMPAIGN_NAME","description":"Название рассылки (опционально)","disabled":true},{"key":"list_id","value":"{\"0\":LIST_ID}","type":"text","disabled":true},{"key":"name","value":"ОбычнаяРассылка_5","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 11:34:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": {\n \"campaign_id\": CREATED_CAMPAIGN_ID_(NUMBER)\n }\n }\n}"}],"_postman_id":"f75e63ae-e14e-4db5-8d9c-ca45ab149681"},{"name":"campaigns.create_auto","id":"782e52a1-0074-4f04-92f8-1d2a94627de9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"list_id\": [\r\n {\r\n \"0\": 11111\r\n },\r\n {\r\n \"1\": 22222\r\n },\r\n {\r\n \"2\": 333333\r\n }\r\n ],\r\n \"name\": \"Праздничная\",\r\n \"status\": \"DRAFT\",\r\n \"subject\": \"С праздником\",\r\n \"from_name\": \"ООО Рога и Копыта\",\r\n \"from_email\":\"email@mail.ru\",\r\n \"personalizeToEmail\": \"on\",\r\n \"to_email\": \"email@email.ru\",\r\n \"track_opens\": \"Y\",\r\n \"track_clicks\": \"Y\",\r\n \"plain_clicks\": \"Y\",\r\n \"no_images_add\": \"0\",\r\n \"analytics\": \"N\",\r\n \"analytics_tag\": \"Рассылка1256_2024\",\r\n \"html\": \"<\\/head><\\/body><\\/html>\",\r\n \"action\":\"open\",\r\n \"delay_1\":1,\r\n \"schedule_time\":\"10:00:00\",\r\n \"delay_2\":\"hour\",\r\n \"campaigns\":\"3784011, 3784012, 3784013\",\r\n \"auto\":1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.create_auto","description":"

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

campaigns.create_auto (serialized array list_id, string name, string subject, string from_name, string from_email, string personalizeToEmail, string to_email, string track_opens, string track_clicks, string plain_clicks, string no_images_add, string analytics, string analytics_tag, string analytics_medium, string analytics_source, string analytics_content, string analytics_term, string html, string plain_text, string amp, string action, int delay_1, string delay_2, string campaigns, int auto)

Создаем авторассылку

Категория метода

Campaigns

Параметры

Наименование	Тип данных	Описание
list_id	serialized array	опционально - индексный массив адресных баз, на события в которых будет реагировать авторассылка. Структура: порядковый номер (от нуля) => id базы. Только для событий добавления в базу и изменения доп. полей. Массив можно передавать в сериализованном виде или в формате json
name	string	опционально - название рассылки
subject	string	опционально - заголовок письма [должно соответствовать содержанию письма и не отталкивать]
from_name	string	опционально - от кого письмо? [используйте что-нибудь запоминающееся, например, название вашей компании]
from_email	string	опционально - обратный адрес [ответы ваших подписчиков будут приходить на этот адрес]
personalizeToEmail	string	опционально - {on/off} - включить/выключить персонализацию в поле \"Кому:\" [default: off]
to_email	string	опционально - персонализация в поле \"Кому:\" [можно использовать %ТЭГИ% из дополнительных полей базы, например %EMAIL%]
track_opens	string	опционально - {Y,N} - следить за открыванием [default: Y]
track_clicks	string	опционально - {Y,N} - отслеживать клики [default: Y]
plain_clicks	string	опционально - {Y,N} - отслеживать клики в текстовой версии [default: N]
no_images_add	string	опционально - {0,1} - не прикладывать картинки к письму. [default: 0] - по умолчанию прикладываются. помогает проходить спам-фильтры и отображает картинки даже у тех получателей, у кого они по умолчанию отключены
analytics	string	опционально - {google,N} - добавить Google Analytics™ для отслеживания всех URLs [default: N]
analytics_tag	string	опционально - текстовый тег utm_campaign, как рассылка будет отображаться в Google Analytics™, например: Рассылка_9_17_2011
analytics_medium	string	опционально - utm_medium для отображения кликов в Google Analytics™
analytics_source	string	опционально - utm_source для отображения кликов в Google Analytics™
analytics_content	string	опционально - utm_content для отображения кликов в Google Analytics™
analytics_term	string	опционально - utm_term для отображения кликов в Google Analytics™
html	string	опционально - код html-версии письма. Либо id сохраненного html-шаблона. Либо сохраненный шаблон из ЛК (из раздела Шаблоны) в формате tmpl1234, где 1234 это id шаблона
plain_text	string	опционально - текстовая версия письма
amp	string	опционально - код AMP-версии письма.
action	string	опционально - события, на которые реагирует авторассылка. допустимые значения: open - открытие письма, bday - важная дата многократное срабатывание (каждый раз при наступлении), importantday - важная дата однократно, edit - изменение доп. полей подписчика или любая (перечислять через запятую) комбинация из {form - подписка через форму, add - ручное добавление, upload - импорт}. по умолчанию - подписка через форму.
delay_1	int	опционально - количественное время задержки до/после назначенного времени. Если задержка необходима до события - значение параметра должно быть отрицательным. Время назначается в параметре schedule_time
schedule_time	datatime	опционально - назнаенное время события. например, 10:00:00
delay_2	string	опционально - {hour, day, week} - единица измерения времени задержки
campaigns	string	опционально - перечисленные через запятую id рассылок, на открытия в которых должна реагировать авторассылка - для события open. ИЛИ номера полей, на изменение которых должна реагировать авторассылка - для события edit
auto	int	опционально - {0, 1, 2} - состояние авторассылки: 0 - черновик, 1 - активна, 2 - в архиве

Возвращаемые значения (значения data)

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

Наименование	Тип данных	Описание
campaign_id	number	id созданной рассылки

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"campaigns.create_auto"},{"disabled":true,"description":{"content":"

Индексный массив адресных баз (опционально) {\"0\":LIST_ID}

\n","type":"text/plain"},"key":"list_id","value":"YOUR_LIST_ID(S)"},{"disabled":true,"description":{"content":"

Название авторассылки (опционально)

\n","type":"text/plain"},"key":"name","value":"AUTOCAMPAIGN_NAME"}],"variable":[]}},"response":[{"id":"d6e40339-6d03-4ac0-9cbb-b8cc20e65084","name":"campaigns.create_auto example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"list_id\": [\r\n {\r\n \"0\": 11111\r\n },\r\n {\r\n \"1\": 22222\r\n },\r\n {\r\n \"2\": 333333\r\n }\r\n ],\r\n \"name\": \"Праздничная\",\r\n \"status\": \"DRAFT\",\r\n \"subject\": \"С праздником\",\r\n \"from_name\": \"ООО Рога и Копыта\",\r\n \"from_email\":\"email@mail.ru\",\r\n \"personalizeToEmail\": \"on\",\r\n \"to_email\": \"email@email.ru\",\r\n \"track_opens\": \"Y\",\r\n \"track_clicks\": \"Y\",\r\n \"plain_clicks\": \"Y\",\r\n \"no_images_add\": \"0\",\r\n \"analytics\": \"N\",\r\n \"analytics_tag\": \"Рассылка1256_2024\",\r\n \"html\": \"<\\/head><\\/body><\\/html>\",\r\n \"action\":\"open\",\r\n \"delay_1\":1,\r\n \"schedule_time\":\"10:00:00\",\r\n \"delay_2\":\"hour\",\r\n \"campaigns\":\"3784011, 3784012, 3784013\",\r\n \"auto\":1\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.create_auto","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"campaigns.create_auto","description":"Используемый метод"},{"key":"list_id","value":"YOUR_LIST_ID(S)","description":"Индексный массив адресных баз (опционально)","disabled":true},{"key":"name","value":"AUTOCAMPAIGN_NAME","description":"Название авторассылки (опционально)","disabled":true},{"key":"name","value":"AutoCampaign_Test","disabled":true},{"key":"list_id","value":"{\"0\":LIST_ID}","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 11:46:49 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": {\n \"campaign_id\": CREATED_AUTO_CAMPAIGN_ID_(NUMBER)\n }\n }\n}"}],"_postman_id":"782e52a1-0074-4f04-92f8-1d2a94627de9"},{"name":"campaigns.update","id":"ed1fce8c-6154-40f6-bb90-c4055db01c9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"list_id\": {\"0\": 11111, \"1\":22222, \"2\":33333},\r\n \"name\": \"Праздничная\",\r\n \"subject\": \"С праздником\",\r\n \"from_name\": \"ООО Рога и Копыта\",\r\n \"from_email\":\"mail@mail.ru\",\r\n \"personalizeToEmail\": \"on\",\r\n \"to_email\": \"email@email.ru\",\r\n \"track_opens\": \"Y\",\r\n \"track_clicks\": \"Y\",\r\n \"plain_clicks\": \"Y\",\r\n \"no_images_add\": \"0\",\r\n \"analytics\": \"N\",\r\n \"analytics_tag\": \"Рассылка1256_2024\",\r\n \"html\": \"<\\/head><\\/body><\\/html>\",\r\n \"status\":\"SCHEDULE\",\r\n \"esegment\": {\"22222\":\r\n {\r\n \"match\": \"any\",\r\n \"c\": [\r\n {\r\n \"field\": \"email\",\r\n \"op\": \"is\",\r\n \"value\": \"test@bk.ru\"\r\n }\r\n ]\r\n }\r\n },\r\n \"limit\": 2000,\r\n \"wait_time\": 3600,\r\n \"allow_time_zone\": \"Y\",\r\n \"allow_best_time\": \"Y\",\r\n \"stat_domain\": \"statistics domain\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.update&campaign_id=YOUR_CAMPAIGN_ID","description":"

Обновление рассылки.

campaigns.update (int campaign_id, JSON/serialized array list_id, string name, string subject, string from_name, string from_email, string personalizeToEmail, string to_email, string track_opens, string track_clicks, string plain_clicks, string no_images_add, string analytics, string analytics_tag, string analytics_medium, string analytics_source, string analytics_content, string analytics_term, string html, string plain_text, string amp, string status, serialized array esegment, int limit, int wait_time, string allow_time_zone, string allow_best_time, string stat_domain)

Обновляем параметры рассылки

Категория метода

Campaigns

Параметры

Наименование	Тип данных	Описание
campaign_id	int	id обновляемой кампании
list_id	JSON/serialized array	опционально - индексный массив адресных баз, по которым будет создана рассылка. Структура: порядковый номер (от нуля) => id базы. Массив можно передавать в сериализованном виде или в формате JSON. Например, `{\"0\": 11111, \"1\":22222, \"2\":33333}` При использовании параметра esegment параметр list_id становится обязательным
name	string	опционально - название рассылки
subject	string	опционально - заголовок письма [должно соответствовать содержанию письма и не отталкивать]
from_name	string	опционально - от кого письмо? [используйте что-нибудь запоминающееся, например, название вашей компании]
from_email	string	опционально - обратный адрес [ответы ваших подписчиков будут приходить на этот адрес]
personalizeToEmail	string	опционально - {on/off} - включить/выключить персонализацию в поле \"Кому:\" [default: off]
to_email	string	опционально - персонализация в поле \"Кому:\" [можно использовать %ТЭГИ% из дополнительных полей базы, например %EMAIL%]
track_opens	string	опционально - {Y,N} - следить за открыванием [default: Y]
track_clicks	string	опционально - {Y,N} - отслеживать клики [default: Y]
plain_clicks	string	опционально - {Y,N} - отслеживать клики в текстовой версии [default: N]
no_images_add	string	опционально - {0,1} - не прикладывать картинки к письму. [default: 0] - по умолчанию прикладываются. помогает проходить спам-фильтры и отображает картинки даже у тех получателей, у кого они по умолчанию отключены
analytics	string	опционально - {google,N} - добавить Google Analytics™ для отслеживания всех URLs [default: N]
analytics_tag	string	опционально - текстовый тег utm_campaign, как рассылка будет отображаться в Google Analytics™, например: Рассылка_9_17_2011
analytics_medium	string	опционально - utm_medium для отображения кликов в Google Analytics™
analytics_source	string	опционально - utm_source для отображения кликов в Google Analytics™
analytics_content	string	опционально - utm_content для отображения кликов в Google Analytics™
analytics_term	string	опционально - utm_term для отображения кликов в Google Analytics™
html	string	опционально - код html-версии письма. Либо id сохраненного html-шаблона. Либо сохраненный шаблон из ЛК (из раздела Шаблоны) в формате tmpl1234, где 1234 это id шаблона
plain_text	string	опционально - текстовая версия письма
amp	string	опционально - код AMP-версии письма.
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
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. При использовании параметра esegment параметр list_id становится обязательным
limit	int	опционально - установить лимит отправки писем на рассылку или, в случае задания wait_time для плавной отправки, на временной период
wait_time	int	опционально - временной период в секундах для ожидания перед отправкой следующей части отправкой частями. Например, 3600 – плавная отправка limit писем раз в час
allow_time_zone	string	опционально - {Y,N} - учитывать локальное время подписчика при запланированной на определенное время отправке [default: N]
allow_best_time	string	опционально - {Y,N} - оптимизировать время получения письма, функция \"лучшее время доставки\" [default: N]
stat_domain	string	опционально - Домен статистики, который необходимо использовать в рассылке

Для отправки созданной рассылки необходимо указать статус 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

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"campaigns.update"},{"description":{"content":"

ID обновляемой рассылки

\n","type":"text/plain"},"key":"campaign_id","value":"YOUR_CAMPAIGN_ID"},{"disabled":true,"description":{"content":"

Название рассылки (опционально)

\n","type":"text/plain"},"key":"name","value":"CAMPAIGN_NAME"}],"variable":[]}},"response":[{"id":"faefc9cd-4337-43bb-885b-5e1a8adee493","name":"campaigns.update example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"list_id\": [\r\n {\r\n \"0\": 11111\r\n },\r\n {\r\n \"1\": 22222\r\n },\r\n {\r\n \"2\": 333333\r\n }\r\n ],\r\n \"name\": \"Праздничная\",\r\n \"subject\": \"С праздником\",\r\n \"from_name\": \"ООО Рога и Копыта\",\r\n \"from_email\":\"mail@mail.ru\",\r\n \"personalizeToEmail\": \"on\",\r\n \"to_email\": \"email@email.ru\",\r\n \"track_opens\": \"Y\",\r\n \"track_clicks\": \"Y\",\r\n \"plain_clicks\": \"Y\",\r\n \"no_images_add\": \"0\",\r\n \"analytics\": \"N\",\r\n \"analytics_tag\": \"Рассылка1256_2024\",\r\n \"html\": \"<\\/head><\\/body><\\/html>\",\r\n \"status\":\"SCHEDULE\",\r\n \"esegment\": {\"22222\":\r\n {\r\n \"match\": \"any\",\r\n \"c\": [\r\n {\r\n \"field\": \"email\",\r\n \"op\": \"is\",\r\n \"value\": \"test@bk.ru\"\r\n }\r\n ]\r\n }\r\n },\r\n \"limit\": 2000,\r\n \"wait_time\": 3600,\r\n \"allow_time_zone\": \"Y\",\r\n \"allow_best_time\": \"Y\",\r\n \"stat_domain\": \"statistics domain\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.update&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"campaigns.update","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID обновляемой рассылки"},{"key":"name","value":"CAMPAIGN_NAME","description":"Название рассылки (опционально)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 12:39:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"ed1fce8c-6154-40f6-bb90-c4055db01c9b"},{"name":"campaigns.update_auto","id":"1b748b22-141e-4adb-8956-0cfcdb83eb57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"list_id\": [\r\n {\r\n \"0\": 11111\r\n },\r\n {\r\n \"1\": 22222\r\n },\r\n {\r\n \"2\": 333333\r\n }\r\n ],\r\n \"name\": \"Праздничная\",\r\n \"subject\": \"С праздником\",\r\n \"from_name\": \"ООО Рога и Копыта\",\r\n \"from_email\":\"email@mail.ru\",\r\n \"personalizeToEmail\": \"on\",\r\n \"to_email\": \"email@email.ru\",\r\n \"track_opens\": \"Y\",\r\n \"track_clicks\": \"Y\",\r\n \"plain_clicks\": \"Y\",\r\n \"no_images_add\": \"0\",\r\n \"analytics\": \"N\",\r\n \"analytics_tag\": \"Рассылка1256_2024\",\r\n \"html\": \"<\\/head><\\/body><\\/html>\",\r\n \"action\":\"open\",\r\n \"delay_1\":1,\r\n \"schedule_time\":\"10:00:00\",\r\n \"delay_2\":\"hour\",\r\n \"campaigns\":\"3784011, 3784012, 3784013\",\r\n \"auto\":1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.update_auto&campaign_id=YOUR_CAMPAIGN_ID","description":"

Обновление авторассылки.

campaigns.update_auto (int campaign_id, serialized array list_id, string name, string subject, string from_name, string from_email, string personalizeToEmail, string to_email, string track_opens, string track_clicks, string plain_clicks, string no_images_add, string analytics, string analytics_tag, string analytics_medium, string analytics_source, string analytics_content, string analytics_term, string html, string plain_text, string amp, int delay_1, string delay_2, string campaigns, int auto)

Обновляем параметры авторассылки

Категория метода

Campaigns

Параметры

Наименование	Тип данных	Описание
campaign_id	int	id обновляемой кампании
list_id	serialized array	опционально - индексный массив адресных баз, на события в которых будет реагировать авторассылка. Структура: порядковый номер (от нуля) => id базы. Только для событий добавления в базу и изменения доп. полей. Массив можно передавать в сериализованном виде или в формате json
name	string	опционально - название рассылки
subject	string	опционально - заголовок письма [должно соответствовать содержанию письма и не отталкивать]
from_name	string	опционально - от кого письмо? [используйте что-нибудь запоминающееся, например, название вашей компании]
from_email	string	опционально - обратный адрес [ответы ваших подписчиков будут приходить на этот адрес]
personalizeToEmail	string	опционально - {on/off} - включить/выключить персонализацию в поле \"Кому:\" [default: off]
to_email	string	опционально - персонализация в поле \"Кому:\" [можно использовать %ТЭГИ% из дополнительных полей базы, например %EMAIL%]
track_opens	string	опционально - {Y,N} - следить за открыванием [default: Y]
track_clicks	string	опционально - {Y,N} - отслеживать клики [default: Y]
plain_clicks	string	опционально - {Y,N} - отслеживать клики в текстовой версии [default: N]
no_images_add	string	опционально - {0,1} - не прикладывать картинки к письму. [default: 0] - по умолчанию прикладываются. помогает проходить спам-фильтры и отображает картинки даже у тех получателей, у кого они по умолчанию отключены
analytics	string	опционально - {google,N} - добавить Google Analytics™ для отслеживания всех URLs [default: N]
analytics_tag	string	опционально - текстовый тег utm_campaign, как рассылка будет отображаться в Google Analytics™, например: Рассылка_9_17_2011
analytics_medium	string	опционально - utm_medium для отображения кликов в Google Analytics™
analytics_source	string	опционально - utm_source для отображения кликов в Google Analytics™
analytics_content	string	опционально - utm_content для отображения кликов в Google Analytics™
analytics_term	string	опционально - utm_term для отображения кликов в Google Analytics™
html	string	опционально - код html-версии письма. Либо id сохраненного html-шаблона. Либо сохраненный шаблон из ЛК (из раздела Шаблоны) в формате tmpl1234, где 1234 это id шаблона
plain_text	string	опционально - текстовая версия письма
amp	string	опционально - код AMP-версии письма.
action	string	опционально - события, на которые реагирует авторассылка. допустимые значения: open - открытие письма, bday - важная дата многократное срабатывание (каждый раз при наступлении), importantday - важная дата однократно, edit - изменение доп. полей подписчика или любая (перечислять через запятую) комбинация из {form - подписка через форму, add - ручное добавление, upload - импорт}. по умолчанию - подписка через форму.
delay_1	int	опционально - количественное время задержки до/после назначенного времени. Если задержка необходима до события - значение параметра должно быть отрицательным. Время назначается в параметре schedule_time
schedule_time	datetime	опционально - назнаенное время события. например, 10:00:00
delay_2	string	опционально - {hour, day, week} - единица измерения времени задержки
campaigns	string	опционально - перечисленные через запятую id рассылок, на открытия в которых должна реагировать авторассылка - для события open. ИЛИ номера полей, на изменение которых должна реагировать авторассылка - для события edit
auto	int	опционально - {0, 1, 2} - состояние авторассылки: 0 - черновик, 1 - активна, 2 - в архиве

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"campaigns.update_auto"},{"description":{"content":"

ID обновляемой авторассылки

\n","type":"text/plain"},"key":"campaign_id","value":"YOUR_CAMPAIGN_ID"}],"variable":[]}},"response":[{"id":"7ccec893-eb95-462b-bda4-46f52bd25744","name":"campaigns.update_auto example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"list_id\": [\r\n {\r\n \"0\": 11111\r\n },\r\n {\r\n \"1\": 22222\r\n },\r\n {\r\n \"2\": 333333\r\n }\r\n ],\r\n \"name\": \"Праздничная\",\r\n \"subject\": \"С праздником\",\r\n \"from_name\": \"ООО Рога и Копыта\",\r\n \"from_email\":\"email@mail.ru\",\r\n \"personalizeToEmail\": \"on\",\r\n \"to_email\": \"email@email.ru\",\r\n \"track_opens\": \"Y\",\r\n \"track_clicks\": \"Y\",\r\n \"plain_clicks\": \"Y\",\r\n \"no_images_add\": \"0\",\r\n \"analytics\": \"N\",\r\n \"analytics_tag\": \"Рассылка1256_2024\",\r\n \"html\": \"<\\/head><\\/body><\\/html>\",\r\n \"action\":\"open\",\r\n \"delay_1\":1,\r\n \"schedule_time\":\"10:00:00\",\r\n \"delay_2\":\"hour\",\r\n \"campaigns\":\"3784011, 3784012, 3784013\",\r\n \"auto\":1\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.update_auto&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"campaigns.update_auto","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID обновляемой авторассылки"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 12:47:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"1b748b22-141e-4adb-8956-0cfcdb83eb57"},{"name":"campaigns.delete","id":"cc255634-4190-4f01-b418-2e20772ddc10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.delete&campaign_id=YOUR_CAMPAIGN_ID","description":"

Удаление рассылки.

campaigns.delete (int campaign_id)

Удаляем рассылку

Категория метода

Campaigns

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	id удаляемой рассылки

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"campaigns.delete"},{"description":{"content":"

ID удаляемой рассылки

\n","type":"text/plain"},"key":"campaign_id","value":"YOUR_CAMPAIGN_ID"}],"variable":[]}},"response":[{"id":"627b76ec-83d1-4fc0-b9b5-4974b76c9ecc","name":"campaigns.delete example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.delete&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"campaigns.delete","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID удаляемой рассылки"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 12:58:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"cc255634-4190-4f01-b418-2e20772ddc10"},{"name":"campaigns.copy","id":"752f1f9c-9495-425a-8908-389ed89d19b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.copy&campaign_id=YOUR_CAMPAIGN_ID","description":"

Копирование рассылки.

campaigns.copy (int campaign_id)

Копируем рассылку

Категория метода

Campaigns

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	id копируемой рассылки

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"campaigns.copy"},{"description":{"content":"

ID копируемой рассылки

\n","type":"text/plain"},"key":"campaign_id","value":"YOUR_CAMPAIGN_ID"}],"variable":[]}},"response":[{"id":"3f9c7612-3c4a-43eb-a7fa-a96582e207a0","name":"campaigns.copy example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.copy&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"campaigns.copy","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID копируемой рассылки"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 12:58:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"752f1f9c-9495-425a-8908-389ed89d19b1"},{"name":"campaigns.copy_automation","id":"a09d5182-6649-41a7-b8af-d1c30b0af9d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.copy_automation&campaign_id=YOUR_CAMPAIGN_ID","description":"

Копирование автоматизации.

campaigns.copy_automation (int campaign_id)

Копируем автоматизацию

Категория метода

Campaigns

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	id копируемой автоматизации

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"campaigns.copy_automation"},{"description":{"content":"

ID копируемой автоматизации

\n","type":"text/plain"},"key":"campaign_id","value":"YOUR_CAMPAIGN_ID"}],"variable":[]}},"response":[{"id":"db0f2ffa-a6ce-45cf-a014-f2541e644451","name":"campaigns.copy_automation example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.copy_automation&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"campaigns.copy_automation","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID копируемой автоматизации"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 12:58:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"a09d5182-6649-41a7-b8af-d1c30b0af9d7"},{"name":"campaigns.delete_automation","id":"5c06364d-e238-4453-b7ed-d3a6abe2763b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.delete_automation&campaign_id=YOUR_CAMPAIGN_ID","description":"

Удаление автоматизации.

campaigns.delete_automation (int campaign_id)

Удаляем автоматизацию

Категория метода

Campaigns

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	id удаляемой автоматизации

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"campaigns.delete_automation"},{"description":{"content":"

ID удаляемой автоматизации

\n","type":"text/plain"},"key":"campaign_id","value":"YOUR_CAMPAIGN_ID"}],"variable":[]}},"response":[{"id":"e7b2e69e-cb3e-4133-bb1c-4220e2fb64d1","name":"campaigns.delete example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.delete&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"campaigns.delete","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID удаляемой автоматизации"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 12:58:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"5c06364d-e238-4453-b7ed-d3a6abe2763b"},{"name":"campaigns.attach","id":"db331182-3ac2-4e4d-b53d-17189eecd149","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"url\": \"https://example.com/otchot.pdf\",\r\n \"name\":\"otchot.pdf\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.attach&campaign_id=YOUR_CAMPAIGN_ID","description":"

Добавление вложений.

campaigns.attach (int campaign_id, string url, string name)

Добавляем вложение

Категория метода

Campaigns

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	id рассылки
url	string	адрес файла
name	string	опционально - название файла после загрузки (полезно при динамической генерации контента). Указывается вместе с расширением

Возвращаемые значения (значения data)

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

Наименование	Тип данных	Описание
id	number	id приложенного файла

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"campaigns.attach"},{"description":{"content":"

ID рассылки

\n","type":"text/plain"},"key":"campaign_id","value":"YOUR_CAMPAIGN_ID"}],"variable":[]}},"response":[{"id":"07414bd0-3435-4da9-a16e-5d08fb3525d8","name":"campaigns.attach example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.attach&campaign_id=YOUR_CAMPAIGN_ID&file=FILE_ADDRESS&name=ATTACHED_FILE_NAME","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"campaigns.attach","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID рассылки"},{"key":"file","value":"FILE_ADDRESS","description":"Адрес файла"},{"key":"name","value":"ATTACHED_FILE_NAME","description":"Название файла после загрузки (опционально)"},{"key":"file","value":"https://i.pinimg.com/originals/90/91/46/90914649eb330cd2d144bada1aeeb6a8.jpg","type":"text","disabled":true},{"key":"campaign_id","value":"2470975","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 13:27:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"db331182-3ac2-4e4d-b53d-17189eecd149"},{"name":"campaigns.get_attachments","id":"0a7fedac-a21e-41e3-85e8-9ff0f469ecc7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.get_attachments&campaign_id=YOUR_CAMPAIGN_ID","description":"

Получение вложений.

campaigns.get_attachments (int campaign_id)

Получаем приложенные файлы

Категория метода

Campaigns

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	id рассылки

Возвращаемые значения (значения data)

array Массив строк адресных баз с различными параметрами. Вложенный массив подразумевается сериализорованным:

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

Наименование	Тип данных	Описание
id	number	id файла
campaign_id	number	id рассылки
name	string	название файла
size	number	размер файла в байтах
updated_at	datetime	время добавления

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"campaigns.get_attachments"},{"description":{"content":"

ID рассылки

\n","type":"text/plain"},"key":"campaign_id","value":"YOUR_CAMPAIGN_ID"}],"variable":[]}},"response":[{"id":"5184b169-ce3b-46de-8694-46b9d2f3b800","name":"campaigns.get_attachments example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.get_attachments&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"campaigns.get_attachments","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID рассылки"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 13:36:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"id\": \"55970\",\n \"campaign_id\": \"YOUR_CAMPAIGN_ID\",\n \"name\": \"white_blank.png\",\n \"size\": \"263\",\n \"updated_at\": \"2022-08-26 16:34:45\"\n }\n ]\n }\n}"}],"_postman_id":"0a7fedac-a21e-41e3-85e8-9ff0f469ecc7"},{"name":"campaigns.delete_attachment","id":"1a2b225c-e416-4720-b391-89151eb4088e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.delete_attachment&campaign_id=YOUR_CAMPAIGN_ID&id=FILE_TO_DELETE_ID","description":"

Удаление вложений.

campaigns.delete_attachment (int campaign_id, int id)

Удаляем приложенный файл

Категория метода

Campaigns

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	id рассылки
id	int	id файла

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"campaigns.delete_attachment"},{"description":{"content":"

ID рассылки

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

ID файла

\n","type":"text/plain"},"key":"id","value":"FILE_TO_DELETE_ID"}],"variable":[]}},"response":[{"id":"74063458-6f0f-4b02-a221-573e1dd29587","name":"campaigns.delete_attachment example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.delete_attachment&campaign_id=YOUR_CAMPAIGN_ID&id=FILE_TO_DELETE_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"campaigns.delete_attachment","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID рассылки"},{"key":"id","value":"FILE_TO_DELETE_ID","description":"ID файла"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 13:49:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"1a2b225c-e416-4720-b391-89151eb4088e"},{"name":"campaigns.get_templates","id":"f7453695-2759-4ea6-a01a-2611d0b74e99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.get_templates&name=YOUR_TEMPLATE_NAME&id=YOUR_TEMPLATE_ID","description":"

Получение HTML шаблонов

campaigns.get_templates (string name, int id)

Получаем html шаблоны

Категория метода

Campaigns

Параметры

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

Наименование	Тип данных	Описание
name	string	опционально - название шаблона
id	int	опционально - id шаблона

Возвращаемые значения (значения data)

array массив шаблонов с параметрами:

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

Наименование	Тип данных	Описание
id	number	id наблона
html	string	html шаблона

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"campaigns.get_templates"},{"description":{"content":"

Название шаблона (опционально)

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

ID шаблона (опционально)

\n","type":"text/plain"},"key":"id","value":"YOUR_TEMPLATE_ID"}],"variable":[]}},"response":[{"id":"bcfb1a8d-58b2-4de6-87fe-25b1ea704385","name":"campaigns.get_templates example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.get_templates&name=YOUR_TEMPLATE_NAME&id=YOUR_TEMPLATE_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"campaigns.get_templates","description":"Используемый метод"},{"key":"name","value":"YOUR_TEMPLATE_NAME","description":"Название шаблона (опционально)"},{"key":"id","value":"YOUR_TEMPLATE_ID","description":"ID шаблона (опционально)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 14:15:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"id\": \"YOUR_TEMPLATE_ID\",\n \"last_edit\": \"2022-08-26 17:14:31\",\n \"name\": \"YOUR_TEMPLATE_NAME\",\n \"html\": \"\\n\\n\\n \\n \\n \\n \\n\\n\\n\\n

\\n \\n

\\n

\\n Lorem ipsum dolor sit amet consectetur adipisicing elit. Tempore, minus dolore deleniti consequuntur dicta\\n consequatur quis aspernatur alias, rerum dignissimos veniam illo dolores voluptatum similique officia vero autem\\n eum beatae!\\n

\\n

\\n Lorem ipsum dolor sit amet consectetur adipisicing elit. Placeat, voluptatum.\\n

\\n

\\n Lorem ipsum dolor sit amet.\\n

\\n \\n\\n\\n\",\n \"campaign_id\": \"YOUR_CAMPAIGN_ID\"\n }\n ]\n }\n}"}],"_postman_id":"f7453695-2759-4ea6-a01a-2611d0b74e99"},{"name":"campaigns.get_saved_templates","id":"47702fc4-9da4-484c-8395-bfe0e765faac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.get_saved_templates&name=YOUR _TEMPLATE_NAME&id=YOUR_TEMPlATE_ID","description":"

Получение шаблонов из ЛК.

campaigns.get_saved_templates (string name, int id)

Получаем шаблоны из ЛК

Категория метода

Campaigns

Параметры

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

Наименование	Тип данных	Описание
name	string	опционально - название шаблона
id	int	опционально - id шаблона

Возвращаемые значения (значения data)

array массив шаблонов с параметрами:

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

Наименование	Тип данных	Описание
id	number	id шаблона
name	string	название шаблона

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"campaigns.get_saved_templates"},{"description":{"content":"

Название шаблона (опционально)

\n","type":"text/plain"},"key":"name","value":"YOUR _TEMPLATE_NAME"},{"description":{"content":"

ID шаблона (опционально)

\n","type":"text/plain"},"key":"id","value":"YOUR_TEMPlATE_ID"}],"variable":[]}},"response":[{"id":"c770d2bd-217c-4a0b-97aa-778b53400d9f","name":"campaigns.get_saved_templates example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.get_saved_templates&name=YOUR _TEMPLATE_NAME&id=YOUR_TEMPlATE_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"campaigns.get_saved_templates","description":"Используемый метод"},{"key":"name","value":"YOUR _TEMPLATE_NAME","description":"Название шаблона (опционально)"},{"key":"id","value":"YOUR_TEMPlATE_ID","description":"ID шаблона (опционально)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 14:29:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"id\": \"YOUR_TEMPLATE_1_ID\",\n \"name\": \"YOUR_TEMPLATE_2_NAME\"\n },\n {\n \"id\": \"YOUR_TEMPLATE_2_ID\",\n \"name\": \"YOUR_TEMPLATE_2_NAME\"\n }\n ]\n }\n}"}],"_postman_id":"47702fc4-9da4-484c-8395-bfe0e765faac"},{"name":"campaigns.add_template","id":"10f0b867-ec80-4bc5-b3f9-6d61bb1bd716","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.add_template&name=YOUR_TEMPLATE_NAME&template=YOUR_HTML","description":"

Добавление HTML-шаблона.

campaigns.add_template (string name, string template)

Добавляем html шаблон

Категория метода

Campaigns

Параметры

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

Наименование	Тип данных	Описание
name	string	название шаблона
template	string	html-код либо id рассылки, откуда взять html

Возвращаемые значения (значения data)

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

Наименование	Тип данных	Описание
id	number	id нового шаблона

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"campaigns.add_template"},{"description":{"content":"

Название шаблона

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

HTML-код или ID рассылки, откуда будет взят код

\n","type":"text/plain"},"key":"template","value":"YOUR_HTML"}],"variable":[]}},"response":[{"id":"616ae6b4-fcfa-4b2e-9652-0727e4762a43","name":"campaigns.add_template example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.add_template&name=YOUR_TEMPLATE_NAME&template=YOUR_HTML","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"campaigns.add_template","description":"Используемый метод"},{"key":"name","value":"YOUR_TEMPLATE_NAME","description":"Название шаблона"},{"key":"template","value":"YOUR_HTML","description":"HTML-код или ID рассылки, откуда будет взят код"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 15:41:23 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": {\n \"id\": NEW_TEMPLATE_ID_(NUMBER)\n }\n }\n}"}],"_postman_id":"10f0b867-ec80-4bc5-b3f9-6d61bb1bd716"},{"name":"campaigns.delete_template","id":"e5db7f1c-1d15-445e-8719-261e00aed6ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.delete_template&id=TEMPLATE_FOR_DELETE_ID","description":"

Удаление HTML-шаблона.

campaigns.delete_template (int id)

Удаляем html шаблон

Категория метода

Campaigns

Параметры

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

Наименование	Тип данных	Описание
id	int	id шаблона

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"campaigns.delete_template"},{"description":{"content":"

ID шаблона

\n","type":"text/plain"},"key":"id","value":"TEMPLATE_FOR_DELETE_ID"}],"variable":[]}},"response":[{"id":"70a9c4d1-c8b6-4814-a334-75798923c6c3","name":"campaigns.delete_template example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.delete_template&id=TEMPLATE_FOR_DELETE_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"campaigns.delete_template","description":"Используемый метод"},{"key":"id","value":"TEMPLATE_FOR_DELETE_ID","description":"ID шаблона"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 16:00:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"e5db7f1c-1d15-445e-8719-261e00aed6ed"},{"name":"campaigns.force_auto","id":"4553bc24-ab67-41fc-90ec-88143f5c1093","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.force_auto&campaign_id=CAMPAIGN_ID&member_id=RECEPIENT_ID&delay=TIME_MS","description":"

Вызов срабатывания авторассылки.

campaigns.force_auto (int campaign_id, int member_id, int delay)

Принудительно вызываем срабатывание авторассылки (при этом она должна быть активна)

Категория метода

Campaigns

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	id авторассылки
member_id	int	id получателя в адресной базе
delay	int	опционально - время задержки отправки (в мс)

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"campaigns.force_auto"},{"description":{"content":"

ID авторассылки

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

ID получателя в адресной базе

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

Время задержки отправки в мс (опционально)

\n","type":"text/plain"},"key":"delay","value":"TIME_MS"}],"variable":[]}},"response":[{"id":"c1212a33-6811-4d6f-9ff2-45b33baa6d1d","name":"campaigns.force_auto example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.force_auto&campaign_id=CAMPAIGN_ID&member_id=RECEPIENT_ID&delay=TIME_MS","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"campaigns.force_auto","description":"Используемый метод"},{"key":"campaign_id","value":"CAMPAIGN_ID","description":"ID авторассылки"},{"key":"member_id","value":"RECEPIENT_ID","description":"ID получателя в адресной базе"},{"key":"delay","value":"TIME_MS","description":"Время задержки отправки в мс (опционально)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 16:53:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"4553bc24-ab67-41fc-90ec-88143f5c1093"},{"name":"campaigns.get_folders","id":"eda4554e-d832-41cc-892d-b3ff002488af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.get_folders&name=FOLDER_NAME&id=FOLDER_ID","description":"

Получение папки.

campaigns.get_folders (string name, int id)

Получаем папки рассылок

Категория метода

Campaigns

Параметры

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

Наименование	Тип данных	Описание
name	string	опционально - имя папки
id	int	опционально - id папки

Возвращаемые значения (значения data)

array массив папок

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

Наименование	Тип данных	Описание
id	number	id папки
name	string	имя папки

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"campaigns.get_folders"},{"description":{"content":"

Имя папки (опционально)

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

ID папки (опционально)

\n","type":"text/plain"},"key":"id","value":"FOLDER_ID"}],"variable":[]}},"response":[{"id":"cd155740-45eb-49cb-8bba-a09e70e254f0","name":"campaigns.get_folders example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.get_folders&name=FOLDER_NAME&id=FOLDER_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"campaigns.get_folders","description":"Используемый метод"},{"key":"name","value":"FOLDER_NAME","description":"Имя папки (опционально)"},{"key":"id","value":"FOLDER_ID","description":"ID папки (опционально)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 17:27:24 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"id\": \"FOLDER_1_ID\",\n \"name\": \"FOLDER_1_NAME\"\n },\n {\n \"id\": \"FOLDER_2_ID\",\n \"name\": \"FOLDER_2_NAME\"\n }\n ]\n }\n}"}],"_postman_id":"eda4554e-d832-41cc-892d-b3ff002488af"},{"name":"campaigns.move_to_folder","id":"737c585c-57e7-4fa2-b81b-5a8a42efbdc7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.move_to_folder&campaign_id=YOUR_CAMPAIGN_ID&folder_id=YOUR_FOLDER_ID","description":"

Перемещение рассылок в выбранную папку.

campaigns.move_to_folder (int campaign_id, int folder_id)

Перемещаем рассылку в папку

Категория метода

Campaigns

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	id рассылки
folder_id	int	id папки куда переместить

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"campaigns.move_to_folder"},{"description":{"content":"

ID рассылки

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

ID папки для перемещения

\n","type":"text/plain"},"key":"folder_id","value":"YOUR_FOLDER_ID"}],"variable":[]}},"response":[{"id":"a64e9538-c33b-42db-a8bb-36b8cbc6685e","name":"campaigns.move_to_folder example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.move_to_folder&campaign_id=YOUR_CAMPAIGN_ID&folder_id=YOUR_FOLDER_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"campaigns.move_to_folder","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID рассылки"},{"key":"folder_id","value":"YOUR_FOLDER_ID","description":"ID папки для перемещения"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 17:32:58 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"737c585c-57e7-4fa2-b81b-5a8a42efbdc7"},{"name":"campaigns.pause","id":"ffe57876-6eef-40de-9c2d-37f771aa349c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.pause&campaign_id=YOUR_CAMPAIGN_ID","description":"

Пауза рассылки.

campaigns.pause (int campaign_id)

Ставим рассылку на паузу

Категория метода

Campaigns

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	id рассылки

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"campaigns.pause"},{"description":{"content":"

ID рассылки

\n","type":"text/plain"},"key":"campaign_id","value":"YOUR_CAMPAIGN_ID"}],"variable":[]}},"response":[{"id":"e9beb8fd-f7af-4eb3-953b-8219bce3b18c","name":"campaigns.pause example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.pause&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"campaigns.pause","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID рассылки"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 17:35:53 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"ffe57876-6eef-40de-9c2d-37f771aa349c"},{"name":"campaigns.restart_paused","id":"9a741a3b-34a2-424f-a304-72a80e692156","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.restart_paused&campaign_id=YOUR_CAMPAIGN_ID","description":"

Возобновление рассылки.

campaigns.restart_paused (int campaign_id)

Возобновляем поставленную на паузу рассылку

Категория метода

Campaigns

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	id рассылки на паузе

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"campaigns.restart_paused"},{"description":{"content":"

ID рассылки

\n","type":"text/plain"},"key":"campaign_id","value":"YOUR_CAMPAIGN_ID"}],"variable":[]}},"response":[{"id":"577cae9c-314e-46df-a0ea-49cd0da8b9fe","name":"campaigns.restart_paused example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=campaigns.restart_paused&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"campaigns.restart_paused","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID рассылки"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Fri, 26 Aug 2022 17:38:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"9a741a3b-34a2-424f-a304-72a80e692156"}],"id":"dfe1d35b-790b-4724-9d56-c839280d6e3e","_postman_id":"dfe1d35b-790b-4724-9d56-c839280d6e3e","description":""},{"name":"Reports","item":[{"name":"reports.sent","id":"7eb4aade-b5b0-4add-974c-564ed73e346d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.sent&campaign_id=YOUR_CAMPAIGN_ID&old_reports","description":"

Получение отправленных писем.

reports.sent (int campaign_id, int start, int limit, string order)

Список отправленных писем в рассылке

Категория метода

Reports

Параметры

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

Наименование	Тип данных	Описание
campaign_id	id	id запрашиваемой рассылки
start	int	опционально - номер записи с которой начинать вывод. defaults: 0
limit	int	опционально - количество записей для вывода. defaults: 100
order	string	опционально - [ex: \"email desc\"] - поле по которому можно сортировать и порядок сортировки (asc,desc)
old_reports*		опционально, если нужен старый формат (уникальный) ID

*в случае использования old_reports глубина данных – всего 1 месяц

Возвращаемые значения (значения data)

array массив писем c параметрами каждого:

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

Наименование	Тип данных	Описание
id*	number	id письма
member_id	number	id подписчика
campaign_id	number	id рассылки
list_id	number	id адресной базы из которой подписчик
bounce_code	code	smtp-код ошибки в случае возврата сообщения. (только при использовании old_reports = 1. В новом формате для его получения используется reports.bounced)
bounce_reason	string	расшифровка bounce_code в данном конкретном случае (только при использовании old_reports = 1)
email	email	email получателя
sent_time	datetime	время доставки письма
open_time	datetime	время открытия письма (только при использовании old_reports = 1. В новом формате для его получения используется reports.opened)
click_time	datetime	время перехода по ссылке (только при использовании old_reports = 1. В новом формате для его получения используется reports.clicked)

*id отличается от того, который отдавался ранее, теперь он неуникальный и не может использоваться как ключ. Это технический идентификатор, уникальный только в рамках рассылки. Для получения уникального id (как раньше) необходимо в запрос добавить параметр old_reports (эта структура deprecated и будет отключена с 1 января 2025 года)

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"reports.sent"},{"description":{"content":"

ID рассылки

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

опционально, если нужен старый формат ID

\n","type":"text/plain"},"key":"old_reports","value":null}],"variable":[]}},"response":[{"id":"694b761d-f290-4190-8b4b-a1acb942ce51","name":"reports.sent example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.sent&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"reports.sent","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID рассылки"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Tue, 30 Aug 2022 05:56:48 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"id\": \"EMAIL_ID\",\n \"member_id\": \"RECEPIENT_ID\",\n \"campaign_id\": \"YOUR_CAMPAIGN_ID\",\n \"list_id\": \"RECEPIENT'S_LIST_ID\",\n \"bounce_code\": \"\",\n \"bounce_reason\": \"\",\n \"email\": \"RECEPIENT'S_EMAIL\",\n \"sent_time\": \"2022-07-14 00:33:21\",\n \"open_time\": \"2022-07-14 01:10:40\",\n \"click_time\": \"0000-00-00 00:00:00\"\n }\n ]\n }\n}"}],"_postman_id":"7eb4aade-b5b0-4add-974c-564ed73e346d"},{"name":"reports.delivered","id":"c8547d0b-fd4f-462a-98e6-dabf1687e7e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.delivered&campaign_id=YOUR_CAMPAIGN_ID&old_reports","description":"

Получение доставленных писем.

reports.delivered (int campaign_id, int start, int limit, string order)

Список доставленных писем в рассылке

Категория метода

Reports

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	id запрашиваемой рассылки
start	int	опционально - номер записи с которой начинать вывод. defaults: 0
limit	int	опционально - количество записей для вывода. defaults: 100
order	string	опционально - [ex: \"email desc\"] - поле по которому можно сортировать и порядок сортировки (asc,desc)
old_reports*		опционально, если нужен старый формат (уникальный) ID

*в случае использования old_reports глубина данных – всего 1 месяц

Возвращаемые значения (значения data)

array массив писем c параметрами каждого:

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

Наименование	Тип данных	Описание
id*	number	id письма
member_id	number	id подписчика
campaign_id	number	id рассылки
list_id	number	id адресной базы из которой подписчик
bounce_code	number	smtp-код ошибки в случае возврата сообщения
bounce_reason	string	расшифровка bounce_code в данном конкретном случае
email	email	email получателя
sent_time	datetime	время доставки письма
open_time	datetime	время открытия письма
click_time	datetime	время перехода по ссылке

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"reports.delivered"},{"description":{"content":"

ID рассылки

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

опционально, если нужен старый формат ID

\n","type":"text/plain"},"key":"old_reports","value":null}],"variable":[]}},"response":[{"id":"a70934e2-d455-4cad-9f30-f67b4f5aad3d","name":"reports.delivered example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.delivered&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"reports.delivered","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID рассылки"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Tue, 30 Aug 2022 06:04:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"id\": \"EMAIL_ID\",\n \"member_id\": \"RECEPIENT_ID\",\n \"campaign_id\": \"YOUR_CAMPAIGN_ID\",\n \"list_id\": \"RECEPIENT'S_LIST_ID\",\n \"bounce_code\": \"\",\n \"bounce_reason\": \"\",\n \"email\": \"RECEPIENT'S_EMAIL\",\n \"sent_time\": \"2022-07-14 00:33:21\",\n \"open_time\": \"2022-07-14 01:10:40\",\n \"click_time\": \"0000-00-00 00:00:00\"\n }\n ]\n }\n}"}],"_postman_id":"c8547d0b-fd4f-462a-98e6-dabf1687e7e9"},{"name":"reports.opened","id":"ffeae846-7cbf-4712-9cf9-3f1f0f6f3557","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.opened&campaign_id=YOUR_CAMPAIGN_ID&old_reports","description":"

Получение открытых писем.

reports.opened (int campaign_id, int start, int limit, string order)

Список открытых писем в рассылке

Категория метода

Reports

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	id запрашиваемой рассылки
start	int	опционально - номер записи с которой начинать вывод. defaults: 0
limit	int	опционально - количество записей для вывода. defaults: 100
order	string	опционально - [ex: \"email desc\"] - поле по которому можно сортировать и порядок сортировки (asc,desc)
old_reports*		опционально, если нужен старый формат (уникальный) ID

*в случае использования old_reports глубина данных – всего 1 месяц

Возвращаемые значения (значения data)

array массив писем c параметрами каждого:

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

Наименование	Тип данных	Описание
id*	number	id письма
member_id	number	id подписчика
campaign_id	number	id рассылки
list_id	number	id адресной базы из которой подписчик
bounce_code	number	smtp-код ошибки в случае возврата сообщения
bounce_reason	string	расшифровка bounce_code в данном конкретном случае
email	email	email получателя
sent_time	datetime	время доставки письма
open_time	datetime	время открытия письма
click_time	datetime	время перехода по ссылке

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"reports.opened"},{"description":{"content":"

ID рассылки

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

опционально, если нужен старый формат ID

\n","type":"text/plain"},"key":"old_reports","value":null}],"variable":[]}},"response":[{"id":"b959ca54-8ca7-467f-994b-0876ee179641","name":"reports.opened example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.opened&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"reports.opened","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID рассылки"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Tue, 30 Aug 2022 06:07:54 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"id\": \"EMAIL_ID\",\n \"member_id\": \"RECEPIENT_ID\",\n \"campaign_id\": \"YOUR_CAMPAIGN_ID\",\n \"list_id\": \"RECEPIENT'S_LIST_ID\",\n \"bounce_code\": \"\",\n \"bounce_reason\": \"\",\n \"email\": \"RECEPIENT'S_EMAIL\",\n \"sent_time\": \"2022-07-14 00:33:21\",\n \"open_time\": \"2022-07-14 01:10:40\",\n \"click_time\": \"0000-00-00 00:00:00\"\n }\n ]\n }\n}"}],"_postman_id":"ffeae846-7cbf-4712-9cf9-3f1f0f6f3557"},{"name":"reports.clicked","id":"2e1c4144-3142-442c-a295-283b2bfd3e96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.clicked&campaign_id=YOUR_CAMPAIGN_ID&old_reports","description":"

Получение писем с переходами по ссылке.

reports.clicked (int campaign_id, int start, int limit, string order)

Список писем в рассылке, где адресат перешел по любой ссылке

Категория метода

Reports

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	id запрашиваемой рассылки
start	int	опционально - номер записи с которой начинать вывод. defaults: 0
limit	int	опционально - количество записей для вывода. defaults: 100
order	string	опционально - [ex: \"email desc\"] - поле по которому можно сортировать и порядок сортировки (asc,desc)

Возвращаемые значения при добавлении параметра old_reports (эта структура deprecated и будет отключена с 1 января 2025 года. (значения data)

array массив писем c параметрами каждого:

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

Наименование	Тип данных	Описание
id	number	id письма
member_id	number	id подписчика
campaign_id	number	id рассылки
list_id	number	id адресной базы из которой подписчик
bounce_code	number	smtp-код ошибки в случае возврата сообщения
bounce_reason	string	расшифровка bounce_code в данном конкретном случае
email	email	email получателя
sent_time	datetime	время доставки письма
open_time	datetime	время открытия письма
click_time	datetime	время перехода по ссылке

Возвращаемые значения при отсутствии параметра old_reports (значения data)

array массив писем c параметрами каждого:

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

Наименование	Тип данных	Описание
member_id	number	id подписчика
campaign_id	number	id рассылки
list_id	number	id адресной базы из которой подписчик
url_hash	number	хэш ссылки
clicks_count	number	количество кликов для конкретного получателя
email	email	email получателя
url_pers	string	персонализированная ссылка
last_click_time	datetime	время последнего клика

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"reports.clicked"},{"description":{"content":"

ID рассылки

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

опционально, если нужен старый формат отчета

\n","type":"text/plain"},"key":"old_reports","value":null}],"variable":[]}},"response":[{"id":"eac0866a-280d-4068-84e0-bd2914640c2c","name":"reports.clicked example old_reports","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.clicked&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"reports.clicked","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID рассылки"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Tue, 30 Aug 2022 06:13:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"id\": \"EMAIL_ID\",\n \"member_id\": \"RECEPIENT_ID\",\n \"campaign_id\": \"YOUR_CAMPAIGN_ID\",\n \"list_id\": \"RECEPIENT'S_LIST_ID\",\n \"bounce_code\": \"\",\n \"bounce_reason\": \"\",\n \"email\": \"RECEPIENT'S_EMAIL\",\n \"sent_time\": \"2022-07-14 00:33:21\",\n \"open_time\": \"2022-07-14 01:10:40\",\n \"click_time\": \"0000-00-00 00:00:00\"\n }\n ]\n }\n}"},{"id":"83f50e84-2425-48d5-be00-e8a65e522aea","name":"reports.clicked example new","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.clicked&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"reports.clicked","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID рассылки"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Tue, 30 Aug 2022 06:13:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"member_id\": \"RECEPIENT_ID\",\n \"campaign_id\": \"YOUR_CAMPAIGN_ID\",\n \"list_id\": \"RECEPIENT'S_LIST_ID\",\n \"url_hash\": \"NUMBER\",\n \"clicks_count\": \"NUMBER\",\n \"email\": \"RECEPIENT'S_EMAIL\",\n \"url_pers\": \"LINK\",\n \"last_click_time\": \"0000-00-00 00:00:00\"\n }\n ]\n }\n}"}],"_postman_id":"2e1c4144-3142-442c-a295-283b2bfd3e96"},{"name":"reports.unsubscribed","id":"4c332acc-da43-4655-a303-a073cbb2f35d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.unsubscribed&campaign_id=YOUR_CAMPAIGN_ID&old_reports","description":"

Получение писем отписавшихся подписчиков.

reports.unsubscribed (int campaign_id, int start, int limit, string order)

Список писем отписавшихся подписчиков в рассылке

Категория метода

Reports

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	id запрашиваемой рассылки
start	int	опционально - номер записи с которой начинать вывод. defaults: 0
limit	int	опционально - количество записей для вывода. defaults: 100
order	string	опционально - [ex: \"email desc\"] - поле по которому можно сортировать и порядок сортировки (asc,desc)
old_reports*		опционально, если нужен старый формат (уникальный) ID

*в случае использования old_reports глубина данных – всего 1 месяц

Возвращаемые значения (значения data)

array массив писем c параметрами каждого:

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

Наименование	Тип данных	Описание
id*	number	id письма
member_id	number	id подписчика
campaign_id	number	id рассылки
list_id	number	id адресной базы из которой подписчик
bounce_code	number	smtp-код ошибки в случае возврата сообщения
bounce_reason	string	расшифровка bounce_code в данном конкретном случае
email	email	email получателя
sent_time	datetime	время доставки письма
open_time	datetime	время открытия письма
click_time	datetime	время перехода по ссылке

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"reports.unsubscribed"},{"description":{"content":"

ID запрашиваемой рассылки

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

опционально, если нужен старый формат ID

\n","type":"text/plain"},"key":"old_reports","value":null}],"variable":[]}},"response":[{"id":"2ee1e352-b7ae-406a-ba68-6493ac1c52a8","name":"reports.unsubscribed example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.unsubscribed&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"reports.unsubscribed","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID запрашиваемой рассылки"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Tue, 30 Aug 2022 06:17:46 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"id\": \"EMAIL_ID\",\n \"member_id\": \"RECEPIENT_ID\",\n \"campaign_id\": \"YOUR_CAMPAIGN_ID\",\n \"list_id\": \"RECEPIENT'S_LIST_ID\",\n \"bounce_code\": \"\",\n \"bounce_reason\": \"\",\n \"email\": \"RECEPIENT'S_EMAIL\",\n \"sent_time\": \"2022-07-14 00:33:21\",\n \"open_time\": \"2022-07-14 01:10:40\",\n \"click_time\": \"0000-00-00 00:00:00\"\n }\n ]\n }\n}"}],"_postman_id":"4c332acc-da43-4655-a303-a073cbb2f35d"},{"name":"reports.bounced","id":"65814861-2d6d-458b-adf5-af0ad670023b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.bounced&campaign_id=YOUR_CAMPAIGN_ID&old_reports","description":"

Получение возвратившихся писем.

reports.bounced (int campaign_id, int start, int limit, string order)

Список возвратившихся писем в рассылке

Категория метода

Reports

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	id запрашиваемой рассылки
start	int	опционально - номер записи с которой начинать вывод. defaults: 0
limit	int	опционально - количество записей для вывода. defaults: 100
order	string	опционально - [ex: \"email desc\"] - поле по которому можно сортировать и порядок сортировки (asc,desc)
old_reports*		опционально, если нужен старый формат (уникальный) ID

*в случае использования old_reports глубина данных – всего 1 месяц

Возвращаемые значения (значения data)

array массив писем c параметрами каждого:

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

Наименование	Тип данных	Описание
id*	number	id письма
member_id	number	id подписчика
campaign_id	number	id рассылки
list_id	number	id адресной базы из которой подписчик
bounce_code	number	smtp-код ошибки в случае возврата сообщения
bounce_reason	string	расшифровка bounce_code в данном конкретном случае
email	email	email получателя
sent_time	datetime	время доставки письма
open_time	datetime	время открытия письма
click_time	datetime	время перехода по ссылке

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"reports.bounced"},{"description":{"content":"

ID запрашиваемой рассылки

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

опционально, если нужен старый формат ID

\n","type":"text/plain"},"key":"old_reports","value":null}],"variable":[]}},"response":[{"id":"2d3b33f1-6961-4df2-bb0a-38e7dd9e64cc","name":"reports.bounced example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.bounced&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"reports.bounced","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID запрашиваемой рассылки"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Tue, 30 Aug 2022 06:20:54 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"id\": \"EMAIL_ID\",\n \"member_id\": \"RECEPIENT_ID\",\n \"campaign_id\": \"YOUR_CAMPAIGN_ID\",\n \"list_id\": \"RECEPIENT'S_LIST_ID\",\n \"bounce_code\": \"CODE\",\n \"bounce_reason\": \"REASON\",\n \"email\": \"RECEPIENT'S_EMAIL\",\n \"sent_time\": \"2022-07-14 00:33:21\",\n \"open_time\": \"2022-07-14 01:10:40\",\n \"click_time\": \"0000-00-00 00:00:00\"\n }\n ]\n }\n}"}],"_postman_id":"65814861-2d6d-458b-adf5-af0ad670023b"},{"name":"reports.codes","id":"26731b03-ff26-4fdd-93a2-1e4748a17f0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.codes&campaign_id=YOUR_CAMPAIGN_ID","description":"

Получение промокодов.

reports.codes (int campaign_id, int start, int limit, string order)

Список сгенерированных промокодов (по тегу %CODE%) в рассылке

Категория метода

Reports

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	id запрашиваемой рассылки
start	int	опционально - номер записи с которой начинать вывод. defaults: 0
limit	int	опционально - количество записей для вывода. defaults: 100
order	string	опционально - [ex: \"email desc\"] - поле по которому можно сортировать и порядок сортировки (asc,desc)

Возвращаемые значения (значения data)

array массив сгенерированных по тегу %CODE% промокодах в рамках указанной рассылки

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

Наименование	Тип данных	Описание
email	email	email-адрес получателя кода
code	string	сгенерированный промокод
date	datetime	время генерации

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"reports.codes"},{"description":{"content":"

ID запрашиваемой рассылки

\n","type":"text/plain"},"key":"campaign_id","value":"YOUR_CAMPAIGN_ID"}],"variable":[]}},"response":[{"id":"95e66524-1594-4063-9563-085296dfde8a","name":"reports.codes example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.codes&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"reports.codes","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID запрашиваемой рассылки"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Tue, 30 Aug 2022 06:24:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"email\": \"PROMO_RECEPIENT'S_EMAIL\",\n \"code\": \"PROMO\",\n \"date\": \"2022-07-14 01:10:40\"\n }\n ]\n }\n}"}],"_postman_id":"26731b03-ff26-4fdd-93a2-1e4748a17f0a"},{"name":"reports.clickstat","id":"660c9823-6052-4a05-84d1-da9fdd28a448","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.clickstat&campaign_id=YOUR_CAMPAIGN_ID","description":"

Получение статистики по кликам по различным url.

reports.clickstat (int campaign_id)

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

Категория метода

Reports

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	id запрашиваемой рассылки

Возвращаемые значения (значения data)

array массив url c количеством кликов

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

Наименование	Тип данных	Описание
url	string	адрес ссылки
clicks	number	общее число кликов по данной ссылке в рамках рассылки

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"reports.clickstat"},{"description":{"content":"

ID запрашиваемой рассылки

\n","type":"text/plain"},"key":"campaign_id","value":"YOUR_CAMPAIGN_ID"}],"variable":[]}},"response":[{"id":"ba795f16-e1df-4ab3-8b43-022aa047d689","name":"reports.clickstat example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.clickstat&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"reports.clickstat","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID запрашиваемой рассылки"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Tue, 30 Aug 2022 06:33:56 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"url\": \"URL_ADDRESS\",\n \"clicks\": NUMBER_OF_CLICKS_(NUMBER)\n }\n ]\n }\n}"}],"_postman_id":"660c9823-6052-4a05-84d1-da9fdd28a448"},{"name":"reports.userclicks","id":"d1a896ad-caa2-4ebc-b5bc-9689188a5af3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.userclicks&campaign_id=YOUR_CAMPAIGN_ID&url=LINK_URL","description":"

Получение статистики по указанному url.

reports.userclicks (int campaign_id, string url)

статистика по кликам по указанному url в письме

Категория метода

Reports

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	id запрашиваемой рассылки
url	string	адрес рассылки

Возвращаемые значения (значения data)

array массив с информацией обо всех переходах по данной ссылке

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

Наименование	Тип данных	Описание
url	string	адрес ссылки
email	email	email перешедшего
click_time	datetime	время перехода

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"reports.userclicks"},{"description":{"content":"

id запрашиваемой рассылки

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

адрес ссылки

\n","type":"text/plain"},"key":"url","value":"LINK_URL"}],"variable":[]}},"response":[{"id":"fb5ba1f9-434c-44f0-8259-7e6b6b4b0665","name":"reports.userclicks example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.userclicks&campaign_id=YOUR_CAMPAIGN_ID&url=LINK_URL","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"reports.userclicks","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"id запрашиваемой рассылки"},{"key":"url","value":"LINK_URL","description":"адрес ссылки"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Tue, 30 Aug 2022 06:39:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"url\": \"URL_ADDRESS\",\n \"email\": \"CLICKED_USER'S_EMAIL\",\n \"click_time\": \"2022-07-14 01:10:40\"\n }\n ]\n }\n}"}],"_postman_id":"d1a896ad-caa2-4ebc-b5bc-9689188a5af3"},{"name":"reports.bouncestat","id":"51d6f59a-1472-4d4c-b150-ead6dabb9622","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.bouncestat&campaign_id=YOUR_CAMPAIGN_ID","description":"

Получение статистики по возврату.

reports.bouncestat (int campaign_id)

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

Категория метода

Reports

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	id запрашиваемой рассылки

Возвращаемые значения (значения data)

array массив ошибок возвращенных писем в рассылке

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

Наименование	Тип данных	Описание
bounce_code	number	smtp код ошибки
count	number	количество писем с такой ошибкой
description	string	типовое краткое описание ошибки

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"reports.bouncestat"},{"description":{"content":"

ID запрашиваемой рассылки

\n","type":"text/plain"},"key":"campaign_id","value":"YOUR_CAMPAIGN_ID"}],"variable":[]}},"response":[{"id":"714e019b-17f1-4845-8740-07aa23d7bd6d","name":"reports.bouncestat example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.bouncestat&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"reports.bouncestat","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID запрашиваемой рассылки"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Tue, 30 Aug 2022 06:43:52 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"bounce_code\": SMTP_ERROR_CODE_(NUMBER),\n \"count\": NUMBER_OF_EMAILS_(NUMBER),\n \"description\": \"ERROR_DESCRIPTION\"\n }\n ]\n }\n}"}],"_postman_id":"51d6f59a-1472-4d4c-b150-ead6dabb9622"},{"name":"reports.summary","id":"0b17955d-831d-41df-9966-6d1b3ed9fac8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.summary&campaign_id=YOUR_CAMPAIGN_ID","description":"

Краткая статистика по рассылке.

reports.summary (int campaign_id)

краткая статистка по рассылке

Категория метода

Reports

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	id запрашиваемой рассылки

Возвращаемые значения (значения data)

array массив с краткой информацией о рассылке

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

Наименование	Тип данных	Описание
sent	number	число отправленных сообщений
clicked	number	общее число кликов
opened	number	число открытий писем
unique_clicked	number	число подписчиков, кликнувших в письмах
unique_opened	number	число уникальных открытий писем
hard	number	число жестких возвратов писем
soft	number	число мягких возвратов писем
blk	number	число заблокированных почтовой системой писем
unsubscribed	number	число отписавшихся подписчиков
complained	number	число жалоб на спам
preview	number	число открытий в браузере
spam_blocked	number	число заблокированных за спам почтовыми провайдерами
spam	number	число маркированных как спам писем антиспам-системами
first_sent	datetime	время первого открытого письма
last_open	datetime	время последнего открытия
last_click	datetime	время последнего клика
total_events	number	всего событий с рассылкой

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"reports.summary"},{"description":{"content":"

ID запрашиваемой рассылки

\n","type":"text/plain"},"key":"campaign_id","value":"YOUR_CAMPAIGN_ID"}],"variable":[]}},"response":[{"id":"f3cbcf71-af6d-47fb-99f1-86aabfc7bcca","name":"reports.summary example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.summary&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"reports.summary","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID запрашиваемой рассылки"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Tue, 30 Aug 2022 06:56:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": {\n \"sent\": \"1\",\n \"clicked\": \"0\",\n \"opened\": \"1\",\n \"first_sent\": \"2022-07-14 00:33:21\",\n \"last_open\": \"2022-07-14 01:10:40\",\n \"last_click\": \"1970-01-01 03:00:00\",\n \"unique_opened\": \"1\",\n \"unique_clicked\": \"0\",\n \"unsubsribed\": \"0\",\n \"complained\": \"0\",\n \"preview\": \"0\",\n \"spam_blocked\": \"0\",\n \"spam\": \"0\",\n \"blk\": \"0\",\n \"hard\": \"0\",\n \"soft\": \"0\",\n \"total_events\": \"2\"\n }\n }\n}"}],"_postman_id":"0b17955d-831d-41df-9966-6d1b3ed9fac8"},{"name":"reports.clients","id":"910217f8-6f03-48f1-a8ec-97a114706a31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.clients&campaign_id=YOUR_CAMPAIGN_ID","description":"

Статистика по браузерам, ОС и почтовым клиентам.

reports.clients (int campaign_id)

статистика по браузерам, ОС и почтовым клиентам

Категория метода

Reports

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	id запрашиваемой рассылки

Возвращаемые значения (значения data)

array массив вида \"название браузера, ОС, клиента\" => количество открытий (только если ненулевое)

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

Наименование	Тип данных	Описание
ie	number	число пользователей ie > 6
ie6	number	число пользователей ie6
chrome	number	число пользователей chrome
opera	number	число пользователей opera
firefox	number	число пользователей firefox
safari	number	число пользователей safari
mail	number	число пользователей mail.ru
yandex	number	число пользователей yandex.ru
outlook	number	число пользователей outlook
win	number	число пользователей Windows
linux	number	число пользователей Linux
mac	number	число пользователей Mac

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"reports.clients"},{"description":{"content":"

ID запрашиваемой рассылки

\n","type":"text/plain"},"key":"campaign_id","value":"YOUR_CAMPAIGN_ID"}],"variable":[]}},"response":[{"id":"976cb7c3-3468-426b-b1d8-40e82fcda383","name":"reports.clients example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.clients&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"reports.clients","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID запрашиваемой рассылки"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Tue, 30 Aug 2022 06:58:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": {\n \"ie\": null,\n \"ie6\": 0,\n \"ie11\": null,\n \"chrome\": null,\n \"opera\": null,\n \"firefox\": null,\n \"safari\": null,\n \"yandexbrowser\": null,\n \"other\": 0,\n \"browsers\": 0,\n \"iPhone\": 0,\n \"iPad\": null,\n \"samsung\": null,\n \"other_mobile\": 0,\n \"mobile\": null,\n \"yandex\": 0,\n \"mail\": [\n [\n \"0\"\n ]\n ],\n \"gmail\": [\n [\n \"0\"\n ]\n ],\n \"applemail\": null,\n \"outlook\": null,\n \"thunderbird\": null\n }\n }\n}"}],"_postman_id":"910217f8-6f03-48f1-a8ec-97a114706a31"},{"name":"reports.geo","id":"bc30eb14-3502-4839-ad14-b4d10d0b38e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.geo&campaign_id=YOUR_CAMPAIGN_ID","description":"

Статистика по регионам

reports.geo (int campaign_id)

статистика по регионам открытия

Категория метода

Reports

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	id запрашиваемой рассылки

Возвращаемые значения (значения data)

array массив вида \"город или регион\" => количество открытий (только если ненулевое)

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

Наименование	Тип данных	Описание
city	number	число открытий

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"reports.geo"},{"description":{"content":"

ID запрашиваемой рассылки

\n","type":"text/plain"},"key":"campaign_id","value":"YOUR_CAMPAIGN_ID"}],"variable":[]}},"response":[{"id":"ec9976bf-c4bd-45f9-9029-d44910751196","name":"reports.geo example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.geo&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"reports.geo","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID запрашиваемой рассылки"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Tue, 30 Aug 2022 07:02:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"city\": NUMBER_OF_OPENED_(NUMBER)\n }\n ]\n }\n}"}],"_postman_id":"bc30eb14-3502-4839-ad14-b4d10d0b38e4"},{"name":"reports.events","id":"63de0195-27f8-4b4d-8389-62fb4ff6418f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"time_start\": \"2024-10-10 10:10:10\",\r\n \"time_end\": \"2024-11-10 11:00:00\",\r\n \"merge\": [\r\n \"merge_1\",\r\n \"merge_3\",\r\n \"rating\"\r\n ],\r\n \"start\":3,\r\n \"limit\":150,\r\n \"order\":\"desc\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.events&campaign_id=YOUR_CAMPAIGN_ID","description":"

События за период.

reports.events (int campaign_id, datetime time_start, datetime time_end, JSON-array merge, int start, int limit, string order)

Список событий с письмами в рамках рассылки за определенный период

Категория метода

Reports

Параметры

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

Наименование	Тип данных	Описание
campaign_id	int	id запрашиваемой рассылки
time_start	datetime	опционально - время начала выгрузки событий в формате YYYY-DD-MM HH:ii:ss (по-умолчанию: 00:00:00 текущего дня)
time_end	datetime	опционально - время конца выгрузки событий в формате YYYY-DD-MM HH:ii:ss (по-умолчанию: 23:59:59 текущего дня)
merge	JSON-array	JSON-массив полей из адресных баз. Например, [\"merge_1\",\"merge_3\",\"rating\"]. Помимо дополнительных полей merge_{1..N} можно получать значения optin_time, rating и gender
start	int	опционально - номер записи с которой начинать вывод. defaults: 0
limit	int	опционально - количество записей для вывода. defaults: 100
order	string	опционально - [ex: \"email desc\"] - поле по которому можно сортировать и порядок сортировки (asc,desc)

Возвращаемые значения (значения data)

array массив писем c параметрами каждого:

Наименование	Тип данных	Описание
event_date	date	дата события
event_time	time	время события
event_type	string	тип события [SENT, BOUNCED, OPENED, CLICKED, PREVIEW, UNSUBSCRIBED, COMPLAINED]
bounce_category	string	[hrd, sft, blk, spm]
bounce_code	number	код ошибки доставки
bounce_reason	string	расшифровка ошибки доставки
email	email	email-адрес получателя
domain	string	домен получателя
user_id	number	id клиента
campaign_id	number	id рассылки
member_id	number	id подписчика в системе Dashamail
list_id	number	id адресной базы
url_hash	string	хэш url в случае клика
url_pers	string	ссылка персонализированная
url_original	string	ссылка оригинальная из макета
ip	ip	ip-адрес
ip_aton	string	ip-адрес в формате ATON
region	string	регион
OS	string	операционная система
browser	string	браузер
webservice	string	почтовый веб-сервис
user_agent	string	User Agent полный устройства
referer	string	источник перехода
language	string	язык пользователя на устройстве
device	string	устройство
dark_mode	number	0 - светлый режим, 1 - темный режим

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"reports.events"},{"description":{"content":"

ID запрашиваемой рассылки

\n","type":"text/plain"},"key":"campaign_id","value":"YOUR_CAMPAIGN_ID"}],"variable":[]}},"response":[{"id":"867e3059-91ee-4d1b-9fcd-72b77b4bf999","name":"reports.events example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"time_start\": \"2024-10-10 10:10:10\",\r\n \"time_end\": \"2024-11-10 11:00:00\",\r\n \"merge\": [\r\n \"merge_1\",\r\n \"merge_3\",\r\n \"rating\"\r\n ],\r\n \"start\":3,\r\n \"limit\":150,\r\n \"order\":\"desc\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=reports.events&campaign_id=YOUR_CAMPAIGN_ID","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"reports.events","description":"Используемый метод"},{"key":"campaign_id","value":"YOUR_CAMPAIGN_ID","description":"ID запрашиваемой рассылки"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Tue, 30 Aug 2022 07:06:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"event_date\": \"2024-10-10\",\n \"event_time\": \"10:10:10\",\n \"event_type\": \"TYPE_OF_EVENT\",\n \"bounce_category\": \"\",\n \"bounce_code\": CODE_(NUMBER),\n \"bounce_reason\": \"\",\n \"email\": \"\",\n \"domain\": \"\",\n \"user_id\": NUMBER,\n \"campaign_id\": NUMBER,\n \"member_id\": NUMBER,\n \"list_id\": NUMBER,\n \"url_hash\": \"URL'S_HASH_IF_CLICKED\",\n \"url_pers\": \"PERSONALISED_URL\",\n \"url_original\": \"ORIGINAL_URL\",\n \"ip\": \"\",\n \"ip_aton\": \"IP_ADDRESS_ATON_FORMAT\",\n \"region\": \"\",\n \"OS\": \"\",\n \"browser\": \"\",\n \"webservice\": \"\",\n \"user_agent\": \"\",\n \"referer\": \"\",\n \"language\": \"\",\n \"device\": \"\",\n \"dark_mode\": \"0_LIGHT_MODE,1_DARK_MODE\"\n }\n ]\n }\n}"}],"_postman_id":"63de0195-27f8-4b4d-8389-62fb4ff6418f"}],"id":"befe657b-37bb-45db-bf59-3a1989fa805b","_postman_id":"befe657b-37bb-45db-bf59-3a1989fa805b","description":""},{"name":"Account","item":[{"name":"account.get_domains","id":"dc817a75-e367-4fa2-91b6-2d17890975df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.get_domains&domain=DOMAIN_NUMBER&stat_domain=STAT_DOMAIN_NUMBER","description":"

Получение доменов.

account.get_domains ()

Получить список доменов, настроенных на аккаунте.

Категория метода

Account

Параметры

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

Наименование	Тип данных	Описание
domain	number	опционально - значение интересуемого домена отправки
stat_domain	number	опционально - значение интересуемого домена статистики

Возвращаемые значения (значения data)

array доменов:

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

Наименование	Тип данных	Описание
domain	number	значение домена
type	string	domain (домен отправки), stat_domain (домен статистики)
valid	number	{0 - домен не активен, 1 - домен активен и может использоваться для подписи или замены ссылок трекинга}
valid_spf	number	{0 - SPF-запись невалидна, 1 - SPF-запись валидна} [только для доменов отправки]
valid_dkim	number	{0 - DKIM-запись невалидна, 1 - DKIM-запись валидна} [только для доменов отправки]
double_spf	number	{0 - SPF корректна и в единственном экзепляре, 1 – двойная SPF-запись} [только для доменов отправки]
last_update	datetime	время последней проверки DNS в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС

Данный метод не возвращает DNS-записи для доменов. Для получения значений DNS-записей используйте метод account.check_domains.

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"account.get_domains"},{"description":{"content":"

Опционально. Значение домена отправки

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

Опционально. Значение домена статистики

\n","type":"text/plain"},"key":"stat_domain","value":"STAT_DOMAIN_NUMBER"}],"variable":[]}},"response":[{"id":"6b4a72f6-0ce8-4387-ad8d-3ed259c9d034","name":"account.get_domains example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.get_domains","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"account.get_domains","description":"Используемый метод"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Wed, 31 Aug 2022 06:33:13 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": {\n \"domain\": DOMAIN_NUMBER,\n \"type\": \"domain\",\n \"valid\": CONFIRM_(NUMBER_1|0),\n \"valid_spf\": CONFIRM_(NUMBER_1|0),\n \"valid_dkim\": CONFIRM_(NUMBER_1|0),\n \"double_spf\": CONFIRM_(NUMBER_1|0),\n \"last_update\": 2024-07-22 15:21:42\n }\n }\n}"}],"_postman_id":"dc817a75-e367-4fa2-91b6-2d17890975df"},{"name":"account.get_balance","id":"0ecd0231-0549-42b4-b23f-4a8dcb70ab97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.get_balance","description":"

Получение баланса.

account.get_balance ()

Получить текущий баланс аккаунта

Категория метода

Account

Параметры

Метод не принимает никаких параметров

Возвращаемые значения (значения data)

array актуальные значения баланса аккаунта:

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

Наименование	Тип данных	Описание
limit_members	number	максимальное количество подписчиков, которое можно хранить на аккаунте (если не ограничено, этот параметр равен нулю)
limit_emails	number	доступное клоичество писем
members	number	актуальное количество подписчиков на аккаунте (уникальных)

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"account.get_balance"}],"variable":[]}},"response":[{"id":"2a57b584-1ccd-4bca-8573-03dd3d116458","name":"account.get_balance example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.get_balance","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"account.get_balance","description":"Используемый метод"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Wed, 31 Aug 2022 06:33:13 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": {\n \"limit_members\": 0,\n \"limit_emails\": \"999\",\n \"members\": \"100\"\n }\n }\n}"}],"_postman_id":"0ecd0231-0549-42b4-b23f-4a8dcb70ab97"},{"name":"account.get_webhooks","id":"fff0b544-dc5b-4a8f-9475-f478ac64916c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.get_webhooks&event_name=EVENT_NAME","description":"

Получение вебхуков.

account.get_webhooks (string event_name)

Получить список всех заданных webhooks или webhook по определенному событию

Категория метода

Account

Параметры

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

Наименование	Тип данных	Описание
event_name	string	опционально - событие {open, click, hard, spam, unsub, subscribe, confirm}

Возвращаемые значения (значения data)

array массив настроенных webhooks:

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

Наименование	Тип данных	Описание
open	string	открытия
click	string	клики
hard	string	возвраты
spam	string	нажатия \"это спам\"
unsub	string	отписки
subscribe	string	подписки через форму
confirm	string	подтверждение подписки через форму

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"account.get_webhooks"},{"description":{"content":"

Событие (опционально)

\n","type":"text/plain"},"key":"event_name","value":"EVENT_NAME"}],"variable":[]}},"response":[{"id":"acb5fc14-4c1b-48ad-b1f5-6461fd3e20a8","name":"account.get_webhooks example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.get_webhooks&event_name=EVENT_NAME","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"account.get_webhooks","description":"Используемый метод"},{"key":"event_name","value":"EVENT_NAME","description":"Событие (опционально)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Wed, 31 Aug 2022 06:40:25 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n {\n \"open\": \"OPEN_EVENT_URL\",\n \"click\": \"CLICK_EVENT_URL\",\n \"hard\": \"RETURN_EVENT_URL\",\n \"spam\": \"SPAM_EVENT_URL\",\n \"unsub\": \"UNSUBSCRIBE_EVENT_URL\",\n \"subscribe\": \"SUBSCRIBE_EVENT_URL\",\n \"confirm\": \"CONFIRM_EVENT_URL\"\n }\n ]\n }\n}"}],"_postman_id":"fff0b544-dc5b-4a8f-9475-f478ac64916c"},{"name":"account.add_webhooks","id":"e4e819ea-c4c1-4b62-9df9-dc70f52f54e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"open\":\"https://webhook.net/xxx\",\r\n \"click\":\"https://webhook.net/ccc\",\r\n \"hard\":\"https://webhook.net/fff\",\r\n \"spam\":\"https://webhook.net/ggg\",\r\n \"unsub\":\"https://webhook.net/ddd\",\r\n \"subscribe\":\"https://webhook.net/lll\",\r\n \"confirm\":\"https://webhook.net/jjj\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.add_webhooks","description":"

Добавление вебхуков.

account.add_webhooks (string open, string click, string hard, string spam, string unsub, string subscribe, string confirm)

Обновить или добавить webhooks для событий

Категория метода

Account

Параметры

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

Наименование	Тип данных	Описание
open	string	опционально - url для события \"открытие\"
click	string	опционально - url для события \"клик
hard	string	опционально - url для события \"возвраты\"
spam	string	опционально - url для события \"это спам\"
unsub	string	опционально - url для события \"отписки\"
subscribe	string	опционально - url для события \"подписки через форму\"
confirm	string	опционально - url для события \"подтверждение подписки через форму\"

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"account.add_webhooks"},{"disabled":true,"description":{"content":"

URL для события \"открытие\" (опционально)

\n","type":"text/plain"},"key":"open","value":"OPEN_EVENT_URL"}],"variable":[]}},"response":[{"id":"2a812c5e-8bc5-410e-8b08-a0d8edd2cf8b","name":"account.add_webhooks example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"open\":\"https://webhook.net/xxx\",\r\n \"click\":\"https://webhook.net/ccc\",\r\n \"hard\":\"https://webhook.net/fff\",\r\n \"spam\":\"https://webhook.net/ggg\",\r\n \"unsub\":\"https://webhook.net/ddd\",\r\n \"subscribe\":\"https://webhook.net/lll\",\r\n \"confirm\":\"https://webhook.net/jjj\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.add_webhooks","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"account.add_webhooks","description":"Используемый метод"},{"key":"open","value":"OPEN_EVENT_URL","description":"URL для события \"открытие\" (опционально)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Wed, 31 Aug 2022 06:40:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"e4e819ea-c4c1-4b62-9df9-dc70f52f54e3"},{"name":"account.delete_webhooks","id":"717d2e91-ac7b-43d6-b7bc-e9289d1d4f75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.delete_webhooks&event_name=EVENT_NAME","description":"

Удаление вебхуков.

account.delete_webhooks (string event_name)

Удаляем вебхуки для событий

Категория метода

Account

Параметры

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

Наименование	Тип данных	Описание
event_name	string	опционально - событие {open, click, hard, spam, unsub, subscribe, confirm}

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"account.delete_webhooks"},{"description":{"content":"

Опционально - событие (open, click, hard, spam, unsub, subscribe, confirm)

\n","type":"text/plain"},"key":"event_name","value":"EVENT_NAME"}],"variable":[]}},"response":[{"id":"06705245-9bb5-4a89-865a-b0039c901ef8","name":"account.delete_webhooks example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.delete_webhooks&event_name=EVENT_NAME","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"account.delete_webhooks","description":"Используемый метод"},{"key":"event_name","value":"EVENT_NAME","description":"Опционально - событие (open, click, hard, spam, unsub, subscribe, confirm)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Wed, 31 Aug 2022 06:46:27 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"717d2e91-ac7b-43d6-b7bc-e9289d1d4f75"},{"name":"account.confirm_from_email","id":"4428741f-73b5-44bc-955f-fc986180946d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.confirm_from_email&email=CONFIRM_EMAIL","description":"

Отправка подтверждения.

account.confirm_from_email (string email)

Отправить письмо подтверждения обратного адреса для использования в ЛК или транзакционных рассылках

Категория метода

Account

Параметры

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

Наименование	Тип данных	Описание
email	string	email-адрес для подтверждения

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"account.confirm_from_email"},{"description":{"content":"

email-адрес для подтверждения

\n","type":"text/plain"},"key":"email","value":"CONFIRM_EMAIL"}],"variable":[]}},"response":[{"id":"d0b383f7-7c13-4841-ad99-925df398303a","name":"account.confirm_from_email example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.confirm_from_email&email=CONFIRM_EMAIL","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"account.confirm_from_email","description":"Используемый метод"},{"key":"email","value":"CONFIRM_EMAIL","description":"email-адрес для подтверждения"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Wed, 31 Aug 2022 06:51:56 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"4428741f-73b5-44bc-955f-fc986180946d"},{"name":"account.get_confirmed","id":"69a94ba0-07f9-476a-9437-7120bdb163a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.get_confirmed","description":"

Получение подтверждения.

account.get_confirmed ()

Получить список всех подтвержденных email-адресов на аккаунте

Категория метода

Account

Параметры

Метод не принимает никаких параметров

Возвращаемые значения (значения data)

array массив подтвержденных email-адресов, доступных к использованию:

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

Наименование	Тип данных	Описание
email	string	подтвержденный email-адрес

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"account.get_confirmed"}],"variable":[]}},"response":[{"id":"96a5791e-deb1-4946-9f1b-0655443c86e0","name":"account.get_confirmed example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.get_confirmed","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"account.get_confirmed","description":"Используемый метод"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Wed, 31 Aug 2022 06:58:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": [\n \"CONFIRMED_ADDRESS_1\",\n \"CONFIRMED_ADDRESS_2\",\n \"CONFIRMED_ADDRESS_3\"\n ]\n }\n}"}],"_postman_id":"69a94ba0-07f9-476a-9437-7120bdb163a4"},{"name":"account.add_domain","id":"e2b3e1ae-7976-494c-9104-f2187fd5e107","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.add_domain&domain=YOUR_DOMAIN&stat_domain=YOUR_STAT_DOMAIN","description":"

Добавление домена.

account.add_domain (string domain, string stat_domain)

Добавить домен отправки или домен статистики на аккаунт

Категория метода

Account

Параметры

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

Наименование	Тип данных	Описание
domain	string	опционально - Домен отправки (DKIM&SPF)
stat_domain	string	опционально - Домен статистики (трекинга)

Возвращаемые значения (значения data)

array массив DNS-записей для корректной настройки домена отправки или статистики:

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

Наименование	Тип данных	Описание
valid	number	{0,1} подтверждена DNS-запись или нет
name	string	домен
record_type	string	тип DNS-записи для домена
value	string	значение DNS-записи для домена

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"account.add_domain"},{"description":{"content":"

Домен отправки (DKIM&SPF) (опционально)

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

Домен статистики (трекинга) (опционально)

\n","type":"text/plain"},"key":"stat_domain","value":"YOUR_STAT_DOMAIN"}],"variable":[]}},"response":[{"id":"208368a2-1778-478d-a2ae-c1ec48391e19","name":"account.add_domain example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.add_domain&domain=YOUR_DOMAIN&stat_domain=YOUR_STAT_DOMAIN","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"account.add_domain","description":"Используемый метод"},{"key":"domain","value":"YOUR_DOMAIN","description":"Домен отправки (DKIM&SPF) (опционально)"},{"key":"stat_domain","value":"YOUR_STAT_DOMAIN","description":"Домен статистики (трекинга) (опционально)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Wed, 31 Aug 2022 07:02:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": {\n \"valid\": CONFIRM_(NUMBER_1|0),\n \"name\": \"DOMAIN_NAME\",\n \"record_type\": \"DNS_TYPE\",\n \"value\": \"DNS_VALUE\"\n }\n }\n}"}],"_postman_id":"e2b3e1ae-7976-494c-9104-f2187fd5e107"},{"name":"account.check_domains","id":"c0031cc7-6056-4bf2-b387-b74497b9651a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.check_domains&domain=YOUR_DOMAIN&stat_domain=YOUR_STAT_DOMAIN","description":"

Проверка валидности DNS-записей.

account.check_domains (string domain, string stat_domain)

Получить и проверить валидность DNS-записей для настройки домена отправки или статистики

Категория метода

Account

Параметры

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

Наименование	Тип данных	Описание
domain	string	опционально - Домен отправки (DKIM&SPF)
stat_domain	string	опционально - Домен статистики (трекинга)

Возвращаемые значения (значения data)

array массив DNS-записей для корректной настройки домена отправки или статистики:

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

Наименование	Тип данных	Описание
valid	number	{0,1} подтверждена DNS-запись или нет
name	string	домен
record_type	string	тип DNS-записи для домена
value	string	значение DNS-записи для домена

","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"account.check_domains"},{"description":{"content":"

Домен отправки (DKIM&SPF) (опционально)

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

Домен статистики (трекинга) (опционально)

\n","type":"text/plain"},"key":"stat_domain","value":"YOUR_STAT_DOMAIN"}],"variable":[]}},"response":[{"id":"6241e28d-bf2b-4132-a63c-aeaf6b083793","name":"account.check_domains example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.check_domains&domain=YOUR_DOMAIN&stat_domain=YOUR_STAT_DOMAIN","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"account.check_domains","description":"Используемый метод"},{"key":"domain","value":"YOUR_DOMAIN","description":"Домен отправки (DKIM&SPF) (опционально)"},{"key":"stat_domain","value":"YOUR_STAT_DOMAIN","description":"Домен статистики (трекинга) (опционально)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Wed, 31 Aug 2022 07:13:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": {\n \"valid\": CONFIRM_(NUMBER_1|0),\n \"name\": \"DOMAIN_NAME\",\n \"record_type\": \"DNS_TYPE\",\n \"value\": \"DNS_VALUE\"\n }\n }\n}"}],"_postman_id":"c0031cc7-6056-4bf2-b387-b74497b9651a"},{"name":"account.delete_domain","id":"552a14fc-3ba1-4988-957d-5c6e52c31a2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.delete_domain&delete_domain=YOUR_DOMAIN&delete_stat_domain=YOUR_STAT_DOMAIN","description":"

Удаление домена.

account.delete_domain (string delete_domain, string delete_stat_domain)

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

Категория метода

Account

Параметры

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

Наименование	Тип данных	Описание
delete_domain	string	string опционально - Домен отправки (DKIM&SPF)
delete_stat_domain	string	string опционально - Домен статистики (трекинга)

Возвращаемые значения (значения data)

Если значение msg[err_code] равно 0, то операция прошла успешно

\n","urlObject":{"protocol":"https","path":[""],"host":["api","dashamail","com"],"query":[{"description":{"content":"

Ваш API-ключ

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

Используемый метод

\n","type":"text/plain"},"key":"method","value":"account.delete_domain"},{"description":{"content":"

Домен отправки (DKIM&SPF) (опционально)

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

Домен статистики (трекинга) (опционально)

\n","type":"text/plain"},"key":"delete_stat_domain","value":"YOUR_STAT_DOMAIN"}],"variable":[]}},"response":[{"id":"fb2b40f0-f140-4888-b11c-c6623b106341","name":"account.delete_domain example","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.dashamail.com/?api_key=YOUR_API_KEY&method=account.delete_domain&delete_domain=YOUR_DOMAIN&delete_stat_domain=YOUR_STAT_DOMAIN","protocol":"https","host":["api","dashamail","com"],"path":[""],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"Ваш API-ключ"},{"key":"method","value":"account.delete_domain","description":"Используемый метод"},{"key":"delete_domain","value":"YOUR_DOMAIN","description":"Домен отправки (DKIM&SPF) (опционально)"},{"key":"delete_stat_domain","value":"YOUR_STAT_DOMAIN","description":"Домен статистики (трекинга) (опционально)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.6"},{"key":"Date","value":"Wed, 31 Aug 2022 07:15:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"msg\": {\n \"err_code\": 0,\n \"text\": \"OK\",\n \"type\": \"message\"\n },\n \"data\": true\n }\n}"}],"_postman_id":"552a14fc-3ba1-4988-957d-5c6e52c31a2d"}],"id":"3a6e4c44-f94b-4bd7-aec3-32c9e9a49e05","_postman_id":"3a6e4c44-f94b-4bd7-aec3-32c9e9a49e05","description":""}],"id":"13fcaf04-ae4b-45d3-892c-60a178581e1d","description":"

Введение

Работа с API осуществляется при помощи отправки HTTP-запросов (методы GET, POST) по адресу:

api.dashamail.com

Возможно использование протоколов HTTP либо HTTPS. Кодировка: UTF-8. Пример запроса:

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

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

Наименование	Тип данных	Описание
method	text	Вызываемый метод вида \"категория.метод\" (например 'lists.get')
api_key	number	Ключ для авторизации из раздела «Аккаунт» - «Интеграции»

Возвращаемые данные

Ответ может быть в одном из нескольких форматов. Для его задания используйте переменную format:

JSON (default)
JSONP
XML

Даша возвращает данные структурированные следующим образом:

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

Наименование	Тип данных	Описание
<msg>	array	сообщение о выполнении действия в виде массива с ключами: <err_code> - числовой код ошибки (0 - нет ошибок); <text> - текстовое сообщение; <type> - тип сообщения (message – нет ошибок, notice и error – ошибки)
<data>	array	запрашиваемые данные в виде массива, если есть

Категории методов

lists - Для работы с Адресными Базами
\ncampaigns - Для работы с Кампаниями
\nreports - Для работы с Отчётами
\naccount - Для работы с настройками аккаунта

\n","_postman_id":"13fcaf04-ae4b-45d3-892c-60a178581e1d"},{"name":"Библиотеки","item":[],"id":"36dd5e21-c478-411c-89ca-c7220e175750","description":"

Язык: PHP | PHPDasha | Автор: Zhussupov Zhassulan | Репозиторий на GitHub: https://github.com/DashaMail/php_dashamail

Язык: Ruby | creadone/dashamail | Автор: Sergey Fedorov | GitHub: https://github.com/DashaMail/dashamail-gem

Язык: Python | akazaev/anymail-dashamail | Автор: Алексей Казаев | GitHub: https://github.com/DashaMail/anymail-dashamail

Язык: Go | kra-so/dashamail-go | Автор: Андрей Красильников | GitHub: https://github.com/DashaMail/dashamail-go

Если у вас есть библиотека для работы с ДашаМейл.ру или вы очень хотите, чтобы оно появилось - не стесняйтесь и пишите сразу же на support@dashamail.ru. Мы всегда рады талантливым разработчикам!

\n","_postman_id":"36dd5e21-c478-411c-89ca-c7220e175750"},{"name":"Коды ошибок","item":[],"id":"75cc2518-552a-464a-b909-424112fabd8d","description":"

Коды ошибок

errors

Таблица известных ошибок, возвращаемых сервисом.

2 - ошибка при добавлении в базу
\n
3 - заданы не все необходимые параметры
\n
4 - нет данных при выводе
\n
5 - у пользователя нет адресной базы с таким id
\n
6 - некорректный email-адрес
\n
7 - такой пользователь уже есть в этой адресной базе
\n
8 - лимит по количеству активных подписчиков на тарифном плане клиента
\n
9 - нет такого подписчика у клиента
\n
10 - пользователь уже отписан
\n
11 - нет данных для обновления подписчика
\n
12 - не заданы элементы списка
\n
13 - не задано время рассылки
\n
14 - Не задан заголовок письма
\n
15 - Не задано поле От Кого?
\n
16 - Не задан обратный адрес
\n
17 - Не задана ни html ни plain_text версия письма
\n
18 - Нет ссылки отписаться [ссылки с id=\"unsub_link\"] в тексте рассылки. Пример ссылки: отписаться
\n
19 - Нет ссылки отписаться [%ОТПИСАТЬСЯ%] в тексте рассылки.
\n
20 - задан недопустимый статус рассылки
\n
21 - рассылка уже отправляется
\n
22 - у вас нет кампании с таким campaign_id
\n
23 - нет такого поля для сортировки
\n
24 - заданы недопустимые события для авторассылки
\n
25 - загружаемый файл уже существует
\n
26 - загружаемый файл больше 5 Мб
\n
27 - файл не найден
\n
28 - указанный шаблон не существует
\n
29 - определен одноразовый email-адрес
\n
30 - отправка рассылок заблокирована по подозрению в спаме
\n
31 - массив email-адресов пуст
\n
32 - нет корректных адресов для добавления
\n
33 - недопустимый формат файла
\n
34 - необходимо настроить собственный домен отправки
\n
35 - данный функционал недоступен на бесплатных тарифах и во время триального периода
\n
36 - ошибка при отправке письма
\n
37 - рассылка еще не прошла модерацию
\n
38 - недопустимый сегмент
\n
39 - нет папки с таким id
\n
40 - рассылка не находится в статусе PROCESSING или SENT
\n
41 - рассылка не отправляется в данный момент
\n
42 - у вас нет рассылки на паузе с таким campaign_id
\n
43 - Пользователь в черном списке (двойная отписка)
\n
44 - Пользователь в черном списке (нажатие «это спам»)
\n
45 - Пользователь в черном списке (ручное)
\n
46 - Несуществующий email-адрес (находится в глобальном списке возвратов)
\n
47 - Ваш ip-адрес не включен в список разрешенных
\n
48 - Не удалось отправить письмо подтверждения для обратного адреса.
\n
49 - Такой адрес уже подтвержден
\n
50 - Нельзя использовать одноразовые email в обратном адресе!
\n
51 - Использование обратного адреса на публичных доменах Mail.ru СТРОГО ЗАПРЕЩЕНО политикой DMARC данного почтового провайдера.
\n
52 - Email-адрес не подтвержден в качестве отправителя
\n
53 - Недопустимое событие для webhook
\n
54 - Некорректный домен. Кириллические и другие национальные домены в качестве DKIM/SPF запрещены.
\n
55 - Данный домен находится в черном списке, его добавление запрещено.
\n
56 - Данный домен занят другим аккаунтом.
\n
57 - У вас нет такого домена статистики.
\n
58 - Лимит запросов по API
\n
bounce_code:
\n

666 - bounce_reason: Недостаточно средств на балансе
667 - bounce_reason: Аккаунт заблокирован за спам
668 - bounce_reason: Превышен лимит на подписчиков в месячном плане
669 - bounce_reason: Блокировка по единой политике коммуникаций
670 - bounce_reason: Не настроен домен
671 - bounce_reason: Некорректный email-адрес
672 - bounce_reason: Нет в списке разрешенных email-адресов
673 - bounce_reason: пользователь уже отписан
674 - bounce_reason: ранее получен жесткий возврат
675 - bounce_reason: Email-адрес XXX не подтвержден в качестве отправителя
676 - bounce_reason: Недопустимый формат файла
677 - bounce_reason: Файл слишком большой
678 - bounce_reason: Невозможно прочитать файл
679 - bounce_reason: Некорректные заголовки письма
680 - bounce_reason: У вас нет кампании с таким campaign_id
681 - bounce_reason: NO VALID HTML. Lex\\Parser ERROR
682 - bounce_reason: NO VALID HTML. DOM PARSE ERROR
683 - bounce_reason: DEBUG generated bounce report

\n","_postman_id":"75cc2518-552a-464a-b909-424112fabd8d"}],"event":[{"listen":"prerequest","script":{"id":"62832228-e406-4684-97e1-0956fdb050f8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a7fe5fca-2db5-48c0-83e6-00bc1d812502","type":"text/javascript","exec":[""]}}]}