{
"info": {
"_postman_id": "99577f4d-2a39-43e2-a350-9d130ec5455c",
"name": "Haskimail API",
"description": "Транзакционное API Haskimail: отправка писем, сообщения, возвраты,\nшаблоны, потоки, серверы, домены, подписи, статистика и вебхуки.\n\n**Перед первым запросом** заполните переменные коллекции.\nТокенов два, и они не взаимозаменяемы:\n\n- `server_token` — права в пределах одного сервера: отправка,\n сообщения, возвраты, шаблоны, статистика. Настройки сервера →\n «Токены API».\n- `account_token` — права на весь аккаунт: серверы, домены, подписи\n отправителей. Настройки аккаунта → «Токены API».\n\nКакой токен нужен методу — видно в заголовках его запроса.\n\nДокументация: [https://haskimail.ru/developer/](https://haskimail.ru/developer/).",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"auth": {
"type": "noauth"
},
"variable": [
{
"key": "base_url",
"value": "https://api.haskimail.ru",
"type": "string",
"description": "Базовый адрес API."
},
{
"key": "server_token",
"value": "",
"type": "string",
"description": "Токен сервера: настройки сервера → «Токены API». Права в пределах одного сервера."
},
{
"key": "account_token",
"value": "",
"type": "string",
"description": "Токен аккаунта: настройки аккаунта → «Токены API». Права на весь аккаунт — серверы, домены, подписи."
}
],
"item": [
{
"name": "API для отправки писем",
"description": "Этот API-эндпоинт предназначен для отправки писем через сервер Haskimail. Для пакетной отправки (ссылку нужно будет добавить) предусмотрена отдельная конечная точка, которая позволяет отправлять до 500 сообщений (до 50 МБ, включая вложения) за один вызов.",
"item": [
{
"name": "Отправка одного письма",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/email",
"host": [
"{{base_url}}"
],
"path": [
"email"
]
},
"description": "**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса необходимы права на уровне сервера. Этот токен можно найти на вкладке «Токены API» в настройках вашего сервера Haskimail. |\n\n**Параметры тела запроса**\n\n| From | string | обязательный Адрес электронной почты отправителя. Необходимо наличие зарегистрированной и подтвержденной Подписи отправителя. Чтобы указать имя, используйте формат `\"Имя Фамилия <отправитель@домен.com>\"`. Знаки препинания в имени необходимо экранировать. |\n| --- | --- | --- |\n| To | string | обязательный Адрес электронной почты получателя. Несколько адресов разделяются запятой. Не более 50. |\n| Cc | string | Получатель копии (Cc). Несколько адресов разделяются запятой. Не более 50. |\n| Bcc | string | Получатель скрытой копии (Bcc). Несколько адресов разделяются запятой. Не более 50. |\n| Subject | string | Тема письма |\n| Tag | string | Тег, который позволяет категоризировать исходящие письма и получать подробную статистику. Не более 1000 символов. |\n| HtmlBody | string | обязательный Если не указан `TextBody` задает тело письма в формате HTML. |\n| TextBody | string | обязательный Если не указан `HtmlBody` задает тело письма в виде простого текста. |\n| ReplyTo | string | Адрес для ответа. Позволяет переопределить адрес, указанный по умолчанию в Подписи отправителя. Несколько адресов разделяются запятой. |\n| Headers | array | Список пользовательских заголовков для добавления в письмо. |\n| TrackOpens | boolean | Активировать отслеживание открытий для этого письма. |\n| TrackLinks | boolean | Активировать отслеживание ссылок для этого письма. |\n| Metadata | object | Пользовательские метаданные в формате пар «ключ-значение». |\n| TemplateModel | object | Пользовательские данные для подстановки в письмо в формате пар «ключ-значение». |\n| Attachments | array | Список вложений. |\n| MessageStream | integer | Идентификатор (ID) Канала, используемого для отправки. Если не указан, по умолчанию будет использован транзакционный канал \"outbound\". |\n\n**Ответ**\n\n| To | string | Email-адрес получателя |\n| --- | --- | --- |\n| SubmittedAt | string | Временная метка |\n| MessageID | string | Идентификатор сообщения |\n| ErrorCode | integer | [Коды ошибок API](/developer/api/overview#error-codes) |\n| Message | string | Текст ответа |\n\n[Метод в документации](https://haskimail.ru/developer/email-api/#send-a-single-email)",
"body": {
"mode": "raw",
"raw": "{\n \"From\": \"отправитель@example.com\",\n \"To\": \"получатель@example.com\",\n \"Subject\": \"Haskimail тест\",\n \"TextBody\": \"Привет, дорогой клиент Haskimail.\",\n \"HtmlBody\": \"Привет дорогой клиент Haskimail. \"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/email",
"host": [
"{{base_url}}"
],
"path": [
"email"
]
},
"description": "**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса необходимы права на уровне сервера. Этот токен можно найти на вкладке «Токены API» в настройках вашего сервера Haskimail. |\n\n**Параметры тела запроса**\n\n| From | string | обязательный Адрес электронной почты отправителя. Необходимо наличие зарегистрированной и подтвержденной Подписи отправителя. Чтобы указать имя, используйте формат `\"Имя Фамилия <отправитель@домен.com>\"`. Знаки препинания в имени необходимо экранировать. |\n| --- | --- | --- |\n| To | string | обязательный Адрес электронной почты получателя. Несколько адресов разделяются запятой. Не более 50. |\n| Cc | string | Получатель копии (Cc). Несколько адресов разделяются запятой. Не более 50. |\n| Bcc | string | Получатель скрытой копии (Bcc). Несколько адресов разделяются запятой. Не более 50. |\n| Subject | string | Тема письма |\n| Tag | string | Тег, который позволяет категоризировать исходящие письма и получать подробную статистику. Не более 1000 символов. |\n| HtmlBody | string | обязательный Если не указан `TextBody` задает тело письма в формате HTML. |\n| TextBody | string | обязательный Если не указан `HtmlBody` задает тело письма в виде простого текста. |\n| ReplyTo | string | Адрес для ответа. Позволяет переопределить адрес, указанный по умолчанию в Подписи отправителя. Несколько адресов разделяются запятой. |\n| Headers | array | Список пользовательских заголовков для добавления в письмо. |\n| TrackOpens | boolean | Активировать отслеживание открытий для этого письма. |\n| TrackLinks | boolean | Активировать отслеживание ссылок для этого письма. |\n| Metadata | object | Пользовательские метаданные в формате пар «ключ-значение». |\n| TemplateModel | object | Пользовательские данные для подстановки в письмо в формате пар «ключ-значение». |\n| Attachments | array | Список вложений. |\n| MessageStream | integer | Идентификатор (ID) Канала, используемого для отправки. Если не указан, по умолчанию будет использован транзакционный канал \"outbound\". |\n\n**Ответ**\n\n| To | string | Email-адрес получателя |\n| --- | --- | --- |\n| SubmittedAt | string | Временная метка |\n| MessageID | string | Идентификатор сообщения |\n| ErrorCode | integer | [Коды ошибок API](/developer/api/overview#error-codes) |\n| Message | string | Текст ответа |\n\n[Метод в документации](https://haskimail.ru/developer/email-api/#send-a-single-email)",
"body": {
"mode": "raw",
"raw": "{\n \"From\": \"отправитель@example.com\",\n \"To\": \"получатель@example.com\",\n \"Subject\": \"Haskimail тест\",\n \"TextBody\": \"Привет, дорогой клиент Haskimail.\",\n \"HtmlBody\": \"Привет дорогой клиент Haskimail. \"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"To\": \"получатель@example.com\",\n \"SubmittedAt\": \"2014-02-17T07:25:01.4178645-05:00\",\n \"MessageID\": \"0a129aee-e1cd-480d-b08d-4f48548ff48d\",\n \"ErrorCode\": 0,\n \"Message\": \"OK\"\n}"
}
]
},
{
"name": "Пакетная отправка писем",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/email/batch",
"host": [
"{{base_url}}"
],
"path": [
"email",
"batch"
]
},
"description": "**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса необходимы права на уровне сервера. Этот токен можно найти на вкладке «Токены API» в настройках вашего сервера Haskimail. |\n\n**Параметры тела запроса**\n\n| From | string | обязательный Адрес электронной почты отправителя. Должен иметь зарегистрированную и подтвержденную Подпись отправителя. Чтобы указать имя, используйте формат `\"Имя Фамилия \"`. Знаки препинания в имени должны быть экранированы. |\n| --- | --- | --- |\n| To | string | обязательный Адрес электронной почты получателя. Несколько адресов указываются через запятую. Максимум 50. |\n| Cc | string | Адрес электронной почты получателя копии (Cc). Несколько адресов указываются через запятую. Максимум 50. |\n| Bcc | string | Адрес электронной почты получателя скрытой копии (Bcc). Несколько адресов указываются через запятую. Максимум 50. |\n| Subject | string | Тема письма. |\n| Tag | string | Тег для категоризации исходящих писем и сбора подробной статистики. Максимальная длина 1000 символов. |\n| HtmlBody | string | HTML-содержимое письма. Используется, если не указан `TextBody`. |\n| TextBody | string | Текстовое содержимое письма. Используется, если не указан `HtmlBody` |\n| ReplyTo | string | Адрес для ответа, переопределяющий стандартный. По умолчанию используется адрес, указанный в подписи отправителя. |\n| Headers | array | Список пользовательских заголовков для добавления в письмо. |\n| TrackOpens | boolean | Активировать отслеживание открытий для этого письма. |\n| TrackLinks | boolean | Активировать отслеживание переходов по ссылкам для этого письма. |\n| Metadata | object | Пользовательские метаданные в формате пар «ключ-значение». |\n| Attachments | array | Список вложений. |\n| MessageStream | integer | ID Канала, который используется для отправки. Если не указан, по умолчанию используется транзакционный канал «outbound». |\n\n**Ответ**\n\nОбратите внимание, что конечная точка `/batch` всегда возвращает HTTP-статус 200, даже если при валидации отдельных сообщений возникли ошибки. Пользователям этого эндпоинта следует проверять код успеха и ошибки для каждого сообщения в ответе от нашего API (ответы в массиве расположены в том же порядке, что и отправленные сообщения).\n\n| To | string | Адрес электронной почты получателя. |\n| --- | --- | --- |\n| SubmittedAt | string | Временная метка отправки. |\n| MessageID | string | ID сообщения. |\n| ErrorCode | integer | [Коды ошибок API](/developer/api/overview#error-codes) |\n| Message | string | Сообщение ответа |\n\n[Метод в документации](https://haskimail.ru/developer/email-api/#send-batch-emails)",
"body": {
"mode": "raw",
"raw": "[\n {\n \"From\": \"отправитель@example.com\",\n \"To\": \"receiver1@example.com\",\n \"Subject\": \"Haskimail тест #1\",\n \"TextBody\": \"Привет, дорогой клиент Haskimail.\",\n \"HtmlBody\": \"Привет дорогой клиент Haskimail. \"\n },\n {\n \"From\": \"отправитель@example.com\",\n \"To\": \"receiver2@example.com\",\n \"Subject\": \"Haskimail тест #2\",\n \"TextBody\": \"Привет, дорогой клиент Haskimail.\",\n \"HtmlBody\": \"Привет дорогой клиент Haskimail. \"\n }\n]",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/email/batch",
"host": [
"{{base_url}}"
],
"path": [
"email",
"batch"
]
},
"description": "**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса необходимы права на уровне сервера. Этот токен можно найти на вкладке «Токены API» в настройках вашего сервера Haskimail. |\n\n**Параметры тела запроса**\n\n| From | string | обязательный Адрес электронной почты отправителя. Должен иметь зарегистрированную и подтвержденную Подпись отправителя. Чтобы указать имя, используйте формат `\"Имя Фамилия \"`. Знаки препинания в имени должны быть экранированы. |\n| --- | --- | --- |\n| To | string | обязательный Адрес электронной почты получателя. Несколько адресов указываются через запятую. Максимум 50. |\n| Cc | string | Адрес электронной почты получателя копии (Cc). Несколько адресов указываются через запятую. Максимум 50. |\n| Bcc | string | Адрес электронной почты получателя скрытой копии (Bcc). Несколько адресов указываются через запятую. Максимум 50. |\n| Subject | string | Тема письма. |\n| Tag | string | Тег для категоризации исходящих писем и сбора подробной статистики. Максимальная длина 1000 символов. |\n| HtmlBody | string | HTML-содержимое письма. Используется, если не указан `TextBody`. |\n| TextBody | string | Текстовое содержимое письма. Используется, если не указан `HtmlBody` |\n| ReplyTo | string | Адрес для ответа, переопределяющий стандартный. По умолчанию используется адрес, указанный в подписи отправителя. |\n| Headers | array | Список пользовательских заголовков для добавления в письмо. |\n| TrackOpens | boolean | Активировать отслеживание открытий для этого письма. |\n| TrackLinks | boolean | Активировать отслеживание переходов по ссылкам для этого письма. |\n| Metadata | object | Пользовательские метаданные в формате пар «ключ-значение». |\n| Attachments | array | Список вложений. |\n| MessageStream | integer | ID Канала, который используется для отправки. Если не указан, по умолчанию используется транзакционный канал «outbound». |\n\n**Ответ**\n\nОбратите внимание, что конечная точка `/batch` всегда возвращает HTTP-статус 200, даже если при валидации отдельных сообщений возникли ошибки. Пользователям этого эндпоинта следует проверять код успеха и ошибки для каждого сообщения в ответе от нашего API (ответы в массиве расположены в том же порядке, что и отправленные сообщения).\n\n| To | string | Адрес электронной почты получателя. |\n| --- | --- | --- |\n| SubmittedAt | string | Временная метка отправки. |\n| MessageID | string | ID сообщения. |\n| ErrorCode | integer | [Коды ошибок API](/developer/api/overview#error-codes) |\n| Message | string | Сообщение ответа |\n\n[Метод в документации](https://haskimail.ru/developer/email-api/#send-batch-emails)",
"body": {
"mode": "raw",
"raw": "[\n {\n \"From\": \"отправитель@example.com\",\n \"To\": \"receiver1@example.com\",\n \"Subject\": \"Haskimail тест #1\",\n \"TextBody\": \"Привет, дорогой клиент Haskimail.\",\n \"HtmlBody\": \"Привет дорогой клиент Haskimail. \"\n },\n {\n \"From\": \"отправитель@example.com\",\n \"To\": \"receiver2@example.com\",\n \"Subject\": \"Haskimail тест #2\",\n \"TextBody\": \"Привет, дорогой клиент Haskimail.\",\n \"HtmlBody\": \"Привет дорогой клиент Haskimail. \"\n }\n]",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "[\n {\n \"ErrorCode\": 0,\n \"Message\": \"OK\",\n \"MessageID\": \"b7bc2f4a-e38e-4336-af7d-e6c392c2f817\",\n \"SubmittedAt\": \"2010-11-26T12:01:05.1794748-05:00\",\n \"To\": \"receiver1@example.com\"\n },\n {\n \"ErrorCode\": 406,\n \"Message\": \"Вы попытались отправить письмо получателю, который был помечен как неактивный. Найдены неактивные адреса: example@example.com. К неактивным относятся получатели, по которым произошел постоянный возврат (hard bounce), поступила жалоба на спам или которые были заблокированы вручную.\"\n }\n]"
}
]
}
]
},
{
"name": "API Сообщений",
"description": "Позволяет получить подробную информацию о любом исходящем или входящем сообщении, отправленном или полученном через определенный сервер. Сообщения удаляются по истечении периода хранения, который по умолчанию составляет 45 дней (но может быть настроен в диапазоне от 7 до 365 дней).",
"item": [
{
"name": "Поиск писем",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/messages?recipient=john.doe%40yahoo.com&count=50&offset=0&tag=welcome&status=sent&todate=2015-01-12&fromdate=2015-01-01",
"host": [
"{{base_url}}"
],
"path": [
"messages"
],
"query": [
{
"key": "recipient",
"value": "john.doe@yahoo.com",
"description": ""
},
{
"key": "count",
"value": "50",
"description": ""
},
{
"key": "offset",
"value": "0",
"description": ""
},
{
"key": "tag",
"value": "welcome",
"description": ""
},
{
"key": "status",
"value": "sent",
"description": ""
},
{
"key": "todate",
"value": "2015-01-12",
"description": ""
},
{
"key": "fromdate",
"value": "2015-01-01",
"description": ""
}
]
},
"description": "Поиск сообщений позволяет вернуть до 10 000 сообщений за один запрос. Для запросов, где необходимо получить более 10 000 сообщений, используйте параметры `todate` и `fromdate` для фильтрации.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры строки запроса**\n\n| count | обязательный Количество сообщений, возвращаемых в одном запросе. Макс. 500. Сумма count и offset не может превышать 10 000. |\n| --- | --- |\n| offset | обязательный Количество сообщений, которое нужно пропустить. Сумма count и offset не может превышать 10 000. |\n| recipient | Фильтровать по получателю письма. |\n| fromemail | Фильтровать по email-адресу отправителя. |\n| tag | Фильтровать по тегу. |\n| todate | Фильтровать сообщения до указанной даты/времени (включительно). Например, 2021-01-01T12:00:00. Наш API использует время МСК. |\n| fromdate | Фильтровать сообщения начиная с указанной даты/времени (включительно). Например, 2021-01-01T12:00:00. Наш API использует время МСК. |\n| messagestream | Фильтровать по ID канала. Если не указан, по умолчанию будет использоваться исходящий транзакционный канал 'outbound'. |\n\n**Ответ**\n\n| TotalCount | integer | Указывает количество сообщений, соответствующих указанным вами критериям поиска. |\n| --- | --- | --- |\n| Messages | array | Список объектов, каждый из которых представляет одно сообщение. |\n\n[Метод в документации](https://haskimail.ru/developer/messages-api/#outbound-message-search)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/messages?recipient=john.doe%40yahoo.com&count=50&offset=0&tag=welcome&status=sent&todate=2015-01-12&fromdate=2015-01-01",
"host": [
"{{base_url}}"
],
"path": [
"messages"
],
"query": [
{
"key": "recipient",
"value": "john.doe@yahoo.com",
"description": ""
},
{
"key": "count",
"value": "50",
"description": ""
},
{
"key": "offset",
"value": "0",
"description": ""
},
{
"key": "tag",
"value": "welcome",
"description": ""
},
{
"key": "status",
"value": "sent",
"description": ""
},
{
"key": "todate",
"value": "2015-01-12",
"description": ""
},
{
"key": "fromdate",
"value": "2015-01-01",
"description": ""
}
]
},
"description": "Поиск сообщений позволяет вернуть до 10 000 сообщений за один запрос. Для запросов, где необходимо получить более 10 000 сообщений, используйте параметры `todate` и `fromdate` для фильтрации.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры строки запроса**\n\n| count | обязательный Количество сообщений, возвращаемых в одном запросе. Макс. 500. Сумма count и offset не может превышать 10 000. |\n| --- | --- |\n| offset | обязательный Количество сообщений, которое нужно пропустить. Сумма count и offset не может превышать 10 000. |\n| recipient | Фильтровать по получателю письма. |\n| fromemail | Фильтровать по email-адресу отправителя. |\n| tag | Фильтровать по тегу. |\n| todate | Фильтровать сообщения до указанной даты/времени (включительно). Например, 2021-01-01T12:00:00. Наш API использует время МСК. |\n| fromdate | Фильтровать сообщения начиная с указанной даты/времени (включительно). Например, 2021-01-01T12:00:00. Наш API использует время МСК. |\n| messagestream | Фильтровать по ID канала. Если не указан, по умолчанию будет использоваться исходящий транзакционный канал 'outbound'. |\n\n**Ответ**\n\n| TotalCount | integer | Указывает количество сообщений, соответствующих указанным вами критериям поиска. |\n| --- | --- | --- |\n| Messages | array | Список объектов, каждый из которых представляет одно сообщение. |\n\n[Метод в документации](https://haskimail.ru/developer/messages-api/#outbound-message-search)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"TotalCount\": 194,\n \"Messages\": [\n {\n \"Tag\": \"Invitation\",\n \"MessageID\": \"0ac29aee-e1cd-480d-b08d-4f48548ff48d\",\n \"MessageStream\": \"outbound\",\n \"Recipient\": \"john.doe@yahoo.com\",\n \"ReceivedAt\": \"2014-02-20T07:25:02.8782715-05:00\",\n \"From\": \"\\\"Joe\\\" \",\n \"Subject\": \"staging\",\n \"Status\": \"Sent\"\n }\n ]\n}"
}
]
},
{
"name": "Детали письма",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/messages/:messageid/details",
"host": [
"{{base_url}}"
],
"path": [
"messages",
":messageid",
"details"
],
"variable": [
{
"key": "messageid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| Tag | string | Теги, связанные с этим сообщением. |\n| --- | --- | --- |\n| MessageID | string | Уникальный ID сообщения. |\n| MessageStream | string | Исходящий канал, использованный для отправки сообщения. |\n| Recipient | string | Адрес, на который отправлено сообщение. |\n| ReceivedAt | string | Временная метка отправки сообщения сервисом Haskimail. Соответствует событию «Обработано» (Processed) в интерфейсе. |\n| From | string | Email-адрес отправителя. |\n| Subject | string | Тема письма. |\n| Status | string | Статус сообщения в вашей Активности Haskimail. |\n\n[Метод в документации](https://haskimail.ru/developer/messages-api/#outbound-message-details)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/messages/:messageid/details",
"host": [
"{{base_url}}"
],
"path": [
"messages",
":messageid",
"details"
],
"variable": [
{
"key": "messageid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| Tag | string | Теги, связанные с этим сообщением. |\n| --- | --- | --- |\n| MessageID | string | Уникальный ID сообщения. |\n| MessageStream | string | Исходящий канал, использованный для отправки сообщения. |\n| Recipient | string | Адрес, на который отправлено сообщение. |\n| ReceivedAt | string | Временная метка отправки сообщения сервисом Haskimail. Соответствует событию «Обработано» (Processed) в интерфейсе. |\n| From | string | Email-адрес отправителя. |\n| Subject | string | Тема письма. |\n| Status | string | Статус сообщения в вашей Активности Haskimail. |\n\n[Метод в документации](https://haskimail.ru/developer/messages-api/#outbound-message-details)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"Tag\": \"product-orders\",\n \"MessageID\": \"07311c54-0687-4ab9-b034-b54b5bad88ba\",\n \"MessageStream\": \"outbound\",\n \"Recipient\": \"john.doe@yahoo.com\",\n \"ReceivedAt\": \"2014-02-14T11:12:54.8054242-05:00\",\n \"From\": \"\\\"Joe\\\" \",\n \"Subject\": \"Parts Order #5454\",\n \"Status\": \"Sent\"\n}"
}
]
},
{
"name": "Открытия писем",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/messages/opens?recipient=john.doe%40yahoo.com&count=50&offset=0",
"host": [
"{{base_url}}"
],
"path": [
"messages",
"opens"
],
"query": [
{
"key": "recipient",
"value": "john.doe@yahoo.com",
"description": ""
},
{
"key": "count",
"value": "50",
"description": ""
},
{
"key": "offset",
"value": "0",
"description": ""
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры строки запроса**\n\n| count | обязательный Количество сообщений, возвращаемых в одном запросе. Максимум 500. Сумма count и offset не может превышать 10 000. |\n| --- | --- |\n| offset | обязательный Количество пропускаемых сообщений. Сумма count и offset не может превышать 10 000. |\n| recipient | Фильтровать по получателю. |\n| tag | Фильтровать по тегу. |\n| messagestream | Фильтровать по ID канала. Если не указано, поиск по умолчанию будет производиться по исходящему транзакционному каналу. |\n\n**Ответ**\n\n**Постоянные поля**\n\nЭти поля будут возвращаться всегда.\n\n| TotalCount | integer | Указывает, сколько открытий соответствует указанным вами критериям поиска. Это число может быть больше, чем количество, полученное в одном запросе. |\n| --- | --- | --- |\n| Opens | array | Список записей, каждый из которых представляет одно открытие письма. |\n| MessageID | string | Уникальный ID сообщения. |\n| MessageStream | string | Исходящий канал, использованный для отправки сообщения. |\n| ReceivedAt | string | Временная метка, когда сообщение было открыто. |\n\n[Метод в документации](https://haskimail.ru/developer/messages-api/#message-opens)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/messages/opens?recipient=john.doe%40yahoo.com&count=50&offset=0",
"host": [
"{{base_url}}"
],
"path": [
"messages",
"opens"
],
"query": [
{
"key": "recipient",
"value": "john.doe@yahoo.com",
"description": ""
},
{
"key": "count",
"value": "50",
"description": ""
},
{
"key": "offset",
"value": "0",
"description": ""
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры строки запроса**\n\n| count | обязательный Количество сообщений, возвращаемых в одном запросе. Максимум 500. Сумма count и offset не может превышать 10 000. |\n| --- | --- |\n| offset | обязательный Количество пропускаемых сообщений. Сумма count и offset не может превышать 10 000. |\n| recipient | Фильтровать по получателю. |\n| tag | Фильтровать по тегу. |\n| messagestream | Фильтровать по ID канала. Если не указано, поиск по умолчанию будет производиться по исходящему транзакционному каналу. |\n\n**Ответ**\n\n**Постоянные поля**\n\nЭти поля будут возвращаться всегда.\n\n| TotalCount | integer | Указывает, сколько открытий соответствует указанным вами критериям поиска. Это число может быть больше, чем количество, полученное в одном запросе. |\n| --- | --- | --- |\n| Opens | array | Список записей, каждый из которых представляет одно открытие письма. |\n| MessageID | string | Уникальный ID сообщения. |\n| MessageStream | string | Исходящий канал, использованный для отправки сообщения. |\n| ReceivedAt | string | Временная метка, когда сообщение было открыто. |\n\n[Метод в документации](https://haskimail.ru/developer/messages-api/#message-opens)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"TotalCount\": 1,\n \"Opens\": [\n {\n \"MessageID\": \"927e56d4-dc66-4070-bbf0-1db76c2ae14b\",\n \"MessageStream\": \"outbound\",\n \"ReceivedAt\": \"2014-04-30T05:04:23.8768746-04:00\",\n \"Tag\": \"welcome-user\",\n \"Recipient\": \"john.doe@yahoo.com\"\n }\n ]\n}"
}
]
},
{
"name": "Открытия для одного письма",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/messages/opens/:messageid?count=10&offset=0",
"host": [
"{{base_url}}"
],
"path": [
"messages",
"opens",
":messageid"
],
"query": [
{
"key": "count",
"value": "10",
"description": ""
},
{
"key": "offset",
"value": "0",
"description": ""
}
],
"variable": [
{
"key": "messageid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры строки запроса**\n\n| count | обязательный Количество открытий, возвращаемых в одном запросе. Максимум 500. |\n| --- | --- |\n| offset | обязательный Количество пропускаемых открытий. |\n\n**Ответ**\n\n**Постоянные поля**\n\nЭти поля будут возвращаться всегда.\n\n| TotalCount | integer | API Haskimail сохраняет только первое открытие, поэтому TotalCount всегда будет равен «1». Вебхук открытий (Open Webhook) будет отправлять уведомления о каждом отдельном открытии, если это необходимо. |\n| --- | --- | --- |\n| Opens | array | Список записей, каждый из которых представляет одно открытие письма. Обратите внимание, что одно открытие привязано к одному получателю. Поэтому, если одно и то же письмо было отправлено двум получателям и оба его открыли, это будет представлено двумя записями в данном массиве. |\n| MessageID | string | Уникальный ID сообщения. |\n| MessageStream | string | Исходящий канал, использованный для отправки сообщения. |\n\n[Метод в документации](https://haskimail.ru/developer/messages-api/#opens-for-message)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/messages/opens/:messageid?count=10&offset=0",
"host": [
"{{base_url}}"
],
"path": [
"messages",
"opens",
":messageid"
],
"query": [
{
"key": "count",
"value": "10",
"description": ""
},
{
"key": "offset",
"value": "0",
"description": ""
}
],
"variable": [
{
"key": "messageid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры строки запроса**\n\n| count | обязательный Количество открытий, возвращаемых в одном запросе. Максимум 500. |\n| --- | --- |\n| offset | обязательный Количество пропускаемых открытий. |\n\n**Ответ**\n\n**Постоянные поля**\n\nЭти поля будут возвращаться всегда.\n\n| TotalCount | integer | API Haskimail сохраняет только первое открытие, поэтому TotalCount всегда будет равен «1». Вебхук открытий (Open Webhook) будет отправлять уведомления о каждом отдельном открытии, если это необходимо. |\n| --- | --- | --- |\n| Opens | array | Список записей, каждый из которых представляет одно открытие письма. Обратите внимание, что одно открытие привязано к одному получателю. Поэтому, если одно и то же письмо было отправлено двум получателям и оба его открыли, это будет представлено двумя записями в данном массиве. |\n| MessageID | string | Уникальный ID сообщения. |\n| MessageStream | string | Исходящий канал, использованный для отправки сообщения. |\n\n[Метод в документации](https://haskimail.ru/developer/messages-api/#opens-for-message)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"TotalCount\": 1,\n \"Opens\": [\n {\n \"MessageID\": \"927e56d4-dc66-4070-bbf0-1db76c2ae14b\",\n \"MessageStream\": \"outbound\",\n \"ReceivedAt\": \"2014-04-30T05:04:23.8768746-04:00\",\n \"Tag\": \"welcome-user\",\n \"Recipient\": \"john.doe@yahoo.com\"\n }\n ]\n}"
}
]
},
{
"name": "Клики по ссылкам в письмах",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/messages/clicks?recipient=john.doe%40yahoo.com&count=50&offset=0",
"host": [
"{{base_url}}"
],
"path": [
"messages",
"clicks"
],
"query": [
{
"key": "recipient",
"value": "john.doe@yahoo.com",
"description": ""
},
{
"key": "count",
"value": "50",
"description": ""
},
{
"key": "offset",
"value": "0",
"description": ""
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры строки запроса**\n\n| count | обязательный Количество кликов, возвращаемых в одном запросе. Максимум 500. |\n| --- | --- |\n| offset | обязательный Количество пропускаемых кликов. |\n| recipient | Фильтровать по получателю (To, Cc, Bcc). |\n| tag | Фильтровать по тегу. |\n| messagestream | Фильтровать по ID канала. Если не указано, поиск по умолчанию будет производиться по исходящему транзакционному каналу. |\n\n**Ответ**\n\n**Постоянные поля**\n\nЭти поля будут возвращаться всегда.\n\n| TotalCount | integer | Указывает, сколько кликов соответствует указанным вами критериям поиска. Это число может быть больше, чем количество, полученное в одном запросе. |\n| --- | --- | --- |\n| Clicks | array | Список событий, каждое из которых представляет один клик по ссылке. Обратите внимание, что каждый клик привязан к конкретному получателю и уникальной ссылке. Если письмо было отправлено двум получателям и оба кликнули по ссылкам, каждое такое событие будет отражено в этом массиве. |\n| MessageID | string | Уникальный ID сообщения. |\n| ReceivedAt | string | Временная метка, когда был совершен клик по ссылке. |\n\n[Метод в документации](https://haskimail.ru/developer/messages-api/#message-clicks)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/messages/clicks?recipient=john.doe%40yahoo.com&count=50&offset=0",
"host": [
"{{base_url}}"
],
"path": [
"messages",
"clicks"
],
"query": [
{
"key": "recipient",
"value": "john.doe@yahoo.com",
"description": ""
},
{
"key": "count",
"value": "50",
"description": ""
},
{
"key": "offset",
"value": "0",
"description": ""
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры строки запроса**\n\n| count | обязательный Количество кликов, возвращаемых в одном запросе. Максимум 500. |\n| --- | --- |\n| offset | обязательный Количество пропускаемых кликов. |\n| recipient | Фильтровать по получателю (To, Cc, Bcc). |\n| tag | Фильтровать по тегу. |\n| messagestream | Фильтровать по ID канала. Если не указано, поиск по умолчанию будет производиться по исходящему транзакционному каналу. |\n\n**Ответ**\n\n**Постоянные поля**\n\nЭти поля будут возвращаться всегда.\n\n| TotalCount | integer | Указывает, сколько кликов соответствует указанным вами критериям поиска. Это число может быть больше, чем количество, полученное в одном запросе. |\n| --- | --- | --- |\n| Clicks | array | Список событий, каждое из которых представляет один клик по ссылке. Обратите внимание, что каждый клик привязан к конкретному получателю и уникальной ссылке. Если письмо было отправлено двум получателям и оба кликнули по ссылкам, каждое такое событие будет отражено в этом массиве. |\n| MessageID | string | Уникальный ID сообщения. |\n| ReceivedAt | string | Временная метка, когда был совершен клик по ссылке. |\n\n[Метод в документации](https://haskimail.ru/developer/messages-api/#message-clicks)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"TotalCount\": 1,\n \"Clicks\": [\n {\n \"MessageID\": \"927e56d4-dc66-4070-bbf0-1db76c2ae14b\",\n \"OriginalLink\": \"https://example.com\",\n \"MessageStream\": \"Outbound\",\n \"ReceivedAt\": \"2014-04-30T05:04:23.8768746-04:00\",\n \"Tag\": \"welcome-user\",\n \"Recipient\": \"john.doe@yahoo.com\"\n }\n ]\n}"
}
]
},
{
"name": "Клики по ссылкам в одном письме",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/messages/clicks/:messageid?count=10&offset=0",
"host": [
"{{base_url}}"
],
"path": [
"messages",
"clicks",
":messageid"
],
"query": [
{
"key": "count",
"value": "10",
"description": ""
},
{
"key": "offset",
"value": "0",
"description": ""
}
],
"variable": [
{
"key": "messageid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры строки запроса**\n\n| count | обязательный Количество кликов, возвращаемых в одном запросе. Максимум 500. |\n| --- | --- |\n| offset | обязательный Количество пропускаемых кликов. |\n\n**Ответ**\n\n**Постоянные поля**\n\nЭти поля будут возвращаться всегда.\n\n| TotalCount | integer | Указывает, сколько кликов соответствует указанным вами критериям поиска. Это число может быть больше, чем количество, полученное в одном запросе. |\n| --- | --- | --- |\n| Clicks | array | Список событий, каждое из которых представляет один клик по ссылке. Обратите внимание, что каждый клик привязан к конкретному получателю и уникальной ссылке. Если письмо было отправлено двум получателям и оба кликнули по ссылкам, каждое такое событие будет отражено в этом массиве. |\n| MessageID | string | Уникальный ID сообщения. |\n| MessageStream | string | Исходящий канал, использованный для отправки сообщения.. |\n| ReceivedAt | string | Временная метка, когда был совершен клик по ссылке. |\n\n[Метод в документации](https://haskimail.ru/developer/messages-api/#clicks-for-message)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/messages/clicks/:messageid?count=10&offset=0",
"host": [
"{{base_url}}"
],
"path": [
"messages",
"clicks",
":messageid"
],
"query": [
{
"key": "count",
"value": "10",
"description": ""
},
{
"key": "offset",
"value": "0",
"description": ""
}
],
"variable": [
{
"key": "messageid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры строки запроса**\n\n| count | обязательный Количество кликов, возвращаемых в одном запросе. Максимум 500. |\n| --- | --- |\n| offset | обязательный Количество пропускаемых кликов. |\n\n**Ответ**\n\n**Постоянные поля**\n\nЭти поля будут возвращаться всегда.\n\n| TotalCount | integer | Указывает, сколько кликов соответствует указанным вами критериям поиска. Это число может быть больше, чем количество, полученное в одном запросе. |\n| --- | --- | --- |\n| Clicks | array | Список событий, каждое из которых представляет один клик по ссылке. Обратите внимание, что каждый клик привязан к конкретному получателю и уникальной ссылке. Если письмо было отправлено двум получателям и оба кликнули по ссылкам, каждое такое событие будет отражено в этом массиве. |\n| MessageID | string | Уникальный ID сообщения. |\n| MessageStream | string | Исходящий канал, использованный для отправки сообщения.. |\n| ReceivedAt | string | Временная метка, когда был совершен клик по ссылке. |\n\n[Метод в документации](https://haskimail.ru/developer/messages-api/#clicks-for-message)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"TotalCount\": 1,\n \"Clicks\": [\n {\n \"OriginalLink\": \"https://example.com\",\n \"MessageID\": \"927e56d4-dc66-4070-bbf0-1db76c2ae14b\",\n \"MessageStream\": \"outbound\",\n \"ReceivedAt\": \"2014-04-30T05:04:23.8768746-04:00\",\n \"Tag\": \"welcome-user\",\n \"Recipient\": \"john.doe@yahoo.com\"\n }\n ]\n}"
}
]
}
]
},
{
"name": "API возвратов",
"description": "Позволяет получить доступ ко всем отчетам о ваших отклоненных письмах для конкретного сервера. Информация об отклоненных письмах доступна в течение периода хранения, который по умолчанию составляет 45 дней.",
"item": [
{
"name": "Получение статистики по доставке",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/deliverystats",
"host": [
"{{base_url}}"
],
"path": [
"deliverystats"
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| InactiveMails | integer | Количество неактивных email-адресов. |\n| --- | --- | --- |\n| Bounces | array | Список типов отклоненных писем с общим количеством по каждому типу. |\n\n[Метод в документации](https://haskimail.ru/developer/bounce-api/#delivery-stats)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/deliverystats",
"host": [
"{{base_url}}"
],
"path": [
"deliverystats"
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| InactiveMails | integer | Количество неактивных email-адресов. |\n| --- | --- | --- |\n| Bounces | array | Список типов отклоненных писем с общим количеством по каждому типу. |\n\n[Метод в документации](https://haskimail.ru/developer/bounce-api/#delivery-stats)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"Bounces\": [\n {\n \"Name\": \"All\",\n \"Count\": 253\n },\n {\n \"Type\": \"HardBounce\",\n \"Name\": \"Hard bounce\",\n \"Count\": 195\n },\n {\n \"Type\": \"BulkBounce\",\n \"Name\": \"Bulk Bounce\",\n \"Count\": 10\n },\n {\n \"Type\": \"SoftBounce\",\n \"Name\": \"Soft bounce\",\n \"Count\": 30\n },\n {\n \"Type\": \"SpamBlock\",\n \"Name\": \"Spam Block\",\n \"Count\": 1\n }\n ]\n}"
}
]
},
{
"name": "Получение списка возвратов",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/bounces?type=HardBounce&inactive=true&count=50&offset=0",
"host": [
"{{base_url}}"
],
"path": [
"bounces"
],
"query": [
{
"key": "type",
"value": "HardBounce",
"description": ""
},
{
"key": "inactive",
"value": "true",
"description": ""
},
{
"key": "count",
"value": "50",
"description": ""
},
{
"key": "offset",
"value": "0",
"description": ""
}
]
},
"description": "Поиск по отклоненным письмам позволяет получить до 10 000 записей за один запрос. Если вам нужно получить больше, используйте параметры, такие как `todate` и `fromdate`, для фильтрации результатов.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры строки запроса (Querystring)**\n\n| count | обязательный Количество отклоненных писем для возврата в одном запросе. Максимум 500. Сумма count и offset не может превышать 10 000. |\n| --- | --- |\n| offset | обязательный Количество отклоненных писем, которые нужно пропустить. Сумма count и offset не может превышать 10 000. |\n| type | Фильтровать по типу отклоненного письма |\n| emailFilter | Фильтровать по email-адресу |\n| tag | Фильтровать по тегу |\n| messageID | Фильтровать по ID сообщения (messageID). |\n| fromdate | Фильтровать сообщения, начиная с указанной даты/времени (включительно) по МСК. Например: YYYY-MM-DD HH:MM:SS. |\n| todate | Фильтровать сообщения до указанной даты/времени (включительно) по МСК. Например: YYYY-MM-DD HH:MM:SS. |\n| messagestream | Фильтровать по ID канала. Если не указано, по умолчанию будет использован исходящий транзакционный канал. |\n\n**Ответ**\n\n| TotalCount | integer | Количество возвращенных записей. |\n| --- | --- | --- |\n| Bounces | array | Список отдельных возвратов. |\n| RecordType | string | Тип записи |\n| ID | integer | ID возврата. |\n| Type | string | Тип возврата |\n| TypeCode | integer | Код возврата |\n| Name | string | Название возврата |\n| Tag | string | Название тега |\n| MessageID | string | ID сообщения |\n| ServerID | string | ID сервера, отправившего сообщение |\n| MessageStream | string | Исходящий канал, использованный для отправки сообщения. |\n| Description | string | Описание возврата |\n| Email | string | Email-адрес, с которого произошел возврат |\n| BouncedAt | string | TВременная метка возврата |\n| Subject | string | Тема письма |\n\n[Метод в документации](https://haskimail.ru/developer/bounce-api/#bounces)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/bounces?type=HardBounce&inactive=true&count=50&offset=0",
"host": [
"{{base_url}}"
],
"path": [
"bounces"
],
"query": [
{
"key": "type",
"value": "HardBounce",
"description": ""
},
{
"key": "inactive",
"value": "true",
"description": ""
},
{
"key": "count",
"value": "50",
"description": ""
},
{
"key": "offset",
"value": "0",
"description": ""
}
]
},
"description": "Поиск по отклоненным письмам позволяет получить до 10 000 записей за один запрос. Если вам нужно получить больше, используйте параметры, такие как `todate` и `fromdate`, для фильтрации результатов.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры строки запроса (Querystring)**\n\n| count | обязательный Количество отклоненных писем для возврата в одном запросе. Максимум 500. Сумма count и offset не может превышать 10 000. |\n| --- | --- |\n| offset | обязательный Количество отклоненных писем, которые нужно пропустить. Сумма count и offset не может превышать 10 000. |\n| type | Фильтровать по типу отклоненного письма |\n| emailFilter | Фильтровать по email-адресу |\n| tag | Фильтровать по тегу |\n| messageID | Фильтровать по ID сообщения (messageID). |\n| fromdate | Фильтровать сообщения, начиная с указанной даты/времени (включительно) по МСК. Например: YYYY-MM-DD HH:MM:SS. |\n| todate | Фильтровать сообщения до указанной даты/времени (включительно) по МСК. Например: YYYY-MM-DD HH:MM:SS. |\n| messagestream | Фильтровать по ID канала. Если не указано, по умолчанию будет использован исходящий транзакционный канал. |\n\n**Ответ**\n\n| TotalCount | integer | Количество возвращенных записей. |\n| --- | --- | --- |\n| Bounces | array | Список отдельных возвратов. |\n| RecordType | string | Тип записи |\n| ID | integer | ID возврата. |\n| Type | string | Тип возврата |\n| TypeCode | integer | Код возврата |\n| Name | string | Название возврата |\n| Tag | string | Название тега |\n| MessageID | string | ID сообщения |\n| ServerID | string | ID сервера, отправившего сообщение |\n| MessageStream | string | Исходящий канал, использованный для отправки сообщения. |\n| Description | string | Описание возврата |\n| Email | string | Email-адрес, с которого произошел возврат |\n| BouncedAt | string | TВременная метка возврата |\n| Subject | string | Тема письма |\n\n[Метод в документации](https://haskimail.ru/developer/bounce-api/#bounces)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"TotalCount\": 253,\n \"Bounces\": [\n {\n \"RecordType\": \"Bounce\",\n \"ID\": 692560173,\n \"Type\": \"HardBounce\",\n \"TypeCode\": 1,\n \"Name\": \"Hard bounce\",\n \"Tag\": \"Invitation\",\n \"MessageID\": \"2c1b63fe-43f2-4db5-91b0-8bdfa44a9316\",\n \"ServerID\": 23,\n \"MessageStream\": \"outbound\",\n \"Description\": \"The server was unable to deliver your message (ex: unknown user, mailbox not found).\",\n \"Email\": \"anything@blackhole.haskimail.ru\",\n \"BouncedAt\": \"2014-01-15T16:09:19Z\",\n \"Subject\": \"SC API5 Test\"\n },\n {\n \"RecordType\": \"Bounce\",\n \"ID\": 676862817,\n \"Type\": \"HardBounce\",\n \"TypeCode\": 1,\n \"Name\": \"Hard bounce\",\n \"Tag\": \"Invitation\",\n \"MessageID\": \"623b2e90-82d0-4050-ae9e-2c3a734ba091\",\n \"ServerID\": 23,\n \"MessageStream\": \"outbound\",\n \"Description\": \"The server was unable to deliver your message (ex: unknown user, mailbox not found).\",\n \"Email\": \"vicelcown@yahoo.com\",\n \"BouncedAt\": \"2013-10-18T09:49:59Z\",\n \"Subject\": \"Production API Test\"\n }\n ]\n}"
}
]
},
{
"name": "Получение информации о конкретном возврате",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/bounces/:bounceid",
"host": [
"{{base_url}}"
],
"path": [
"bounces",
":bounceid"
],
"variable": [
{
"key": "bounceid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ID | integer | ID возврата |\n| --- | --- | --- |\n| Type | string | Тип возврата |\n| TypeCode | integer | Код возврата |\n| Name | string | Название возврата |\n| Tag | string | Название тега |\n| MessageID | string | ID сообщения |\n| ServerID | string | ID сервера, отправившего сообщение. |\n| MessageStream | string | Исходящий канал, использованный для отправки сообщения. |\n| Description | string | Описание возврата |\n| Email | string | Email-адрес, с которого произошел возврат. |\n| BouncedAt | string | Временная метка возврата |\n| Subject | string | Тема письма |\n\n[Метод в документации](https://haskimail.ru/developer/bounce-api/#single-bounce)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/bounces/:bounceid",
"host": [
"{{base_url}}"
],
"path": [
"bounces",
":bounceid"
],
"variable": [
{
"key": "bounceid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ID | integer | ID возврата |\n| --- | --- | --- |\n| Type | string | Тип возврата |\n| TypeCode | integer | Код возврата |\n| Name | string | Название возврата |\n| Tag | string | Название тега |\n| MessageID | string | ID сообщения |\n| ServerID | string | ID сервера, отправившего сообщение. |\n| MessageStream | string | Исходящий канал, использованный для отправки сообщения. |\n| Description | string | Описание возврата |\n| Email | string | Email-адрес, с которого произошел возврат. |\n| BouncedAt | string | Временная метка возврата |\n| Subject | string | Тема письма |\n\n[Метод в документации](https://haskimail.ru/developer/bounce-api/#single-bounce)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"ID\": 692560173,\n \"Type\": \"HardBounce\",\n \"TypeCode\": 1,\n \"Name\": \"Hard bounce\",\n \"Tag\": \"Invitation\",\n \"MessageID\": \"2c1b63fe-43f2-4db5-91b0-8bdfa44a9316\",\n \"ServerID\": 23,\n \"MessageStream\": \"outbound\",\n \"Description\": \"The server was unable to deliver your message (ex: unknown user, mailbox not found).\",\n \"Email\": \"anything@blackhole.haskimail.ru\",\n \"BouncedAt\": \"2014-01-15T16:09:19.6421112-05:00\",\n \"Subject\": \"SC API5 Test\"\n}"
}
]
},
{
"name": "Активация возврата",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/bounces/:bounceid/activate",
"host": [
"{{base_url}}"
],
"path": [
"bounces",
":bounceid",
"activate"
],
"variable": [
{
"key": "bounceid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| Message | string | Сообщение ответа. |\n| --- | --- | --- |\n| Bounce | object | Детали возврата |\n| ID | integer | ID возврата |\n| Type | string | Тип возврата |\n| TypeCode | integer | Код возврата |\n| Name | string | Название возврата |\n| Tag | string | Название тега |\n| MessageID | string | ID сообщения |\n| ServerID | string | ID сервера, отправившего сообщение. |\n| MessageStream | string | Исходящий канал, использованный для отправки сообщения. |\n| Description | string | Описание возврата |\n| Email | string | Email-адрес, с которого произошел возврат |\n| BouncedAt | string | Временная метка возврата |\n\n[Метод в документации](https://haskimail.ru/developer/bounce-api/#activate-bounce)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/bounces/:bounceid/activate",
"host": [
"{{base_url}}"
],
"path": [
"bounces",
":bounceid",
"activate"
],
"variable": [
{
"key": "bounceid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| Message | string | Сообщение ответа. |\n| --- | --- | --- |\n| Bounce | object | Детали возврата |\n| ID | integer | ID возврата |\n| Type | string | Тип возврата |\n| TypeCode | integer | Код возврата |\n| Name | string | Название возврата |\n| Tag | string | Название тега |\n| MessageID | string | ID сообщения |\n| ServerID | string | ID сервера, отправившего сообщение. |\n| MessageStream | string | Исходящий канал, использованный для отправки сообщения. |\n| Description | string | Описание возврата |\n| Email | string | Email-адрес, с которого произошел возврат |\n| BouncedAt | string | Временная метка возврата |\n\n[Метод в документации](https://haskimail.ru/developer/bounce-api/#activate-bounce)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"Message\": \"OK\",\n \"Bounce\": {\n \"ID\": 692560173,\n \"Type\": \"HardBounce\",\n \"TypeCode\": 1,\n \"Name\": \"Hard bounce\",\n \"Tag\": \"Invitation\",\n \"MessageID\": \"2c1b63fe-43f2-4db5-91b0-8bdfa44a9316\",\n \"ServerID\": 23,\n \"MessageStream\": \"outbound\",\n \"Description\": \"The server was unable to deliver your message (ex: unknown user, mailbox not found).\",\n \"Email\": \"anything@blackhole.haskimail.ru\",\n \"BouncedAt\": \"2014-01-15T16:09:19.6421112-05:00\",\n \"Subject\": \"SC API5 Test\"\n }\n}"
}
]
}
]
},
{
"name": "API Шаблонов",
"description": "Позволяет управлять шаблонами для конкретного сервера.",
"item": [
{
"name": "Отправка письма с шаблоном",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/email/withTemplate",
"host": [
"{{base_url}}"
],
"path": [
"email",
"withTemplate"
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n| TemplateId | integer | обязательный ID шаблона для использования при отправке этого письма. Обязательно, если не указан `TemplateAlias`. |\n| --- | --- | --- |\n| TemplateAlias | string | обязательный Псевдоним шаблона для использования при отправке этого письма. Обязательно, если не указан `TemplateId`. |\n| TemplateModel | object | обязательный Модель данных, которая будет применена к указанному шаблону для генерации `HtmlBody`, `TextBody`, и `Subject`. |\n| From | string | обязательный Email-адрес отправителя. Должен иметь зарегистрированную и подтвержденную подпись отправителя. Чтобы указать имя, используйте формат `\"Имя Фамилия \"`. Знаки препинания в имени необходимо экранировать. |\n| To | string | обязательный Email-адрес получателя. Несколько адресов разделяются запятой. Максимум 50. |\n| Cc | string | Email-адрес получателя для копии (Cc). Несколько адресов разделяются запятой. Максимум 50. |\n| Bcc | string | Email-адрес получателя для скрытой копии (Bcc). Несколько адресов разделяются запятой. Максимум 50. |\n| Tag | string | Тег, позволяющий категоризировать исходящие письма для получения детальной статистики. Максимум 1000 символов. |\n| ReplyTo | string | Email-адрес для ответа, переопределяющий стандартный. По умолчанию используется адрес, указанный в подписи отправителя. |\n| Headers | array | Список пользовательских заголовков для включения. |\n| TrackOpens | boolean | Активировать отслеживание открытий для этого письма. |\n| TrackLinks | string | Активировать отслеживание кликов по ссылкам в HTML или текстовой версии письма. Возможные значения: `None` `HtmlAndText` `HtmlOnly` `TextOnly` |\n| Attachments | array | Список вложений. |\n| Metadata | object | Пользовательские метаданные в формате ключ/значение. |\n| MessageStream | string | ID канала, который будет использоваться для отправки. Если не указан, по умолчанию будет использован исходящий транзакционный канал. |\n\n**Ответ**\n\n| To | string | Email-адрес получателя. |\n| --- | --- | --- |\n| SubmittedAt | string | Временная метка отправки. |\n| MessageID | string | ID сообщения. |\n| ErrorCode | integer | [Коды ошибок API.](/developer/api/overview#error-codes) |\n| Message | string | Сообщение ответа. |\n\n[Метод в документации](https://haskimail.ru/developer/templates-api/#email-with-template)",
"body": {
"mode": "raw",
"raw": "{\n \"From\": \"sender@example.com\",\n \"To\": \"receiver@example.com\",\n \"TemplateId\": 1234,\n \"TemplateModel\": {\n \"user_name\": \"Иван Дурак\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/email/withTemplate",
"host": [
"{{base_url}}"
],
"path": [
"email",
"withTemplate"
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n| TemplateId | integer | обязательный ID шаблона для использования при отправке этого письма. Обязательно, если не указан `TemplateAlias`. |\n| --- | --- | --- |\n| TemplateAlias | string | обязательный Псевдоним шаблона для использования при отправке этого письма. Обязательно, если не указан `TemplateId`. |\n| TemplateModel | object | обязательный Модель данных, которая будет применена к указанному шаблону для генерации `HtmlBody`, `TextBody`, и `Subject`. |\n| From | string | обязательный Email-адрес отправителя. Должен иметь зарегистрированную и подтвержденную подпись отправителя. Чтобы указать имя, используйте формат `\"Имя Фамилия \"`. Знаки препинания в имени необходимо экранировать. |\n| To | string | обязательный Email-адрес получателя. Несколько адресов разделяются запятой. Максимум 50. |\n| Cc | string | Email-адрес получателя для копии (Cc). Несколько адресов разделяются запятой. Максимум 50. |\n| Bcc | string | Email-адрес получателя для скрытой копии (Bcc). Несколько адресов разделяются запятой. Максимум 50. |\n| Tag | string | Тег, позволяющий категоризировать исходящие письма для получения детальной статистики. Максимум 1000 символов. |\n| ReplyTo | string | Email-адрес для ответа, переопределяющий стандартный. По умолчанию используется адрес, указанный в подписи отправителя. |\n| Headers | array | Список пользовательских заголовков для включения. |\n| TrackOpens | boolean | Активировать отслеживание открытий для этого письма. |\n| TrackLinks | string | Активировать отслеживание кликов по ссылкам в HTML или текстовой версии письма. Возможные значения: `None` `HtmlAndText` `HtmlOnly` `TextOnly` |\n| Attachments | array | Список вложений. |\n| Metadata | object | Пользовательские метаданные в формате ключ/значение. |\n| MessageStream | string | ID канала, который будет использоваться для отправки. Если не указан, по умолчанию будет использован исходящий транзакционный канал. |\n\n**Ответ**\n\n| To | string | Email-адрес получателя. |\n| --- | --- | --- |\n| SubmittedAt | string | Временная метка отправки. |\n| MessageID | string | ID сообщения. |\n| ErrorCode | integer | [Коды ошибок API.](/developer/api/overview#error-codes) |\n| Message | string | Сообщение ответа. |\n\n[Метод в документации](https://haskimail.ru/developer/templates-api/#email-with-template)",
"body": {
"mode": "raw",
"raw": "{\n \"From\": \"sender@example.com\",\n \"To\": \"receiver@example.com\",\n \"TemplateId\": 1234,\n \"TemplateModel\": {\n \"user_name\": \"Иван Дурак\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"To\": \"receiver@example.com\",\n \"SubmittedAt\": \"2014-02-17T07:25:01.4178645-05:00\",\n \"MessageID\": \"0a129aee-e1cd-480d-b08d-4f48548ff48d\",\n \"ErrorCode\": 0,\n \"Message\": \"OK\"\n}"
}
]
},
{
"name": "Перенос шаблонов на другой сервер",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/templates/push",
"host": [
"{{base_url}}"
],
"path": [
"templates",
"push"
]
},
"description": "Переносит все шаблоны с изменениями на другой сервер. Если шаблон уже существует на целевом сервере, он будет обновлен. Если шаблон не существует на целевом сервере, он будет создан, и ему будет присвоен псевдоним шаблона с исходного сервера.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен, доступный только владельцу аккаунта, можно найти на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Формат тела запроса**\n\n| SourceServerID | string | обязательный ID исходного сервера, содержащего шаблоны, которые будут перенесены. |\n| --- | --- | --- |\n| DestinationServerID | string | обязательный ID целевого сервера, на который будут перенесены шаблоны. |\n| PerformChanges | boolean | обязательный Указывает, следует ли переносить шаблоны на целевой сервер. Этот параметр можно установить в `false`, чтобы выполнить «тестовый запуск» операции и увидеть, какие шаблоны будут созданы или обновлены в результате. |\n\n**Ответ**\n\n| TotalCount | integer | Указывает общее количество изменений в шаблонах. |\n| --- | --- | --- |\n| Templates | object | Список затронутых шаблонов на целевом сервере. |\n| Name | string | Название шаблона. |\n\n[Метод в документации](https://haskimail.ru/developer/templates-api/#push-templates)",
"body": {
"mode": "raw",
"raw": "{\n \"SourceServerID\": 997287,\n \"DestinationServerID\": 997285,\n \"PerformChanges\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/templates/push",
"host": [
"{{base_url}}"
],
"path": [
"templates",
"push"
]
},
"description": "Переносит все шаблоны с изменениями на другой сервер. Если шаблон уже существует на целевом сервере, он будет обновлен. Если шаблон не существует на целевом сервере, он будет создан, и ему будет присвоен псевдоним шаблона с исходного сервера.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен, доступный только владельцу аккаунта, можно найти на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Формат тела запроса**\n\n| SourceServerID | string | обязательный ID исходного сервера, содержащего шаблоны, которые будут перенесены. |\n| --- | --- | --- |\n| DestinationServerID | string | обязательный ID целевого сервера, на который будут перенесены шаблоны. |\n| PerformChanges | boolean | обязательный Указывает, следует ли переносить шаблоны на целевой сервер. Этот параметр можно установить в `false`, чтобы выполнить «тестовый запуск» операции и увидеть, какие шаблоны будут созданы или обновлены в результате. |\n\n**Ответ**\n\n| TotalCount | integer | Указывает общее количество изменений в шаблонах. |\n| --- | --- | --- |\n| Templates | object | Список затронутых шаблонов на целевом сервере. |\n| Name | string | Название шаблона. |\n\n[Метод в документации](https://haskimail.ru/developer/templates-api/#push-templates)",
"body": {
"mode": "raw",
"raw": "{\n \"SourceServerID\": 997287,\n \"DestinationServerID\": 997285,\n \"PerformChanges\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"TotalCount\": 1,\n \"Templates\": [\n {\n \"TemplateId\": 7270,\n \"Name\": \"Comment notification\"\n }\n ]\n}"
}
]
},
{
"name": "Получение шаблона",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/templates/:templateIdOrAlias",
"host": [
"{{base_url}}"
],
"path": [
"templates",
":templateIdOrAlias"
],
"variable": [
{
"key": "templateIdOrAlias",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| TemplateId | integer | ID шаблона. |\n| --- | --- | --- |\n| Name | string | Название шаблона. |\n| Subject | string | Содержимое для поля Subject при отправке письма с этим шаблоном. |\n| HtmlBody | string | Содержимое для поля HtmlBody при отправке письма с этим шаблоном. |\n| TextBody | string | Содержимое для поля TextBody при отправке письма с этим шаблоном. |\n| AssociatedServerId | integer | ID сервера, с которым связан этот шаблон. |\n\n[Метод в документации](https://haskimail.ru/developer/templates-api/#get-template)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/templates/:templateIdOrAlias",
"host": [
"{{base_url}}"
],
"path": [
"templates",
":templateIdOrAlias"
],
"variable": [
{
"key": "templateIdOrAlias",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| TemplateId | integer | ID шаблона. |\n| --- | --- | --- |\n| Name | string | Название шаблона. |\n| Subject | string | Содержимое для поля Subject при отправке письма с этим шаблоном. |\n| HtmlBody | string | Содержимое для поля HtmlBody при отправке письма с этим шаблоном. |\n| TextBody | string | Содержимое для поля TextBody при отправке письма с этим шаблоном. |\n| AssociatedServerId | integer | ID сервера, с которым связан этот шаблон. |\n\n[Метод в документации](https://haskimail.ru/developer/templates-api/#get-template)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"Name\": \"Onboarding Email\",\n \"TemplateId\": 1234,\n \"Subject\": \"Hi there, {{Name}}\",\n \"HtmlBody\": \"Hello dear Haskimail user. {{Name}}\",\n \"TextBody\": \"{{Name}} is a {{Occupation}}\",\n \"AssociatedServerId\": 1\n}"
}
]
},
{
"name": "Создание шаблона",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/templates",
"host": [
"{{base_url}}"
],
"path": [
"templates"
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n| Name | string | обязательный Название шаблона. |\n| --- | --- | --- |\n| HtmlBody | string | обязательный HTML-содержимое, которое будет использоваться, когда этот шаблон применяется для отправки письма. Обязательно, если не указан `TextBody`. Подробнее о синтаксисе этого поля см. в нашей документации по языку шаблонов. Для шаблона-макета (Layout) обязательно наличие заполнителя контента ({{{@content}}}), который может быть размещен в `HtmlBody` только один раз. |\n| TextBody | string | обязательный Текстовое содержимое, которое будет использоваться, когда этот шаблон применяется для отправки письма. Обязательно, если не указан `HtmlBody`. Подробнее о синтаксисе этого поля см. в нашей документации по языку шаблонов. Для шаблона-макета (Layout) обязательно наличие заполнителя контента ({{{@content}}}), который может быть размещен в TextBody только один раз. |\n| Subject | string | обязательный Содержимое для поля Subject при отправке письма с этим шаблоном.Поле Subject обязательно только для стандартных шаблонов. Подробнее о синтаксисе этого поля см. в нашей документации по языку шаблонов. Указывать тему для шаблонов-макетов запрещено, это приведет к ошибке API. |\n| AssociatedServerId | integer | обязательный ID сервера, к которому будет привязан шаблон. |\n\n**Ответ**\n\n| TemplateId | integer | ID шаблона. |\n| --- | --- | --- |\n| Name | string | Название шаблона. |\n\n[Метод в документации](https://haskimail.ru/developer/templates-api/#create-template)",
"body": {
"mode": "raw",
"raw": "{\n \"Name\": \"Welcome Email\",\n \"HtmlBody\": \"Hello{{name}}\",\n \"TextBody\": \"Hello, {{name}}\",\n \"Subject\": \"Hello, from {{company.name}}\",\n \"AssociatedServerId\": \"1\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/templates",
"host": [
"{{base_url}}"
],
"path": [
"templates"
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n| Name | string | обязательный Название шаблона. |\n| --- | --- | --- |\n| HtmlBody | string | обязательный HTML-содержимое, которое будет использоваться, когда этот шаблон применяется для отправки письма. Обязательно, если не указан `TextBody`. Подробнее о синтаксисе этого поля см. в нашей документации по языку шаблонов. Для шаблона-макета (Layout) обязательно наличие заполнителя контента ({{{@content}}}), который может быть размещен в `HtmlBody` только один раз. |\n| TextBody | string | обязательный Текстовое содержимое, которое будет использоваться, когда этот шаблон применяется для отправки письма. Обязательно, если не указан `HtmlBody`. Подробнее о синтаксисе этого поля см. в нашей документации по языку шаблонов. Для шаблона-макета (Layout) обязательно наличие заполнителя контента ({{{@content}}}), который может быть размещен в TextBody только один раз. |\n| Subject | string | обязательный Содержимое для поля Subject при отправке письма с этим шаблоном.Поле Subject обязательно только для стандартных шаблонов. Подробнее о синтаксисе этого поля см. в нашей документации по языку шаблонов. Указывать тему для шаблонов-макетов запрещено, это приведет к ошибке API. |\n| AssociatedServerId | integer | обязательный ID сервера, к которому будет привязан шаблон. |\n\n**Ответ**\n\n| TemplateId | integer | ID шаблона. |\n| --- | --- | --- |\n| Name | string | Название шаблона. |\n\n[Метод в документации](https://haskimail.ru/developer/templates-api/#create-template)",
"body": {
"mode": "raw",
"raw": "{\n \"Name\": \"Welcome Email\",\n \"HtmlBody\": \"Hello{{name}}\",\n \"TextBody\": \"Hello, {{name}}\",\n \"Subject\": \"Hello, from {{company.name}}\",\n \"AssociatedServerId\": \"1\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"TemplateId\": 1234,\n \"Name\": \"Onboarding Email\"\n}"
}
]
},
{
"name": "Редактирование шаблона",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/templates/:templateIdOrAlias",
"host": [
"{{base_url}}"
],
"path": [
"templates",
":templateIdOrAlias"
],
"variable": [
{
"key": "templateIdOrAlias",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n| Name | string | обязательный Название шаблона. |\n| --- | --- | --- |\n| Subject | string | обязательный Содержимое для поля Subject при отправке письма с этим шаблоном. Подробнее о синтаксисе этого поля см. в нашей документации по языку шаблонов. |\n| HtmlBody | string | обязательный Содержимое для поля HtmlBody при отправке письма с этим шаблоном. Обязательно, если не указан `TextBody`. Подробнее о синтаксисе этого поля см. в нашей документации по языку шаблонов. |\n| TextBody | string | обязательный Содержимое для поля TextBody при отправке письма с этим шаблоном. Обязательно, если не указан `HtmlBody`. Подробнее о синтаксисе этого поля см. в нашей документации по языку шаблонов. |\n| | | |\n\n**Ответ**\n\n| TemplateId | integer | ID шаблона. |\n| --- | --- | --- |\n| Name | string | Название шаблона. |\n\n[Метод в документации](https://haskimail.ru/developer/templates-api/#edit-template)",
"body": {
"mode": "raw",
"raw": "{\n \"Name\": \"Onboarding Email\",\n \"Subject\": \"Hello from {{company.name}}!\",\n \"TextBody\": \"Hello, {{name}}!\",\n \"HtmlBody\": \"Hello, {{name}}!\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/templates/:templateIdOrAlias",
"host": [
"{{base_url}}"
],
"path": [
"templates",
":templateIdOrAlias"
],
"variable": [
{
"key": "templateIdOrAlias",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n| Name | string | обязательный Название шаблона. |\n| --- | --- | --- |\n| Subject | string | обязательный Содержимое для поля Subject при отправке письма с этим шаблоном. Подробнее о синтаксисе этого поля см. в нашей документации по языку шаблонов. |\n| HtmlBody | string | обязательный Содержимое для поля HtmlBody при отправке письма с этим шаблоном. Обязательно, если не указан `TextBody`. Подробнее о синтаксисе этого поля см. в нашей документации по языку шаблонов. |\n| TextBody | string | обязательный Содержимое для поля TextBody при отправке письма с этим шаблоном. Обязательно, если не указан `HtmlBody`. Подробнее о синтаксисе этого поля см. в нашей документации по языку шаблонов. |\n| | | |\n\n**Ответ**\n\n| TemplateId | integer | ID шаблона. |\n| --- | --- | --- |\n| Name | string | Название шаблона. |\n\n[Метод в документации](https://haskimail.ru/developer/templates-api/#edit-template)",
"body": {
"mode": "raw",
"raw": "{\n \"Name\": \"Onboarding Email\",\n \"Subject\": \"Hello from {{company.name}}!\",\n \"TextBody\": \"Hello, {{name}}!\",\n \"HtmlBody\": \"Hello, {{name}}!\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"TemplateId\": 1234,\n \"Name\": \"Onboarding Email\"\n}"
}
]
},
{
"name": "Список шаблонов",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/templates?count=100&offset=0&LayoutTemplate=my-layout",
"host": [
"{{base_url}}"
],
"path": [
"templates"
],
"query": [
{
"key": "count",
"value": "100",
"description": ""
},
{
"key": "offset",
"value": "0",
"description": ""
},
{
"key": "LayoutTemplate",
"value": "my-layout",
"description": ""
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Querystring parameters**\n\n| Count | обязательный Количество возвращаемых шаблонов. |\n| --- | --- |\n| Offset | обязательный Количество шаблонов, которое нужно «пропустить» перед возвратом результатов. |\n\n**Ответ**\n\n| TotalCount | integer | Общее количество шаблонов, связанных с текущим сервером. |\n| --- | --- | --- |\n| Templates | array | Список шаблонов, связанных с этим сервером. |\n\n[Метод в документации](https://haskimail.ru/developer/templates-api/#list-templates)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/templates?count=100&offset=0&LayoutTemplate=my-layout",
"host": [
"{{base_url}}"
],
"path": [
"templates"
],
"query": [
{
"key": "count",
"value": "100",
"description": ""
},
{
"key": "offset",
"value": "0",
"description": ""
},
{
"key": "LayoutTemplate",
"value": "my-layout",
"description": ""
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Querystring parameters**\n\n| Count | обязательный Количество возвращаемых шаблонов. |\n| --- | --- |\n| Offset | обязательный Количество шаблонов, которое нужно «пропустить» перед возвратом результатов. |\n\n**Ответ**\n\n| TotalCount | integer | Общее количество шаблонов, связанных с текущим сервером. |\n| --- | --- | --- |\n| Templates | array | Список шаблонов, связанных с этим сервером. |\n\n[Метод в документации](https://haskimail.ru/developer/templates-api/#list-templates)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"TotalCount\": 2,\n \"Templates\": [\n {\n \"TemplateId\": 1234,\n \"Name\": \"Password Recovery Email\"\n },\n {\n \"Active\": true,\n \"TemplateId\": 5678,\n \"Name\": \"Default Layout\"\n }\n ]\n}"
}
]
},
{
"name": "Удаление шаблона",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/templates/:templateIdOrAlias",
"host": [
"{{base_url}}"
],
"path": [
"templates",
":templateIdOrAlias"
],
"variable": [
{
"key": "templateIdOrAlias",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ErrorCode | integer | [Коды ошибок API.](/developer/api/overview#error-codes) |\n| --- | --- | --- |\n| Message | string | Связанное сообщение об успехе или ошибке. |\n\n[Метод в документации](https://haskimail.ru/developer/templates-api/#delete-template)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/templates/:templateIdOrAlias",
"host": [
"{{base_url}}"
],
"path": [
"templates",
":templateIdOrAlias"
],
"variable": [
{
"key": "templateIdOrAlias",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ErrorCode | integer | [Коды ошибок API.](/developer/api/overview#error-codes) |\n| --- | --- | --- |\n| Message | string | Связанное сообщение об успехе или ошибке. |\n\n[Метод в документации](https://haskimail.ru/developer/templates-api/#delete-template)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"ErrorCode\": 0,\n \"Message\": \"Template 1234 removed.\"\n}"
}
]
}
]
},
{
"name": "API Каналов",
"description": "Позволяет управлять каналами для конкретного сервера. Обратите внимание: на одном сервере может быть до 10 каналов, включая каналы по умолчанию. Каналы по умолчанию не могут быть удалены, и на сервере может быть только один входящий канал.",
"item": [
{
"name": "Список каналов",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/message-streams?MessageStreamType=all&IncludeArchivedStreams=true",
"host": [
"{{base_url}}"
],
"path": [
"message-streams"
],
"query": [
{
"key": "MessageStreamType",
"value": "all",
"description": ""
},
{
"key": "IncludeArchivedStreams",
"value": "true",
"description": ""
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры строки запроса**\n\n| MessageStreamType | Фильтрует каналы по типу. Возможные значения: `All` `Transactional` `Broadcasts`. Defaults to `All`. |\n| --- | --- |\n| IncludeArchivedStreams | Логический фильтр для включения архивных каналов в список. По умолчанию: `False`. |\n\n**Ответ**\n\n| MessageStreams | array | Список каналов на сервере. |\n| --- | --- | --- |\n| ID | string | ID канала. |\n| ServerID | integer | ID сервера, с которым связан канал. |\n| Name | string | Название канала. |\n| MessageStreamType | string | Тип канала. Возможные значения: `Broadcasts` `Transactional` |\n| ArchivedAt | string | Временная метка архивации канала. Это значение может быть null. |\n| TotalCount | integer | Количество полученных каналов. |\n\n[Метод в документации](https://haskimail.ru/developer/message-streams-api/#list-message-streams)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/message-streams?MessageStreamType=all&IncludeArchivedStreams=true",
"host": [
"{{base_url}}"
],
"path": [
"message-streams"
],
"query": [
{
"key": "MessageStreamType",
"value": "all",
"description": ""
},
{
"key": "IncludeArchivedStreams",
"value": "true",
"description": ""
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры строки запроса**\n\n| MessageStreamType | Фильтрует каналы по типу. Возможные значения: `All` `Transactional` `Broadcasts`. Defaults to `All`. |\n| --- | --- |\n| IncludeArchivedStreams | Логический фильтр для включения архивных каналов в список. По умолчанию: `False`. |\n\n**Ответ**\n\n| MessageStreams | array | Список каналов на сервере. |\n| --- | --- | --- |\n| ID | string | ID канала. |\n| ServerID | integer | ID сервера, с которым связан канал. |\n| Name | string | Название канала. |\n| MessageStreamType | string | Тип канала. Возможные значения: `Broadcasts` `Transactional` |\n| ArchivedAt | string | Временная метка архивации канала. Это значение может быть null. |\n| TotalCount | integer | Количество полученных каналов. |\n\n[Метод в документации](https://haskimail.ru/developer/message-streams-api/#list-message-streams)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"MessageStreams\": [\n {\n \"ID\": \"broadcasts\",\n \"ServerID\": 123457,\n \"Name\": \"Broadcast Stream\",\n \"MessageStreamType\": \"Broadcasts\",\n \"ArchivedAt\": \"2020-07-03T00:00:00-04:00\"\n },\n {\n \"ID\": \"outbound\",\n \"ServerID\": 123457,\n \"Name\": \"Transactional Stream\",\n \"MessageStreamType\": \"Transactional\",\n \"ArchivedAt\": null\n },\n {\n \"ID\": \"Transactional\",\n \"ServerID\": 123457,\n \"Name\": \"Transactional Stream\",\n \"MessageStreamType\": \"Transactional\",\n \"ArchivedAt\": null\n },\n {\n \"ID\": \"transactional-dev\",\n \"ServerID\": 123457,\n \"Name\": \"My Dev Transactional Stream\",\n \"MessageStreamType\": \"Transactional\",\n \"ArchivedAt\": null\n }\n ],\n \"TotalCount\": 4\n}"
}
]
},
{
"name": "Получение информации о канале",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/message-streams/:stream_ID",
"host": [
"{{base_url}}"
],
"path": [
"message-streams",
":stream_ID"
],
"variable": [
{
"key": "stream_ID",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ID | string | ID канала. |\n| --- | --- | --- |\n| ServerID | integer | ID сервера, с которым связан канал. |\n| Name | string | Название канала. |\n| MessageStreamType | string | Тип канала. Возможные значения: `Broadcasts` `Transactional` |\n| ArchivedAt | string | Временная метка архивации канала. Это значение может быть null. |\n\n[Метод в документации](https://haskimail.ru/developer/message-streams-api/#get-a-message-stream)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/message-streams/:stream_ID",
"host": [
"{{base_url}}"
],
"path": [
"message-streams",
":stream_ID"
],
"variable": [
{
"key": "stream_ID",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ID | string | ID канала. |\n| --- | --- | --- |\n| ServerID | integer | ID сервера, с которым связан канал. |\n| Name | string | Название канала. |\n| MessageStreamType | string | Тип канала. Возможные значения: `Broadcasts` `Transactional` |\n| ArchivedAt | string | Временная метка архивации канала. Это значение может быть null. |\n\n[Метод в документации](https://haskimail.ru/developer/message-streams-api/#get-a-message-stream)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"ID\": \"broadcasts\",\n \"ServerID\": 123456,\n \"Name\": \"Broadcast Stream\",\n \"MessageStreamType\": \"Broadcasts\",\n \"ArchivedAt\": null\n}"
}
]
},
{
"name": "Редактирование канала",
"request": {
"method": "PATCH",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/message-streams/:stream_ID",
"host": [
"{{base_url}}"
],
"path": [
"message-streams",
":stream_ID"
],
"variable": [
{
"key": "stream_ID",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n**Ответ**\n\n| ID | string | ID канала. |\n| --- | --- | --- |\n| ServerID | integer | ID сервера, с которым связан канал. |\n| Name | string | Название канала. |\n| MessageStreamType | string | Тип канала. Возможные значения: `Broadcasts` `Transactional` |\n| ArchivedAt | string | Временная метка архивации канала. Это значение может быть null. |\n\n[Метод в документации](https://haskimail.ru/developer/message-streams-api/#edit-a-message-stream)",
"body": {
"mode": "raw",
"raw": "{\n \"Name\": \"Updated Dev Stream\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/message-streams/:stream_ID",
"host": [
"{{base_url}}"
],
"path": [
"message-streams",
":stream_ID"
],
"variable": [
{
"key": "stream_ID",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n**Ответ**\n\n| ID | string | ID канала. |\n| --- | --- | --- |\n| ServerID | integer | ID сервера, с которым связан канал. |\n| Name | string | Название канала. |\n| MessageStreamType | string | Тип канала. Возможные значения: `Broadcasts` `Transactional` |\n| ArchivedAt | string | Временная метка архивации канала. Это значение может быть null. |\n\n[Метод в документации](https://haskimail.ru/developer/message-streams-api/#edit-a-message-stream)",
"body": {
"mode": "raw",
"raw": "{\n \"Name\": \"Updated Dev Stream\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"ID\": \"transactional-dev\",\n \"ServerID\": 123457,\n \"Name\": \"Updated Dev Stream\",\n \"MessageStreamType\": \"Transactional\",\n \"ArchivedAt\": null\n}"
}
]
},
{
"name": "Создание канала",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/message-streams",
"host": [
"{{base_url}}"
],
"path": [
"message-streams"
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n| ServerID | string | обязательный Идентификатор сервера, к которому привязан канал. |\n| --- | --- | --- |\n| Name | string | обязательный Название канала. |\n| MessageStreamType | string | обязательный Тип создаваемого канала. Возможные значения: `Broadcasts` `Transasctional` |\n\n**Ответ**\n\n| ID | string | ID канала. |\n| --- | --- | --- |\n| ServerID | integer | ID сервера, с которым связан канал. |\n| Name | string | Название канала. |\n| MessageStreamType | string | Тип канала. Возможные значения: `Broadcasts` `Transactional` |\n| ArchivedAt | string | Временная метка архивации канала. Это значение может быть null. |\n\n[Метод в документации](https://haskimail.ru/developer/message-streams-api/#create-a-message-stream)",
"body": {
"mode": "raw",
"raw": "{\n \"ServerID\": \"transactional-dev\",\n \"Name\": \"My Dev Transactional Stream\",\n \"MessageStreamType\": \"Transactional\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/message-streams",
"host": [
"{{base_url}}"
],
"path": [
"message-streams"
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n| ServerID | string | обязательный Идентификатор сервера, к которому привязан канал. |\n| --- | --- | --- |\n| Name | string | обязательный Название канала. |\n| MessageStreamType | string | обязательный Тип создаваемого канала. Возможные значения: `Broadcasts` `Transasctional` |\n\n**Ответ**\n\n| ID | string | ID канала. |\n| --- | --- | --- |\n| ServerID | integer | ID сервера, с которым связан канал. |\n| Name | string | Название канала. |\n| MessageStreamType | string | Тип канала. Возможные значения: `Broadcasts` `Transactional` |\n| ArchivedAt | string | Временная метка архивации канала. Это значение может быть null. |\n\n[Метод в документации](https://haskimail.ru/developer/message-streams-api/#create-a-message-stream)",
"body": {
"mode": "raw",
"raw": "{\n \"ServerID\": \"transactional-dev\",\n \"Name\": \"My Dev Transactional Stream\",\n \"MessageStreamType\": \"Transactional\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"ID\": \"transactional-dev\",\n \"ServerID\": 123457,\n \"Name\": \"My Dev Transactional Stream\",\n \"MessageStreamType\": \"Transactional\",\n \"ArchivedAt\": \"2020-07-02T00:00:00-04:00\"\n}"
}
]
},
{
"name": "Архивация канала",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Length",
"value": "0"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/message-streams/:stream_ID/archive",
"host": [
"{{base_url}}"
],
"path": [
"message-streams",
":stream_ID",
"archive"
],
"variable": [
{
"key": "stream_ID",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Content-Length | обязательный Set to 0 |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ID | string | ID канала. |\n| --- | --- | --- |\n| ServerID | string | ID сервера, с которым связан канал. |\n| ExpectedPurgeDate | string | Канал будет удален через 45 дней после даты архивации. До этой даты его можно восстановить. |\n\n[Метод в документации](https://haskimail.ru/developer/message-streams-api/#archive-a-message-stream)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Length",
"value": "0"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/message-streams/:stream_ID/archive",
"host": [
"{{base_url}}"
],
"path": [
"message-streams",
":stream_ID",
"archive"
],
"variable": [
{
"key": "stream_ID",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Content-Length | обязательный Set to 0 |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ID | string | ID канала. |\n| --- | --- | --- |\n| ServerID | string | ID сервера, с которым связан канал. |\n| ExpectedPurgeDate | string | Канал будет удален через 45 дней после даты архивации. До этой даты его можно восстановить. |\n\n[Метод в документации](https://haskimail.ru/developer/message-streams-api/#archive-a-message-stream)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"ID\": \"transactional-dev\",\n \"ServerID\": 123457,\n \"ExpectedPurgeDate\": \"2020-08-30T12:30:00.00-04:00\"\n}"
}
]
},
{
"name": "Разархивация канала",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Length",
"value": "0"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/message-streams/:stream_ID/unarchive",
"host": [
"{{base_url}}"
],
"path": [
"message-streams",
":stream_ID",
"unarchive"
],
"variable": [
{
"key": "stream_ID",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Content-Length | обязательный Set to 0 |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ID | string | ID канала. |\n| --- | --- | --- |\n| ServerID | integer | ID сервера, с которым связан канал. |\n| Name | string | Название канала. |\n| MessageStreamType | string | Тип канала. Возможные значения: `Inbound` `Broadcasts` `Transactional` |\n| ArchivedAt | string | Временная метка архивации канала. Это значение может быть null. |\n\n[Метод в документации](https://haskimail.ru/developer/message-streams-api/#unarchive-a-stream)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Length",
"value": "0"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/message-streams/:stream_ID/unarchive",
"host": [
"{{base_url}}"
],
"path": [
"message-streams",
":stream_ID",
"unarchive"
],
"variable": [
{
"key": "stream_ID",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Content-Length | обязательный Set to 0 |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ID | string | ID канала. |\n| --- | --- | --- |\n| ServerID | integer | ID сервера, с которым связан канал. |\n| Name | string | Название канала. |\n| MessageStreamType | string | Тип канала. Возможные значения: `Inbound` `Broadcasts` `Transactional` |\n| ArchivedAt | string | Временная метка архивации канала. Это значение может быть null. |\n\n[Метод в документации](https://haskimail.ru/developer/message-streams-api/#unarchive-a-stream)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"ID\": \"transactional-dev\",\n \"ServerID\": 123457,\n \"Name\": \"Updated Dev Stream\",\n \"MessageStreamType\": \"Transactional\",\n \"ArchivedAt\": null\n}"
}
]
}
]
},
{
"name": "API Серверов",
"description": "Позволяет управлять SMTP-серверами для конкретного аккаунта.",
"item": [
{
"name": "Получение информации о сервере",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/servers/:serverid",
"host": [
"{{base_url}}"
],
"path": [
"servers",
":serverid"
],
"variable": [
{
"key": "serverid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден в настройках вашего аккаунта Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ID | integer | ID сервера. |\n| --- | --- | --- |\n| Name | string | Название сервера. |\n| ApiTokens | array | Список API-токенов, связанных с сервером. |\n| Color | string | Цвет сервера в списке для быстрой идентификации. Возможные значения: `Purple` `Blue` `Turquoise` `Green` `Red` `Yellow` `Grey` `Orange` |\n| SmtpApiActivated | boolean | Указывает, включен ли SMTP на этом сервере. |\n| TrackOpens | boolean | Указывает, включено ли отслеживание открытий для всех писем, отправляемых через этот сервер. |\n| TrackLinks | boolean | Указывает, включено ли отслеживание ссылок для всех писем, отправляемых через этот сервер |\n| DeliveryType | string | Тип сервера: `Live` — живой, письма доставляются получателям; `Sandbox` — песочница, письма проходят все проверки и видны в статистике и вебхуках, но получателям не доставляются. Задаётся при создании сервера и не меняется. |\n\n[Метод в документации](https://haskimail.ru/developer/servers-api/#get-server)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/servers/:serverid",
"host": [
"{{base_url}}"
],
"path": [
"servers",
":serverid"
],
"variable": [
{
"key": "serverid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден в настройках вашего аккаунта Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ID | integer | ID сервера. |\n| --- | --- | --- |\n| Name | string | Название сервера. |\n| ApiTokens | array | Список API-токенов, связанных с сервером. |\n| Color | string | Цвет сервера в списке для быстрой идентификации. Возможные значения: `Purple` `Blue` `Turquoise` `Green` `Red` `Yellow` `Grey` `Orange` |\n| SmtpApiActivated | boolean | Указывает, включен ли SMTP на этом сервере. |\n| TrackOpens | boolean | Указывает, включено ли отслеживание открытий для всех писем, отправляемых через этот сервер. |\n| TrackLinks | boolean | Указывает, включено ли отслеживание ссылок для всех писем, отправляемых через этот сервер |\n| DeliveryType | string | Тип сервера: `Live` — живой, письма доставляются получателям; `Sandbox` — песочница, письма проходят все проверки и видны в статистике и вебхуках, но получателям не доставляются. Задаётся при создании сервера и не меняется. |\n\n[Метод в документации](https://haskimail.ru/developer/servers-api/#get-server)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"ID\": 1,\n \"Name\": \"Staging Testing\",\n \"ApiTokens\": [\n \"server token\"\n ],\n \"Color\": \"red\",\n \"SmtpApiActivated\": true,\n \"TrackOpens\": false,\n \"TrackLinks\": false,\n \"DeliveryType\": \"Live\"\n}"
}
]
},
{
"name": "Создание сервера",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/servers",
"host": [
"{{base_url}}"
],
"path": [
"servers"
]
},
"description": "**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден в настройках вашего аккаунта Haskimail на вкладке «Токены API». |\n\n**Body format**\n\n| Name | string | обязательный Название сервера. |\n| --- | --- | --- |\n| Color | string | обязательный Цвет сервера в списке для быстрой идентификации. Возможные значения: `Purple` `Blue` `Turquoise` `Green` `Red` `Yellow` `Grey` `Orange`. Регистр не важен, неизвестное значение заменяется на `Purple`. Если не передать `Name` или `Color`, API вернёт ответ HTTP 422. |\n| SmtpApiActivated | boolean | Указывает, включен ли SMTP на этом сервере. |\n| TrackOpens | boolean | Указывает, включено ли отслеживание открытий для всех писем, отправляемых через этот сервер. |\n| TrackLinks | boolean | Указывает, включено ли отслеживание ссылок для всех писем, отправляемых через этот сервер |\n| DeliveryType | string | Тип сервера: `Live` (по умолчанию) или `Sandbox`. Письма с сервера-песочницы проходят все те же проверки, что и на живом сервере, и видны в статистике, активности и вебхуках (событие `sent`), но получателям не доставляются и не расходуют лимит писем. Изменить тип после создания сервера нельзя. [Подробнее о песочнице](/developer/user-guide/sandbox-mode/server-sandbox-mode) |\n\n**Ответ**\n\n| ID | integer | ID сервера. |\n| --- | --- | --- |\n| Name | string | Название сервера. |\n| ApiTokens | array | Список API-токенов, связанных с сервером. |\n| Color | string | Цвет сервера в списке для быстрой идентификации. Возможные значения: `Purple` `Blue` `Turquoise` `Green` `Red` `Yellow` `Grey` `Orange` |\n| SmtpApiActivated | boolean | Указывает, включен ли SMTP на этом сервере. |\n| TrackOpens | boolean | Указывает, включено ли отслеживание открытий для всех писем, отправляемых через этот сервер. |\n| TrackLinks | boolean | Указывает, включено ли отслеживание ссылок для всех писем, отправляемых через этот сервер |\n| DeliveryType | string | Тип сервера: `Live` — живой, письма доставляются получателям; `Sandbox` — песочница, письма проходят все проверки и видны в статистике и вебхуках, но получателям не доставляются. Задаётся при создании сервера и не меняется. |\n\n[Метод в документации](https://haskimail.ru/developer/servers-api/#create-server)",
"body": {
"mode": "raw",
"raw": "{\n \"Name\": \"Production\",\n \"Color\": \"Purple\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/servers",
"host": [
"{{base_url}}"
],
"path": [
"servers"
]
},
"description": "**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден в настройках вашего аккаунта Haskimail на вкладке «Токены API». |\n\n**Body format**\n\n| Name | string | обязательный Название сервера. |\n| --- | --- | --- |\n| Color | string | обязательный Цвет сервера в списке для быстрой идентификации. Возможные значения: `Purple` `Blue` `Turquoise` `Green` `Red` `Yellow` `Grey` `Orange`. Регистр не важен, неизвестное значение заменяется на `Purple`. Если не передать `Name` или `Color`, API вернёт ответ HTTP 422. |\n| SmtpApiActivated | boolean | Указывает, включен ли SMTP на этом сервере. |\n| TrackOpens | boolean | Указывает, включено ли отслеживание открытий для всех писем, отправляемых через этот сервер. |\n| TrackLinks | boolean | Указывает, включено ли отслеживание ссылок для всех писем, отправляемых через этот сервер |\n| DeliveryType | string | Тип сервера: `Live` (по умолчанию) или `Sandbox`. Письма с сервера-песочницы проходят все те же проверки, что и на живом сервере, и видны в статистике, активности и вебхуках (событие `sent`), но получателям не доставляются и не расходуют лимит писем. Изменить тип после создания сервера нельзя. [Подробнее о песочнице](/developer/user-guide/sandbox-mode/server-sandbox-mode) |\n\n**Ответ**\n\n| ID | integer | ID сервера. |\n| --- | --- | --- |\n| Name | string | Название сервера. |\n| ApiTokens | array | Список API-токенов, связанных с сервером. |\n| Color | string | Цвет сервера в списке для быстрой идентификации. Возможные значения: `Purple` `Blue` `Turquoise` `Green` `Red` `Yellow` `Grey` `Orange` |\n| SmtpApiActivated | boolean | Указывает, включен ли SMTP на этом сервере. |\n| TrackOpens | boolean | Указывает, включено ли отслеживание открытий для всех писем, отправляемых через этот сервер. |\n| TrackLinks | boolean | Указывает, включено ли отслеживание ссылок для всех писем, отправляемых через этот сервер |\n| DeliveryType | string | Тип сервера: `Live` — живой, письма доставляются получателям; `Sandbox` — песочница, письма проходят все проверки и видны в статистике и вебхуках, но получателям не доставляются. Задаётся при создании сервера и не меняется. |\n\n[Метод в документации](https://haskimail.ru/developer/servers-api/#create-server)",
"body": {
"mode": "raw",
"raw": "{\n \"Name\": \"Production\",\n \"Color\": \"Purple\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"ID\": 1,\n \"Name\": \"Staging Testing\",\n \"ApiTokens\": [\n \"server token\"\n ],\n \"Color\": \"red\",\n \"SmtpApiActivated\": true,\n \"TrackOpens\": false,\n \"TrackLinks\": false,\n \"DeliveryType\": \"Live\"\n}"
}
]
},
{
"name": "Редактировать сервер",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/servers/:serverid",
"host": [
"{{base_url}}"
],
"path": [
"servers",
":serverid"
],
"variable": [
{
"key": "serverid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден в настройках вашего аккаунта Haskimail на вкладке «Токены API». |\n\n**Body format**\n\n| Name | string | обязательный Название сервера. |\n| --- | --- | --- |\n| Color | string | Цвет сервера в списке для быстрой идентификации. Возможные значения: `Purple` `Blue` `Turquoise` `Green` `Red` `Yellow` `Grey` `Orange` |\n| SmtpApiActivated | boolean | Указывает, включен ли SMTP на этом сервере. |\n| TrackOpens | boolean | Указывает, включено ли отслеживание открытий для всех писем, отправляемых через этот сервер. |\n| TrackLinks | boolean | Указывает, включено ли отслеживание ссылок для всех писем, отправляемых через этот сервер |\n\n**Ответ**\n\n| ID | integer | ID сервера. |\n| --- | --- | --- |\n| Name | string | Название сервера. |\n| ApiTokens | array | Список API-токенов, связанных с сервером. |\n| Color | string | Цвет сервера в списке для быстрой идентификации. Возможные значения: `Purple` `Blue` `Turquoise` `Green` `Red` `Yellow` `Grey` `Orange` |\n| SmtpApiActivated | boolean | Указывает, включен ли SMTP на этом сервере. |\n| TrackOpens | boolean | Указывает, включено ли отслеживание открытий для всех писем, отправляемых через этот сервер. |\n| TrackLinks | boolean | Указывает, включено ли отслеживание ссылок для всех писем, отправляемых через этот сервер |\n| DeliveryType | string | Тип сервера: `Live` — живой, письма доставляются получателям; `Sandbox` — песочница, письма проходят все проверки и видны в статистике и вебхуках, но получателям не доставляются. Задаётся при создании сервера и не меняется. |\n\n[Метод в документации](https://haskimail.ru/developer/servers-api/#edit-server)",
"body": {
"mode": "raw",
"raw": "{\n \"Name\": \"Production 2\",\n \"Color\": \"Blue\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/servers/:serverid",
"host": [
"{{base_url}}"
],
"path": [
"servers",
":serverid"
],
"variable": [
{
"key": "serverid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден в настройках вашего аккаунта Haskimail на вкладке «Токены API». |\n\n**Body format**\n\n| Name | string | обязательный Название сервера. |\n| --- | --- | --- |\n| Color | string | Цвет сервера в списке для быстрой идентификации. Возможные значения: `Purple` `Blue` `Turquoise` `Green` `Red` `Yellow` `Grey` `Orange` |\n| SmtpApiActivated | boolean | Указывает, включен ли SMTP на этом сервере. |\n| TrackOpens | boolean | Указывает, включено ли отслеживание открытий для всех писем, отправляемых через этот сервер. |\n| TrackLinks | boolean | Указывает, включено ли отслеживание ссылок для всех писем, отправляемых через этот сервер |\n\n**Ответ**\n\n| ID | integer | ID сервера. |\n| --- | --- | --- |\n| Name | string | Название сервера. |\n| ApiTokens | array | Список API-токенов, связанных с сервером. |\n| Color | string | Цвет сервера в списке для быстрой идентификации. Возможные значения: `Purple` `Blue` `Turquoise` `Green` `Red` `Yellow` `Grey` `Orange` |\n| SmtpApiActivated | boolean | Указывает, включен ли SMTP на этом сервере. |\n| TrackOpens | boolean | Указывает, включено ли отслеживание открытий для всех писем, отправляемых через этот сервер. |\n| TrackLinks | boolean | Указывает, включено ли отслеживание ссылок для всех писем, отправляемых через этот сервер |\n| DeliveryType | string | Тип сервера: `Live` — живой, письма доставляются получателям; `Sandbox` — песочница, письма проходят все проверки и видны в статистике и вебхуках, но получателям не доставляются. Задаётся при создании сервера и не меняется. |\n\n[Метод в документации](https://haskimail.ru/developer/servers-api/#edit-server)",
"body": {
"mode": "raw",
"raw": "{\n \"Name\": \"Production 2\",\n \"Color\": \"Blue\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"ID\": 1,\n \"Name\": \"Production Testing\",\n \"ApiTokens\": [\n \"Server Token\"\n ],\n \"Color\": \"blue\",\n \"SmtpApiActivated\": false,\n \"TrackOpens\": false,\n \"TrackLinks\": false,\n \"DeliveryType\": \"Live\"\n}"
}
]
},
{
"name": "Список серверов",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/servers?count=50&offset=0",
"host": [
"{{base_url}}"
],
"path": [
"servers"
],
"query": [
{
"key": "count",
"value": "50",
"description": ""
},
{
"key": "offset",
"value": "0",
"description": ""
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден в настройках вашего аккаунта Haskimail на вкладке «Токены API». |\n\n**Параметры строки запроса**\n\n| count | integer | обязательный Количество серверов, возвращаемых в ответе. |\n| --- | --- | --- |\n| offset | integer | обязательный Количество серверов, которые нужно пропустить. |\n| name | string | Фильтрация по имени сервера. Обратите внимание, что это строковый поиск, поэтому `MyServer` будет соответствовать `MyServer`,`MyServer Production` и `MyServer Test`. |\n\n**Ответ**\n\n| TotalCount | integer | Количество полученных серверов. |\n| --- | --- | --- |\n| Servers | array | Список серверов. |\n| ID | integer | ID сервера. |\n| Name | string | Название сервера. |\n| ApiTokens | array | Список API-токенов, связанных с сервером. |\n| Color | string | Цвет сервера в списке для быстрой идентификации. Возможные значения: `Purple` `Blue` `Turquoise` `Green` `Red` `Yellow` `Grey` `Orange` |\n| SmtpApiActivated | boolean | Указывает, включен ли SMTP на этом сервере. |\n| TrackOpens | boolean | Указывает, включено ли отслеживание открытий для всех писем, отправляемых через этот сервер. |\n| TrackLinks | boolean | Указывает, включено ли отслеживание ссылок для всех писем, отправляемых через этот сервер |\n| DeliveryType | string | Тип сервера: `Live` — живой, письма доставляются получателям; `Sandbox` — песочница, письма проходят все проверки и видны в статистике и вебхуках, но получателям не доставляются. Задаётся при создании сервера и не меняется. |\n\n[Метод в документации](https://haskimail.ru/developer/servers-api/#list-servers)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/servers?count=50&offset=0",
"host": [
"{{base_url}}"
],
"path": [
"servers"
],
"query": [
{
"key": "count",
"value": "50",
"description": ""
},
{
"key": "offset",
"value": "0",
"description": ""
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден в настройках вашего аккаунта Haskimail на вкладке «Токены API». |\n\n**Параметры строки запроса**\n\n| count | integer | обязательный Количество серверов, возвращаемых в ответе. |\n| --- | --- | --- |\n| offset | integer | обязательный Количество серверов, которые нужно пропустить. |\n| name | string | Фильтрация по имени сервера. Обратите внимание, что это строковый поиск, поэтому `MyServer` будет соответствовать `MyServer`,`MyServer Production` и `MyServer Test`. |\n\n**Ответ**\n\n| TotalCount | integer | Количество полученных серверов. |\n| --- | --- | --- |\n| Servers | array | Список серверов. |\n| ID | integer | ID сервера. |\n| Name | string | Название сервера. |\n| ApiTokens | array | Список API-токенов, связанных с сервером. |\n| Color | string | Цвет сервера в списке для быстрой идентификации. Возможные значения: `Purple` `Blue` `Turquoise` `Green` `Red` `Yellow` `Grey` `Orange` |\n| SmtpApiActivated | boolean | Указывает, включен ли SMTP на этом сервере. |\n| TrackOpens | boolean | Указывает, включено ли отслеживание открытий для всех писем, отправляемых через этот сервер. |\n| TrackLinks | boolean | Указывает, включено ли отслеживание ссылок для всех писем, отправляемых через этот сервер |\n| DeliveryType | string | Тип сервера: `Live` — живой, письма доставляются получателям; `Sandbox` — песочница, письма проходят все проверки и видны в статистике и вебхуках, но получателям не доставляются. Задаётся при создании сервера и не меняется. |\n\n[Метод в документации](https://haskimail.ru/developer/servers-api/#list-servers)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"TotalCount\": 2,\n \"Servers\": [\n {\n \"ID\": 1,\n \"Name\": \"Production01\",\n \"ApiTokens\": [\n \"server token\"\n ],\n \"Color\": \"red\",\n \"SmtpApiActivated\": true,\n \"TrackOpens\": false,\n \"TrackLinks\": false,\n \"DeliveryType\": \"Live\"\n },\n {\n \"ID\": 2,\n \"Name\": \"Production02\",\n \"ApiTokens\": [\n \"server token\"\n ],\n \"Color\": \"green\",\n \"SmtpApiActivated\": true,\n \"TrackOpens\": true,\n \"TrackLinks\": true,\n \"DeliveryType\": \"Sandbox\"\n }\n ]\n}"
}
]
},
{
"name": "Удаление сервера",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/servers/:serverid",
"host": [
"{{base_url}}"
],
"path": [
"servers",
":serverid"
],
"variable": [
{
"key": "serverid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "Примечание: Эта функция доступна не для всех аккаунтов. Пожалуйста, [свяжитесь со службой поддержки](/contact), если у вас возникнут вопросы.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден в настройках вашего аккаунта Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ErrorCode | integer | [Коды ошибок API.](/developer/api/overview#error-codes) |\n| --- | --- | --- |\n| Message | string | Ответ на запрос |\n\n[Метод в документации](https://haskimail.ru/developer/servers-api/#delete-server)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/servers/:serverid",
"host": [
"{{base_url}}"
],
"path": [
"servers",
":serverid"
],
"variable": [
{
"key": "serverid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "Примечание: Эта функция доступна не для всех аккаунтов. Пожалуйста, [свяжитесь со службой поддержки](/contact), если у вас возникнут вопросы.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден в настройках вашего аккаунта Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ErrorCode | integer | [Коды ошибок API.](/developer/api/overview#error-codes) |\n| --- | --- | --- |\n| Message | string | Ответ на запрос |\n\n[Метод в документации](https://haskimail.ru/developer/servers-api/#delete-server)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"ErrorCode\": 0,\n \"Message\": \"Сервер Production Server 2 удален.\"\n}"
}
]
}
]
},
{
"name": "API Доменов",
"description": "Позволяет управлять всеми деталями ваших доменов для конкретного аккаунта.",
"item": [
{
"name": "Список доменов",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/domains?count=50&offset=0",
"host": [
"{{base_url}}"
],
"path": [
"domains"
],
"query": [
{
"key": "count",
"value": "50",
"description": ""
},
{
"key": "offset",
"value": "0",
"description": ""
}
]
},
"description": "Получает список доменов с общей информацией и статусом аутентификации.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Параметры запроса**\n\n| count | обязательный Количество записей для возврата в одном запросе. Максимум 500. |\n| --- | --- |\n| offset | обязательный Количество записей, которое необходимо пропустить. |\n\n**Ответ**\n\n| TotalCount | integer | Указывает, сколько доменов соответствует указанным критериям поиска. Это число может быть больше, чем возвращено в одном запросе. |\n| --- | --- | --- |\n| Domains | array | Список объектов, каждый из которых представляет собой домен. |\n| Name | string | Название домена. |\n| SPFVerified | boolean | Указывает, была ли когда-либо подтверждена SPF-подпись для домена. |\n| DKIMVerified | boolean | Указывает, была ли когда-либо подтверждена DKIM-подпись для домена. Как только DKIM подтвержден, это поле останется true, даже если запись будет позже удалена из DNS. |\n| ReturnPathDomainVerified | boolean | TСтатус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования. |\n| ID | integer | Уникальный ID домена. |\n\n[Метод в документации](https://haskimail.ru/developer/domains-api/#list-domains)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/domains?count=50&offset=0",
"host": [
"{{base_url}}"
],
"path": [
"domains"
],
"query": [
{
"key": "count",
"value": "50",
"description": ""
},
{
"key": "offset",
"value": "0",
"description": ""
}
]
},
"description": "Получает список доменов с общей информацией и статусом аутентификации.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Параметры запроса**\n\n| count | обязательный Количество записей для возврата в одном запросе. Максимум 500. |\n| --- | --- |\n| offset | обязательный Количество записей, которое необходимо пропустить. |\n\n**Ответ**\n\n| TotalCount | integer | Указывает, сколько доменов соответствует указанным критериям поиска. Это число может быть больше, чем возвращено в одном запросе. |\n| --- | --- | --- |\n| Domains | array | Список объектов, каждый из которых представляет собой домен. |\n| Name | string | Название домена. |\n| SPFVerified | boolean | Указывает, была ли когда-либо подтверждена SPF-подпись для домена. |\n| DKIMVerified | boolean | Указывает, была ли когда-либо подтверждена DKIM-подпись для домена. Как только DKIM подтвержден, это поле останется true, даже если запись будет позже удалена из DNS. |\n| ReturnPathDomainVerified | boolean | TСтатус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования. |\n| ID | integer | Уникальный ID домена. |\n\n[Метод в документации](https://haskimail.ru/developer/domains-api/#list-domains)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"TotalCount\": 2,\n \"Domains\": [\n {\n \"Name\": \"haskimail.ru\",\n \"SPFVerified\": true,\n \"DKIMVerified\": true,\n \"ReturnPathDomainVerified\": false,\n \"ID\": 36735\n },\n {\n \"Name\": \"example.com\",\n \"SPFVerified\": true,\n \"DKIMVerified\": true,\n \"ReturnPathDomainVerified\": true,\n \"ID\": 81605\n }\n ]\n}"
}
]
},
{
"name": "Получение информации о домене",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/domains/:domainid",
"host": [
"{{base_url}}"
],
"path": [
"domains",
":domainid"
],
"variable": [
{
"key": "domainid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "Получает всю информацию о конкретном домена./p>\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\n| Name | string | Название домена. |\n| --- | --- | --- |\n| SPFVerified | boolean | Указывает, была ли когда-либо подтверждена SPF-подпись для домена. |\n| SPFHost | string | Имя хоста, используемое для конфигурации SPF. |\n| SPFTextValue | string | Значение, которое можно опционально настроить у вашего DNS-хостинга. |\n| DKIMVerified | boolean | Указывает, была ли когда-либо подтверждена DKIM-подпись для домена. Как только DKIM подтвержден, это поле останется true, даже если запись будет позже удалена из DNS. |\n| DKIMHost | string | DNS TXT-хост, используемый для валидации отправляемых сообщений. |\n| DKIMTextValue | string | Значение DNS TXT, используемое для валидации отправляемых сообщений. |\n| ReturnPathDomainVerified | boolean | Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования. |\n| ID | integer | Уникальный ID домена. |\n\n[Метод в документации](https://haskimail.ru/developer/domains-api/#domain)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/domains/:domainid",
"host": [
"{{base_url}}"
],
"path": [
"domains",
":domainid"
],
"variable": [
{
"key": "domainid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "Получает всю информацию о конкретном домена./p>\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\n| Name | string | Название домена. |\n| --- | --- | --- |\n| SPFVerified | boolean | Указывает, была ли когда-либо подтверждена SPF-подпись для домена. |\n| SPFHost | string | Имя хоста, используемое для конфигурации SPF. |\n| SPFTextValue | string | Значение, которое можно опционально настроить у вашего DNS-хостинга. |\n| DKIMVerified | boolean | Указывает, была ли когда-либо подтверждена DKIM-подпись для домена. Как только DKIM подтвержден, это поле останется true, даже если запись будет позже удалена из DNS. |\n| DKIMHost | string | DNS TXT-хост, используемый для валидации отправляемых сообщений. |\n| DKIMTextValue | string | Значение DNS TXT, используемое для валидации отправляемых сообщений. |\n| ReturnPathDomainVerified | boolean | Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования. |\n| ID | integer | Уникальный ID домена. |\n\n[Метод в документации](https://haskimail.ru/developer/domains-api/#domain)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"Name\": \"haskimail.ru\",\n \"SPFVerified\": true,\n \"SPFHost\": \"haskimail.ru\",\n \"SPFTextValue\": \"v=spf1 a mx include:spf.mtasv.net ~all\",\n \"DKIMVerified\": false,\n \"WeakDKIM\": false,\n \"DKIMHost\": \"jan2013pm._domainkey.haskimail.ru\",\n \"DKIMTextValue\": \"k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDJ...\",\n \"ReturnPathDomainVerified\": false,\n \"ID\": 36735\n}"
}
]
},
{
"name": "Создание домена",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/domains",
"host": [
"{{base_url}}"
],
"path": [
"domains"
]
},
"description": "**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Формат тела запроса**\n\n**Ответ**\n\n| Name | string | Название домена. |\n| --- | --- | --- |\n| SPFVerified | boolean | Указывает, была ли когда-либо подтверждена SPF-подпись для домена. |\n| SPFHost | string | Имя хоста, используемое для конфигурации SPF. |\n| SPFTextValue | string | Значение, которое можно опционально настроить у вашего DNS-хостинга. |\n| DKIMVerified | boolean | Указывает, была ли когда-либо подтверждена DKIM-подпись для домена. Как только DKIM подтвержден, это поле останется true, даже если запись будет позже удалена из DNS. |\n| DKIMHost | string | DNS TXT-хост, используемый для валидации отправляемых сообщений. |\n| DKIMTextValue | string | Значение DNS TXT, используемое для валидации отправляемых сообщений. |\n| ReturnPathDomainVerified | boolean | Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования. |\n| ID | integer | Уникальный ID домена. |\n\n[Метод в документации](https://haskimail.ru/developer/domains-api/#create-domain)",
"body": {
"mode": "raw",
"raw": "{\n \"Name\": \"example.com\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/domains",
"host": [
"{{base_url}}"
],
"path": [
"domains"
]
},
"description": "**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Формат тела запроса**\n\n**Ответ**\n\n| Name | string | Название домена. |\n| --- | --- | --- |\n| SPFVerified | boolean | Указывает, была ли когда-либо подтверждена SPF-подпись для домена. |\n| SPFHost | string | Имя хоста, используемое для конфигурации SPF. |\n| SPFTextValue | string | Значение, которое можно опционально настроить у вашего DNS-хостинга. |\n| DKIMVerified | boolean | Указывает, была ли когда-либо подтверждена DKIM-подпись для домена. Как только DKIM подтвержден, это поле останется true, даже если запись будет позже удалена из DNS. |\n| DKIMHost | string | DNS TXT-хост, используемый для валидации отправляемых сообщений. |\n| DKIMTextValue | string | Значение DNS TXT, используемое для валидации отправляемых сообщений. |\n| ReturnPathDomainVerified | boolean | Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования. |\n| ID | integer | Уникальный ID домена. |\n\n[Метод в документации](https://haskimail.ru/developer/domains-api/#create-domain)",
"body": {
"mode": "raw",
"raw": "{\n \"Name\": \"example.com\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"Name\": \"newdomain.com\",\n \"SPFVerified\": false,\n \"SPFHost\": \"newdomain.com\",\n \"SPFTextValue\": \"v=spf1 a mx include:spf.mtasv.net ~all\",\n \"DKIMVerified\": false,\n \"WeakDKIM\": false,\n \"DKIMHost\": \"\",\n \"DKIMTextValue\": \"\",\n \"ReturnPathDomainVerified\": false,\n \"ID\": 36736\n}"
}
]
},
{
"name": "Удаление домена",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/domains/:domainid",
"host": [
"{{base_url}}"
],
"path": [
"domains",
":domainid"
],
"variable": [
{
"key": "domainid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\n| ErrorCode | integer | [Коды ошибок API](/developer/api/overview#error-codes) |\n| --- | --- | --- |\n| Message | string | Ответ о результате |\n\n[Метод в документации](https://haskimail.ru/developer/domains-api/#delete-domain)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/domains/:domainid",
"host": [
"{{base_url}}"
],
"path": [
"domains",
":domainid"
],
"variable": [
{
"key": "domainid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\n| ErrorCode | integer | [Коды ошибок API](/developer/api/overview#error-codes) |\n| --- | --- | --- |\n| Message | string | Ответ о результате |\n\n[Метод в документации](https://haskimail.ru/developer/domains-api/#delete-domain)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"ErrorCode\": 0,\n \"Message\": \"Domain example.com removed.\"\n}"
}
]
},
{
"name": "Проверка статуса DKIM",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/domains/:domainid/verifyDkim",
"host": [
"{{base_url}}"
],
"path": [
"domains",
":domainid",
"verifyDkim"
],
"variable": [
{
"key": "domainid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "Проверить DKIM-ключи для указанного домена.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\n| Name | string | Название домена. |\n| --- | --- | --- |\n| SPFVerified | boolean | Указывает, была ли когда-либо подтверждена SPF-подпись для домена. |\n| SPFHost | string | Имя хоста, используемое для конфигурации SPF. |\n| SPFTextValue | string | Значение, которое можно опционально настроить у вашего DNS-хостинга. |\n| DKIMVerified | boolean | Указывает, была ли когда-либо подтверждена DKIM-подпись для домена. Как только DKIM подтвержден, это поле останется true, даже если запись будет позже удалена из DNS. |\n| DKIMHost | string | DNS TXT-хост, используемый для валидации отправляемых сообщений. |\n| DKIMTextValue | string | Значение DNS TXT, используемое для валидации отправляемых сообщений. |\n| ReturnPathDomainVerified | boolean | Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования. |\n| ID | integer | Уникальный ID домена. |\n\n[Метод в документации](https://haskimail.ru/developer/domains-api/#domains-verify-dkim)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/domains/:domainid/verifyDkim",
"host": [
"{{base_url}}"
],
"path": [
"domains",
":domainid",
"verifyDkim"
],
"variable": [
{
"key": "domainid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "Проверить DKIM-ключи для указанного домена.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\n| Name | string | Название домена. |\n| --- | --- | --- |\n| SPFVerified | boolean | Указывает, была ли когда-либо подтверждена SPF-подпись для домена. |\n| SPFHost | string | Имя хоста, используемое для конфигурации SPF. |\n| SPFTextValue | string | Значение, которое можно опционально настроить у вашего DNS-хостинга. |\n| DKIMVerified | boolean | Указывает, была ли когда-либо подтверждена DKIM-подпись для домена. Как только DKIM подтвержден, это поле останется true, даже если запись будет позже удалена из DNS. |\n| DKIMHost | string | DNS TXT-хост, используемый для валидации отправляемых сообщений. |\n| DKIMTextValue | string | Значение DNS TXT, используемое для валидации отправляемых сообщений. |\n| ReturnPathDomainVerified | boolean | Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования. |\n| ID | integer | Уникальный ID домена. |\n\n[Метод в документации](https://haskimail.ru/developer/domains-api/#domains-verify-dkim)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"Name\": \"haskimail.ru\",\n \"SPFVerified\": true,\n \"SPFHost\": \"haskimail.ru\",\n \"SPFTextValue\": \"v=spf1 a mx include:spf.mtasv.net ~all\",\n \"DKIMVerified\": false,\n \"WeakDKIM\": false,\n \"DKIMHost\": \"jan2013pm._domainkey.haskimail.ru\",\n \"DKIMTextValue\": \"k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDJ...\",\n \"ReturnPathDomainVerified\": false,\n \"ID\": 36735\n}"
}
]
},
{
"name": "Проверка SPF-записи",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/domains/:domainid/verifyspf",
"host": [
"{{base_url}}"
],
"path": [
"domains",
":domainid",
"verifyspf"
],
"variable": [
{
"key": "domainid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "Выполнит DNS-запрос для вашего домена и попытается проверить, содержит ли SPF-запись информацию о серверах Haskimail.\n\n**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\nПоле `SPFVerified` SPFVerified в ответе покажет, прошла ли проверка SPF успешно.\n\n| SPFHost | string | Имя хоста, используемое для конфигурации SPF. |\n| --- | --- | --- |\n| SPFVerified | boolean | Текстовая DNS-запись SPF правильно настроена у вашего регистратора домена или DNS-хостинга. |\n| SPFTextValue | string | Значение, которое можно опционально настроить у вашего DNS-хостинга. |\n\n[Метод в документации](https://haskimail.ru/developer/domains-api/#verify-spf)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/domains/:domainid/verifyspf",
"host": [
"{{base_url}}"
],
"path": [
"domains",
":domainid",
"verifyspf"
],
"variable": [
{
"key": "domainid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "Выполнит DNS-запрос для вашего домена и попытается проверить, содержит ли SPF-запись информацию о серверах Haskimail.\n\n**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\nПоле `SPFVerified` SPFVerified в ответе покажет, прошла ли проверка SPF успешно.\n\n| SPFHost | string | Имя хоста, используемое для конфигурации SPF. |\n| --- | --- | --- |\n| SPFVerified | boolean | Текстовая DNS-запись SPF правильно настроена у вашего регистратора домена или DNS-хостинга. |\n| SPFTextValue | string | Значение, которое можно опционально настроить у вашего DNS-хостинга. |\n\n[Метод в документации](https://haskimail.ru/developer/domains-api/#verify-spf)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"SPFHost\": \"example.com\",\n \"SPFVerified\": true,\n \"SPFTextValue\": \"v=spf1 a mx include:spf.mtasv.net ~all\"\n}"
}
]
}
]
},
{
"name": "API подписей отправителей",
"description": "Позволяет управлять всеми подписями отправителей вашего аккаунта.",
"item": [
{
"name": "Список подписей отправителей",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/senders?count=50&offset=0",
"host": [
"{{base_url}}"
],
"path": [
"senders"
],
"query": [
{
"key": "count",
"value": "50",
"description": ""
},
{
"key": "offset",
"value": "0",
"description": ""
}
]
},
"description": "Получает список подписей отправителей с краткой информацией, связанной с вашим аккаунтом.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Параметры запроса**\n\n| count | обязательный Количество записей для возврата в одном запросе. Максимум 500. |\n| --- | --- |\n| offset | обязательный Количество записей, которое необходимо пропустить. |\n\n**Ответ**\n\n| TotalCount | integer | Указывает, сколько подписей отправителей соответствует указанным критериям поиска. Это число может быть больше, чем возвращено в одном запросе. |\n| --- | --- | --- |\n| SenderSignatures | array | Список объектов, каждый из которых представляет собой подпись отправителя. |\n| Domain | string | Домен, связанный с подписью отправителя. |\n| EmailAddress | string | Email-адрес подписи отправителя. |\n| ReplyToEmailAddress | string | Email-адрес для ответа, связанный с подписью отправителя. |\n| Name | string | Имя отправителя в подписи. |\n| Confirmed | boolean | Указывает, подтверждена ли эта подпись отправителя. |\n| ID | integer | Уникальный ID подписи отправителя. |\n\n[Метод в документации](https://haskimail.ru/developer/signatures-api/#list-sender-signatures)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/senders?count=50&offset=0",
"host": [
"{{base_url}}"
],
"path": [
"senders"
],
"query": [
{
"key": "count",
"value": "50",
"description": ""
},
{
"key": "offset",
"value": "0",
"description": ""
}
]
},
"description": "Получает список подписей отправителей с краткой информацией, связанной с вашим аккаунтом.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Параметры запроса**\n\n| count | обязательный Количество записей для возврата в одном запросе. Максимум 500. |\n| --- | --- |\n| offset | обязательный Количество записей, которое необходимо пропустить. |\n\n**Ответ**\n\n| TotalCount | integer | Указывает, сколько подписей отправителей соответствует указанным критериям поиска. Это число может быть больше, чем возвращено в одном запросе. |\n| --- | --- | --- |\n| SenderSignatures | array | Список объектов, каждый из которых представляет собой подпись отправителя. |\n| Domain | string | Домен, связанный с подписью отправителя. |\n| EmailAddress | string | Email-адрес подписи отправителя. |\n| ReplyToEmailAddress | string | Email-адрес для ответа, связанный с подписью отправителя. |\n| Name | string | Имя отправителя в подписи. |\n| Confirmed | boolean | Указывает, подтверждена ли эта подпись отправителя. |\n| ID | integer | Уникальный ID подписи отправителя. |\n\n[Метод в документации](https://haskimail.ru/developer/signatures-api/#list-sender-signatures)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"TotalCount\": 2,\n \"SenderSignatures\": [\n {\n \"Domain\": \"haskimail.ru\",\n \"EmailAddress\": \"jp@haskimail.ru\",\n \"ReplyToEmailAddress\": \"info@haskimail.ru\",\n \"Name\": \"JP Toto\",\n \"Confirmed\": true,\n \"ID\": 36735\n },\n {\n \"Domain\": \"example.com\",\n \"EmailAddress\": \"jp@example.com\",\n \"ReplyToEmailAddress\": \"\",\n \"Name\": \"JP Toto\",\n \"Confirmed\": true,\n \"ID\": 81605\n }\n ]\n}"
}
]
},
{
"name": "Получение деталей подписи отправителя",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/senders/:signatureid",
"host": [
"{{base_url}}"
],
"path": [
"senders",
":signatureid"
],
"variable": [
{
"key": "signatureid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "Получает все детали для конкретной подписи отправителя.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\n| Domain | string | Домен, связанный с подписью отправителя. |\n| --- | --- | --- |\n| EmailAddress | string | Email-адрес подписи отправителя. |\n| ReplyToEmailAddress | string | Email-адрес для ответа, связанный с подписью отправителя. |\n| Name | string | Имя отправителя в подписи. |\n| Confirmed | boolean | Указывает, подтверждена ли эта подпись отправителя. |\n| SPFVerified | boolean | Указывает, была ли когда-либо подтверждена SPF-подпись для домена. |\n| SPFHost | string | Имя хоста, используемое для конфигурации SPF. |\n| SPFTextValue | string | Значение, которое можно опционально настроить у вашего DNS-хостинга. |\n| DKIMVerified | boolean | Указывает, была ли когда-либо подтверждена DKIM-подпись для домена. Как только DKIM подтвержден, это поле останется true, даже если запись будет позже удалена из DNS. |\n| DKIMHost | string | DNS TXT-хост, используемый для валидации отправляемых сообщений. |\n| DKIMTextValue | string | Значение DNS TXT, используемое для валидации отправляемых сообщений. |\n| DKIMPendingHost | string | Если было инициировано обновление DKIM или это DKIM от новой подписи отправителя, это поле покажет ожидающий подтверждения DNS TXT-хост, который еще предстоит настроить и подтвердить у вашего регистратора или DNS-хостинга. |\n| DKIMPendingTextValue | string | Аналогично полю DKIMPendingHost, это поле покажет значение DNS TXT, ожидающее подтверждения у вашего регистратора или DNS-хостинга. |\n| DKIMRevokedHost | string | Как только новый DKIM будет подтвержден у вашего регистратора или DNS-хостинга, Haskimail отзовет старый DKIM-хост в рамках подготовки к его окончательному удалению из системы. |\n| DKIMRevokedTextValue | string | Аналогично DKIMRevokedHost, это поле покажет значение DNS TXT, которое скоро будет удалено из системы Haskimail.. |\n| SafeToRemoveRevokedKeyFromDNS | boolean | Указывает, можете ли вы безопасно удалить старые DKIM DNS TXT-записи у вашего регистратора или DNS-хостинга. Новый DKIM теперь безопасно используется. |\n| DKIMUpdateStatus | string | Пока выполняются или настраиваются операции по обновлению или созданию нового DKIM, это поле будет иметь значение Pending. После того как все DNS TXT-записи будут обновлены и любые ожидающие операции обновления завершены, оно изменится на `Verified`. |\n| ReturnPathDomain | boolean | Пользовательский домен Return-Path для этой подписи. Для получения дополнительной информации об этом поле, пожалуйста, ознакомьтесь с нашей статьей.. |\n| ReturnPathDomainVerified | boolean | Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования. |\n| ReturnPathDomainCNAMEValue | string | CNAME DNS-запись, которую Haskimail ожидает найти по адресу, указанному в ReturnPathDomain. |\n| ID | integer | Уникальный ID подписи отправителя. |\n| ConfirmationPersonalNote | string | Текст личного сообщения, отправленного получателю для подтверждения. |\n\n[Метод в документации](https://haskimail.ru/developer/signatures-api/#sender-signature)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/senders/:signatureid",
"host": [
"{{base_url}}"
],
"path": [
"senders",
":signatureid"
],
"variable": [
{
"key": "signatureid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "Получает все детали для конкретной подписи отправителя.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\n| Domain | string | Домен, связанный с подписью отправителя. |\n| --- | --- | --- |\n| EmailAddress | string | Email-адрес подписи отправителя. |\n| ReplyToEmailAddress | string | Email-адрес для ответа, связанный с подписью отправителя. |\n| Name | string | Имя отправителя в подписи. |\n| Confirmed | boolean | Указывает, подтверждена ли эта подпись отправителя. |\n| SPFVerified | boolean | Указывает, была ли когда-либо подтверждена SPF-подпись для домена. |\n| SPFHost | string | Имя хоста, используемое для конфигурации SPF. |\n| SPFTextValue | string | Значение, которое можно опционально настроить у вашего DNS-хостинга. |\n| DKIMVerified | boolean | Указывает, была ли когда-либо подтверждена DKIM-подпись для домена. Как только DKIM подтвержден, это поле останется true, даже если запись будет позже удалена из DNS. |\n| DKIMHost | string | DNS TXT-хост, используемый для валидации отправляемых сообщений. |\n| DKIMTextValue | string | Значение DNS TXT, используемое для валидации отправляемых сообщений. |\n| DKIMPendingHost | string | Если было инициировано обновление DKIM или это DKIM от новой подписи отправителя, это поле покажет ожидающий подтверждения DNS TXT-хост, который еще предстоит настроить и подтвердить у вашего регистратора или DNS-хостинга. |\n| DKIMPendingTextValue | string | Аналогично полю DKIMPendingHost, это поле покажет значение DNS TXT, ожидающее подтверждения у вашего регистратора или DNS-хостинга. |\n| DKIMRevokedHost | string | Как только новый DKIM будет подтвержден у вашего регистратора или DNS-хостинга, Haskimail отзовет старый DKIM-хост в рамках подготовки к его окончательному удалению из системы. |\n| DKIMRevokedTextValue | string | Аналогично DKIMRevokedHost, это поле покажет значение DNS TXT, которое скоро будет удалено из системы Haskimail.. |\n| SafeToRemoveRevokedKeyFromDNS | boolean | Указывает, можете ли вы безопасно удалить старые DKIM DNS TXT-записи у вашего регистратора или DNS-хостинга. Новый DKIM теперь безопасно используется. |\n| DKIMUpdateStatus | string | Пока выполняются или настраиваются операции по обновлению или созданию нового DKIM, это поле будет иметь значение Pending. После того как все DNS TXT-записи будут обновлены и любые ожидающие операции обновления завершены, оно изменится на `Verified`. |\n| ReturnPathDomain | boolean | Пользовательский домен Return-Path для этой подписи. Для получения дополнительной информации об этом поле, пожалуйста, ознакомьтесь с нашей статьей.. |\n| ReturnPathDomainVerified | boolean | Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования. |\n| ReturnPathDomainCNAMEValue | string | CNAME DNS-запись, которую Haskimail ожидает найти по адресу, указанному в ReturnPathDomain. |\n| ID | integer | Уникальный ID подписи отправителя. |\n| ConfirmationPersonalNote | string | Текст личного сообщения, отправленного получателю для подтверждения. |\n\n[Метод в документации](https://haskimail.ru/developer/signatures-api/#sender-signature)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"Domain\": \"haskimail.ru\",\n \"EmailAddress\": \"jp@haskimail.ru\",\n \"ReplyToEmailAddress\": \"info@haskimail.ru\",\n \"Name\": \"JP Toto\",\n \"Confirmed\": true,\n \"SPFVerified\": true,\n \"SPFHost\": \"haskimail.ru\",\n \"SPFTextValue\": \"v=spf1 a mx include:spf.mtasv.net ~all\",\n \"DKIMVerified\": false,\n \"DKIMHost\": \"jan2013.pm._domainkey.haskimail.ru\",\n \"DKIMTextValue\": \"k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDJ...\",\n \"DKIMPendingHost\": \"20131031155228.pm._domainkey.haskimail.ru\",\n \"DKIMPendingTextValue\": \"k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCFn...\",\n \"DKIMRevokedHost\": \"\",\n \"DKIMRevokedTextValue\": \"\",\n \"SafeToRemoveRevokedKeyFromDNS\": false,\n \"DKIMUpdateStatus\": \"Pending\",\n \"ReturnPathDomain\": \"pm-bounces.haskimail.ru\",\n \"ReturnPathDomainVerified\": false,\n \"ReturnPathDomainCNAMEValue\": \"pm.mtasv.net\",\n \"ID\": 36735,\n \"ConfirmationPersonalNote\": \"Это личное сообщение, видимое получателю, чтобы объяснить, что такое Haskimail.\"\n}"
}
]
},
{
"name": "Создание подписи",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/senders",
"host": [
"{{base_url}}"
],
"path": [
"senders"
]
},
"description": "**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Body format**\n\n| FromEmail | string | обязательный Email-адрес, который будет связан с подписью отправителя. |\n| --- | --- | --- |\n| Name | string | обязательный Имя, которое будет связано с подписью отправителя. |\n| ReplyToEmail | string | Адрес для ответа, переопределяющий стандартный. |\n| ReturnPathDomain | string | Пользовательское значение для домена Return-Path. Это необязательное поле, но оно должно быть поддоменом вашего домена из поля FromEmail и иметь CNAME-запись, указывающую на hm.mtasv.net. Для получения дополнительной информации об этом поле, пожалуйста, ознакомьтесь с нашей статьей. |\n| ConfirmationPersonalNote | string | Необязательно. Способ предоставить получателю подтверждающего письма примечание, чтобы объяснить, что такое Haskimail. Максимальная длина 400 символов. |\n\n**Ответ**\n\n| Domain | string | Домен, связанный с подписью отправителя. |\n| --- | --- | --- |\n| EmailAddress | string | Email associated with sender signature. |\n| ReplyToEmailAddress | string | Email-адрес для ответа, связанный с подписью отправителя. |\n| Name | string | Имя отправителя в подписи. |\n| Confirmed | boolean | Указывает, подтверждена ли эта подпись отправителя. |\n| SPFVerified | boolean | Указывает, была ли когда-либо подтверждена SPF-подпись для домена. |\n| SPFHost | string | Имя хоста, используемое для конфигурации SPF. |\n| SPFTextValue | string | Значение, которое можно опционально настроить у вашего DNS-хостинга. |\n| DKIMVerified | boolean | Указывает, была ли когда-либо подтверждена DKIM-подпись для домена. Как только DKIM подтвержден, это поле останется true, даже если запись будет позже удалена из DNS. |\n| DKIMHost | string | DNS TXT-хост, используемый для валидации отправляемых сообщений. |\n| DKIMTextValue | string | Значение DNS TXT, используемое для валидации отправляемых сообщений. |\n| DKIMPendingHost | string | Если было инициировано обновление DKIM или это DKIM от новой подписи отправителя, это поле покажет ожидающий подтверждения DNS TXT-хост, который еще предстоит настроить и подтвердить у вашего регистратора или DNS-хостинга. |\n| DKIMPendingTextValue | string | Аналогично полю DKIMPendingHost, это поле покажет значение DNS TXT, ожидающее подтверждения у вашего регистратора или DNS-хостинга. |\n| DKIMRevokedHost | string | Как только новый DKIM будет подтвержден у вашего регистратора или DNS-хостинга, Haskimail отзовет старый DKIM-хост в рамках подготовки к его окончательному удалению из системы. |\n| DKIMRevokedTextValue | string | Аналогично DKIMRevokedHost, это поле покажет значение DNS TXT, которое скоро будет удалено из системы Haskimail.. |\n| SafeToRemoveRevokedKeyFromDNS | boolean | Указывает, можете ли вы безопасно удалить старые DKIM DNS TXT-записи у вашего регистратора или DNS-хостинга. Новый DKIM теперь безопасно используется. |\n| DKIMUpdateStatus | string | Пока выполняются или настраиваются операции по обновлению или созданию нового DKIM, это поле будет иметь значение Pending. После того как все DNS TXT-записи будут обновлены и любые ожидающие операции обновления завершены, оно изменится на `Verified`. |\n| ReturnPathDomain | boolean | Пользовательский домен Return-Path для этой подписи. Для получения дополнительной информации об этом поле, пожалуйста, ознакомьтесь с нашей статьей.. |\n| ReturnPathDomainVerified | boolean | Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования. |\n| ReturnPathDomainCNAMEValue | string | CNAME DNS-запись, которую Haskimail ожидает найти по адресу, указанному в ReturnPathDomain. |\n| ID | integer | Уникальный ID подписи отправителя. |\n| ConfirmationPersonalNote | string | Текст личного сообщения, отправленного получателю для подтверждения. |\n\n[Метод в документации](https://haskimail.ru/developer/signatures-api/#create-signature)",
"body": {
"mode": "raw",
"raw": "{\n \"FromEmail\": \"ivan.ivanov@example.com\",\n \"Name\": \"Иван Иванов\",\n \"ReplyToEmail\": \"reply@example.com\",\n \"ConfirmationPersonalNote\": \"Это личное сообщение, видимое получателю, чтобы объяснить, что такое Haskimail.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/senders",
"host": [
"{{base_url}}"
],
"path": [
"senders"
]
},
"description": "**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Body format**\n\n| FromEmail | string | обязательный Email-адрес, который будет связан с подписью отправителя. |\n| --- | --- | --- |\n| Name | string | обязательный Имя, которое будет связано с подписью отправителя. |\n| ReplyToEmail | string | Адрес для ответа, переопределяющий стандартный. |\n| ReturnPathDomain | string | Пользовательское значение для домена Return-Path. Это необязательное поле, но оно должно быть поддоменом вашего домена из поля FromEmail и иметь CNAME-запись, указывающую на hm.mtasv.net. Для получения дополнительной информации об этом поле, пожалуйста, ознакомьтесь с нашей статьей. |\n| ConfirmationPersonalNote | string | Необязательно. Способ предоставить получателю подтверждающего письма примечание, чтобы объяснить, что такое Haskimail. Максимальная длина 400 символов. |\n\n**Ответ**\n\n| Domain | string | Домен, связанный с подписью отправителя. |\n| --- | --- | --- |\n| EmailAddress | string | Email associated with sender signature. |\n| ReplyToEmailAddress | string | Email-адрес для ответа, связанный с подписью отправителя. |\n| Name | string | Имя отправителя в подписи. |\n| Confirmed | boolean | Указывает, подтверждена ли эта подпись отправителя. |\n| SPFVerified | boolean | Указывает, была ли когда-либо подтверждена SPF-подпись для домена. |\n| SPFHost | string | Имя хоста, используемое для конфигурации SPF. |\n| SPFTextValue | string | Значение, которое можно опционально настроить у вашего DNS-хостинга. |\n| DKIMVerified | boolean | Указывает, была ли когда-либо подтверждена DKIM-подпись для домена. Как только DKIM подтвержден, это поле останется true, даже если запись будет позже удалена из DNS. |\n| DKIMHost | string | DNS TXT-хост, используемый для валидации отправляемых сообщений. |\n| DKIMTextValue | string | Значение DNS TXT, используемое для валидации отправляемых сообщений. |\n| DKIMPendingHost | string | Если было инициировано обновление DKIM или это DKIM от новой подписи отправителя, это поле покажет ожидающий подтверждения DNS TXT-хост, который еще предстоит настроить и подтвердить у вашего регистратора или DNS-хостинга. |\n| DKIMPendingTextValue | string | Аналогично полю DKIMPendingHost, это поле покажет значение DNS TXT, ожидающее подтверждения у вашего регистратора или DNS-хостинга. |\n| DKIMRevokedHost | string | Как только новый DKIM будет подтвержден у вашего регистратора или DNS-хостинга, Haskimail отзовет старый DKIM-хост в рамках подготовки к его окончательному удалению из системы. |\n| DKIMRevokedTextValue | string | Аналогично DKIMRevokedHost, это поле покажет значение DNS TXT, которое скоро будет удалено из системы Haskimail.. |\n| SafeToRemoveRevokedKeyFromDNS | boolean | Указывает, можете ли вы безопасно удалить старые DKIM DNS TXT-записи у вашего регистратора или DNS-хостинга. Новый DKIM теперь безопасно используется. |\n| DKIMUpdateStatus | string | Пока выполняются или настраиваются операции по обновлению или созданию нового DKIM, это поле будет иметь значение Pending. После того как все DNS TXT-записи будут обновлены и любые ожидающие операции обновления завершены, оно изменится на `Verified`. |\n| ReturnPathDomain | boolean | Пользовательский домен Return-Path для этой подписи. Для получения дополнительной информации об этом поле, пожалуйста, ознакомьтесь с нашей статьей.. |\n| ReturnPathDomainVerified | boolean | Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования. |\n| ReturnPathDomainCNAMEValue | string | CNAME DNS-запись, которую Haskimail ожидает найти по адресу, указанному в ReturnPathDomain. |\n| ID | integer | Уникальный ID подписи отправителя. |\n| ConfirmationPersonalNote | string | Текст личного сообщения, отправленного получателю для подтверждения. |\n\n[Метод в документации](https://haskimail.ru/developer/signatures-api/#create-signature)",
"body": {
"mode": "raw",
"raw": "{\n \"FromEmail\": \"ivan.ivanov@example.com\",\n \"Name\": \"Иван Иванов\",\n \"ReplyToEmail\": \"reply@example.com\",\n \"ConfirmationPersonalNote\": \"Это личное сообщение, видимое получателю, чтобы объяснить, что такое Haskimail.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"Domain\": \"example.com\",\n \"EmailAddress\": \"ivan.ivanov@example.com\",\n \"ReplyToEmailAddress\": \"reply@example.com\",\n \"Name\": \"Иван Иванов\",\n \"Confirmed\": false,\n \"SPFVerified\": false,\n \"SPFHost\": \"example.com\",\n \"SPFTextValue\": \"v=spf1 a mx include:spf.mtasv.net ~all\",\n \"DKIMVerified\": false,\n \"DKIMHost\": \"\",\n \"DKIMTextValue\": \"\",\n \"DKIMPendingHost\": \"20140220130148.pm._domainkey.example.com\",\n \"DKIMPendingTextValue\": \"k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCQ35xZciGB0g...\",\n \"DKIMRevokedHost\": \"\",\n \"DKIMRevokedTextValue\": \"\",\n \"SafeToRemoveRevokedKeyFromDNS\": false,\n \"DKIMUpdateStatus\": \"Pending\",\n \"ReturnPathDomain\": \"pm-bounces.example.com\",\n \"ReturnPathDomainVerified\": true,\n \"ReturnPathDomainCNAMEValue\": \"pm.mtasv.net\",\n \"ID\": 1,\n \"ConfirmationPersonalNote\": \"Это личное сообщение, видимое получателю, чтобы объяснить, что такое Haskimail.\"\n}"
}
]
},
{
"name": "Редактирование подписи",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/senders/:signatureid",
"host": [
"{{base_url}}"
],
"path": [
"senders",
":signatureid"
],
"variable": [
{
"key": "signatureid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Body format**\n\n| Name | string | обязательный Имя, которое будет связано с подписью отправителя. |\n| --- | --- | --- |\n| ReplyToEmail | string | Адрес для ответа, переопределяющий стандартный. |\n| ReturnPathDomain | string | Пользовательское значение для домена Return-Path. Это необязательное поле, но оно должно быть поддоменом вашего домена из поля FromEmail и иметь CNAME-запись, указывающую на hm.mtasv.net. Для получения дополнительной информации об этом поле, пожалуйста, ознакомьтесь с нашей статьей. |\n| ConfirmationPersonalNote | string | Необязательно. Способ предоставить получателю подтверждающего письма примечание, чтобы объяснить, что такое Haskimail. Максимальная длина 400 символов. |\n\n**Ответ**\n\n| Domain | string | Домен, связанный с подписью отправителя. |\n| --- | --- | --- |\n| EmailAddress | string | Email-адрес подписи отправителя. |\n| ReplyToEmailAddress | string | Email-адрес для ответа, связанный с подписью отправителя. |\n| Name | string | Имя отправителя в подписи. |\n| Confirmed | boolean | Указывает, подтверждена ли эта подпись отправителя. |\n| SPFVerified | boolean | Указывает, была ли когда-либо подтверждена SPF-подпись для домена. |\n| SPFHost | string | Имя хоста, используемое для конфигурации SPF. |\n| SPFTextValue | string | Значение, которое можно опционально настроить у вашего DNS-хостинга. |\n| DKIMVerified | boolean | Указывает, была ли когда-либо подтверждена DKIM-подпись для домена. Как только DKIM подтвержден, это поле останется true, даже если запись будет позже удалена из DNS. |\n| DKIMHost | string | DNS TXT-хост, используемый для валидации отправляемых сообщений. |\n| DKIMTextValue | string | Значение DNS TXT, используемое для валидации отправляемых сообщений. |\n| DKIMPendingHost | string | Если было инициировано обновление DKIM или это DKIM от новой подписи отправителя, это поле покажет ожидающий подтверждения DNS TXT-хост, который еще предстоит настроить и подтвердить у вашего регистратора или DNS-хостинга. |\n| DKIMPendingTextValue | string | Аналогично полю DKIMPendingHost, это поле покажет значение DNS TXT, ожидающее подтверждения у вашего регистратора или DNS-хостинга. |\n| DKIMRevokedHost | string | Как только новый DKIM будет подтвержден у вашего регистратора или DNS-хостинга, Haskimail отзовет старый DKIM-хост в рамках подготовки к его окончательному удалению из системы. |\n| DKIMRevokedTextValue | string | Аналогично DKIMRevokedHost, это поле покажет значение DNS TXT, которое скоро будет удалено из системы Haskimail.. |\n| SafeToRemoveRevokedKeyFromDNS | boolean | Указывает, можете ли вы безопасно удалить старые DKIM DNS TXT-записи у вашего регистратора или DNS-хостинга. Новый DKIM теперь безопасно используется. |\n| DKIMUpdateStatus | string | Пока выполняются или настраиваются операции по обновлению или созданию нового DKIM, это поле будет иметь значение Pending. После того как все DNS TXT-записи будут обновлены и любые ожидающие операции обновления завершены, оно изменится на `Verified`. |\n| ReturnPathDomain | boolean | Пользовательский домен Return-Path для этой подписи. Для получения дополнительной информации об этом поле, пожалуйста, ознакомьтесь с нашей статьей.. |\n| ReturnPathDomainVerified | boolean | Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования. |\n| ReturnPathDomainCNAMEValue | string | CNAME DNS-запись, которую Haskimail ожидает найти по адресу, указанному в ReturnPathDomain. |\n| ID | integer | Уникальный ID подписи отправителя. |\n| ConfirmationPersonalNote | string | Текст личного сообщения, отправленного получателю для подтверждения. |\n\n[Метод в документации](https://haskimail.ru/developer/signatures-api/#edit-signature)",
"body": {
"mode": "raw",
"raw": "{\n \"Name\": \"Вася Пупкин\",\n \"ReplyToEmail\": \"vasya.pupkin@example.com\",\n \"ReturnPathDomain\": \"pm-bounces.example.com\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/senders/:signatureid",
"host": [
"{{base_url}}"
],
"path": [
"senders",
":signatureid"
],
"variable": [
{
"key": "signatureid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Body format**\n\n| Name | string | обязательный Имя, которое будет связано с подписью отправителя. |\n| --- | --- | --- |\n| ReplyToEmail | string | Адрес для ответа, переопределяющий стандартный. |\n| ReturnPathDomain | string | Пользовательское значение для домена Return-Path. Это необязательное поле, но оно должно быть поддоменом вашего домена из поля FromEmail и иметь CNAME-запись, указывающую на hm.mtasv.net. Для получения дополнительной информации об этом поле, пожалуйста, ознакомьтесь с нашей статьей. |\n| ConfirmationPersonalNote | string | Необязательно. Способ предоставить получателю подтверждающего письма примечание, чтобы объяснить, что такое Haskimail. Максимальная длина 400 символов. |\n\n**Ответ**\n\n| Domain | string | Домен, связанный с подписью отправителя. |\n| --- | --- | --- |\n| EmailAddress | string | Email-адрес подписи отправителя. |\n| ReplyToEmailAddress | string | Email-адрес для ответа, связанный с подписью отправителя. |\n| Name | string | Имя отправителя в подписи. |\n| Confirmed | boolean | Указывает, подтверждена ли эта подпись отправителя. |\n| SPFVerified | boolean | Указывает, была ли когда-либо подтверждена SPF-подпись для домена. |\n| SPFHost | string | Имя хоста, используемое для конфигурации SPF. |\n| SPFTextValue | string | Значение, которое можно опционально настроить у вашего DNS-хостинга. |\n| DKIMVerified | boolean | Указывает, была ли когда-либо подтверждена DKIM-подпись для домена. Как только DKIM подтвержден, это поле останется true, даже если запись будет позже удалена из DNS. |\n| DKIMHost | string | DNS TXT-хост, используемый для валидации отправляемых сообщений. |\n| DKIMTextValue | string | Значение DNS TXT, используемое для валидации отправляемых сообщений. |\n| DKIMPendingHost | string | Если было инициировано обновление DKIM или это DKIM от новой подписи отправителя, это поле покажет ожидающий подтверждения DNS TXT-хост, который еще предстоит настроить и подтвердить у вашего регистратора или DNS-хостинга. |\n| DKIMPendingTextValue | string | Аналогично полю DKIMPendingHost, это поле покажет значение DNS TXT, ожидающее подтверждения у вашего регистратора или DNS-хостинга. |\n| DKIMRevokedHost | string | Как только новый DKIM будет подтвержден у вашего регистратора или DNS-хостинга, Haskimail отзовет старый DKIM-хост в рамках подготовки к его окончательному удалению из системы. |\n| DKIMRevokedTextValue | string | Аналогично DKIMRevokedHost, это поле покажет значение DNS TXT, которое скоро будет удалено из системы Haskimail.. |\n| SafeToRemoveRevokedKeyFromDNS | boolean | Указывает, можете ли вы безопасно удалить старые DKIM DNS TXT-записи у вашего регистратора или DNS-хостинга. Новый DKIM теперь безопасно используется. |\n| DKIMUpdateStatus | string | Пока выполняются или настраиваются операции по обновлению или созданию нового DKIM, это поле будет иметь значение Pending. После того как все DNS TXT-записи будут обновлены и любые ожидающие операции обновления завершены, оно изменится на `Verified`. |\n| ReturnPathDomain | boolean | Пользовательский домен Return-Path для этой подписи. Для получения дополнительной информации об этом поле, пожалуйста, ознакомьтесь с нашей статьей.. |\n| ReturnPathDomainVerified | boolean | Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования. |\n| ReturnPathDomainCNAMEValue | string | CNAME DNS-запись, которую Haskimail ожидает найти по адресу, указанному в ReturnPathDomain. |\n| ID | integer | Уникальный ID подписи отправителя. |\n| ConfirmationPersonalNote | string | Текст личного сообщения, отправленного получателю для подтверждения. |\n\n[Метод в документации](https://haskimail.ru/developer/signatures-api/#edit-signature)",
"body": {
"mode": "raw",
"raw": "{\n \"Name\": \"Вася Пупкин\",\n \"ReplyToEmail\": \"vasya.pupkin@example.com\",\n \"ReturnPathDomain\": \"pm-bounces.example.com\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"Domain\": \"example.com\",\n \"EmailAddress\": \"ivan.ivanov@example.com\",\n \"ReplyToEmailAddress\": \"jane.doe@example.com\",\n \"Name\": \"Jane Doe\",\n \"Confirmed\": false,\n \"SPFVerified\": false,\n \"SPFHost\": \"crazydomain.com\",\n \"SPFTextValue\": \"v=spf1 a mx include:spf.mtasv.net ~all\",\n \"DKIMVerified\": false,\n \"DKIMHost\": \"\",\n \"DKIMTextValue\": \"\",\n \"DKIMPendingHost\": \"20140220130148.pm._domainkey.crazydomain.com\",\n \"DKIMPendingTextValue\": \"k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCQ35xZciGB0g...\",\n \"DKIMRevokedHost\": \"\",\n \"DKIMRevokedTextValue\": \"\",\n \"SafeToRemoveRevokedKeyFromDNS\": false,\n \"DKIMUpdateStatus\": \"Pending\",\n \"ReturnPathDomain\": \"pm-bounces.example.com\",\n \"ReturnPathDomainVerified\": true,\n \"ReturnPathDomainCNAMEValue\": \"pm.mtasv.net\",\n \"ID\": 1,\n \"ConfirmationPersonalNote\": \"Это личное сообщение, видимое получателю, чтобы объяснить, что такое Haskimail.\"\n}"
}
]
},
{
"name": "Удаление подписи",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/senders/:signatureid",
"host": [
"{{base_url}}"
],
"path": [
"senders",
":signatureid"
],
"variable": [
{
"key": "signatureid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\n| ErrorCode | integer | [Коды ошибок API](/developer/api/overview#error-codes) |\n| --- | --- | --- |\n| Message | string | Ответ с результатом |\n\n[Метод в документации](https://haskimail.ru/developer/signatures-api/#delete-signature)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/senders/:signatureid",
"host": [
"{{base_url}}"
],
"path": [
"senders",
":signatureid"
],
"variable": [
{
"key": "signatureid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\n| ErrorCode | integer | [Коды ошибок API](/developer/api/overview#error-codes) |\n| --- | --- | --- |\n| Message | string | Ответ с результатом |\n\n[Метод в документации](https://haskimail.ru/developer/signatures-api/#delete-signature)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"ErrorCode\": 0,\n \"Message\": \"Signature someone@example.com removed.\"\n}"
}
]
},
{
"name": "Повторная отправка подтверждения",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/senders/:signatureid/resend",
"host": [
"{{base_url}}"
],
"path": [
"senders",
":signatureid",
"resend"
],
"variable": [
{
"key": "signatureid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\n| ErrorCode | integer | [Коды ошибок API](/developer/api/overview#error-codes) |\n| --- | --- | --- |\n| Message | string | Ответ с результатом |\n\n[Метод в документации](https://haskimail.ru/developer/signatures-api/#resend-confirmation)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/senders/:signatureid/resend",
"host": [
"{{base_url}}"
],
"path": [
"senders",
":signatureid",
"resend"
],
"variable": [
{
"key": "signatureid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\n| ErrorCode | integer | [Коды ошибок API](/developer/api/overview#error-codes) |\n| --- | --- | --- |\n| Message | string | Ответ с результатом |\n\n[Метод в документации](https://haskimail.ru/developer/signatures-api/#resend-confirmation)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"ErrorCode\": 0,\n \"Message\": \"Confirmation email for Sender Signature ivan.ivanov@example.com was re-sent.\"\n}"
}
]
},
{
"name": "Проверка SPF-записи",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/senders/:signatureid/verifyspf",
"host": [
"{{base_url}}"
],
"path": [
"senders",
":signatureid",
"verifyspf"
],
"variable": [
{
"key": "signatureid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "Запрашивает DNS вашего домена и пытается проверить, содержит ли SPF-запись информацию о серверах Haskimail.\n\n**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\nПоле `SPFVerified` SPFVerified в ответе укажет, была ли проверка SPF успешной.\n\n| Domain | string | Домен, связанный с подписью отправителя. |\n| --- | --- | --- |\n| EmailAddress | string | Email-адрес, связанный с подписью отправителя. |\n| ReplyToEmailAddress | string | Email-адрес для ответа, связанный с подписью отправителя. |\n| Name | string | Имя отправителя в подписи. |\n| Confirmed | boolean | Указывает, подтверждена ли эта подпись отправителя. |\n| SPFVerified | boolean | Указывает, правильно ли настроена SPF DNS TXT-запись у вашего регистратора доменов или DNS-хостинга. |\n| SPFHost | string | Имя хоста, используемое для конфигурации SPF. |\n| SPFTextValue | string | Значение, которое можно опционально настроить у вашего DNS-хостинга. |\n| DKIMVerified | boolean | Указывает, правильно ли настроена DKIM DNS TXT-запись у вашего регистратора доменов или DNS-хостинга. |\n| DKIMHost | string | DNS TXT-хост, используемый для валидации отправляемых сообщений. |\n| DKIMTextValue | string | Значение DNS TXT, используемое для валидации отправляемых сообщений. |\n| DKIMPendingHost | string | Если было инициировано обновление DKIM или это DKIM от новой подписи отправителя, это поле покажет ожидающий подтверждения DNS TXT-хост, который еще предстоит настроить и подтвердить у вашего регистратора или DNS-хостинга. |\n| DKIMPendingTextValue | string | Аналогично полю DKIMPendingHost, это поле покажет значение DNS TXT, ожидающее подтверждения у вашего регистратора или DNS-хостинга. |\n| DKIMRevokedHost | string | Как только новый DKIM будет подтвержден у вашего регистратора или DNS-хостинга, Haskimail отзовет старый DKIM-хост в рамках подготовки к его окончательному удалению из системы. |\n| DKIMRevokedTextValue | string | Аналогично DKIMRevokedHost, это поле покажет значение DNS TXT, которое скоро будет удалено из системы Haskimail.. |\n| SafeToRemoveRevokedKeyFromDNS | boolean | Указывает, можете ли вы безопасно удалить старые DKIM DNS TXT-записи у вашего регистратора или DNS-хостинга. Новый DKIM теперь безопасно используется. |\n| DKIMUpdateStatus | string | Пока выполняются или настраиваются операции по обновлению или созданию нового DKIM, это поле будет иметь значение Pending. После того как все DNS TXT-записи будут обновлены и любые ожидающие операции обновления завершены, оно изменится на `Verified`. |\n| ReturnPathDomain | string | Пользовательский домен Return-Path для этой подписи. Для получения дополнительной информации об этом поле, пожалуйста, ознакомьтесь с нашей статьей.. |\n| ReturnPathDomainVerified | boolean | Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования. |\n| ReturnPathDomainCNAMEValue | string | CNAME DNS-запись, которую Haskimail ожидает найти по адресу, указанному в ReturnPathDomain. |\n| ID | integer | Уникальный ID подписи отправителя. |\n\n[Метод в документации](https://haskimail.ru/developer/signatures-api/#verify-spf)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/senders/:signatureid/verifyspf",
"host": [
"{{base_url}}"
],
"path": [
"senders",
":signatureid",
"verifyspf"
],
"variable": [
{
"key": "signatureid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "Запрашивает DNS вашего домена и пытается проверить, содержит ли SPF-запись информацию о серверах Haskimail.\n\n**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\nПоле `SPFVerified` SPFVerified в ответе укажет, была ли проверка SPF успешной.\n\n| Domain | string | Домен, связанный с подписью отправителя. |\n| --- | --- | --- |\n| EmailAddress | string | Email-адрес, связанный с подписью отправителя. |\n| ReplyToEmailAddress | string | Email-адрес для ответа, связанный с подписью отправителя. |\n| Name | string | Имя отправителя в подписи. |\n| Confirmed | boolean | Указывает, подтверждена ли эта подпись отправителя. |\n| SPFVerified | boolean | Указывает, правильно ли настроена SPF DNS TXT-запись у вашего регистратора доменов или DNS-хостинга. |\n| SPFHost | string | Имя хоста, используемое для конфигурации SPF. |\n| SPFTextValue | string | Значение, которое можно опционально настроить у вашего DNS-хостинга. |\n| DKIMVerified | boolean | Указывает, правильно ли настроена DKIM DNS TXT-запись у вашего регистратора доменов или DNS-хостинга. |\n| DKIMHost | string | DNS TXT-хост, используемый для валидации отправляемых сообщений. |\n| DKIMTextValue | string | Значение DNS TXT, используемое для валидации отправляемых сообщений. |\n| DKIMPendingHost | string | Если было инициировано обновление DKIM или это DKIM от новой подписи отправителя, это поле покажет ожидающий подтверждения DNS TXT-хост, который еще предстоит настроить и подтвердить у вашего регистратора или DNS-хостинга. |\n| DKIMPendingTextValue | string | Аналогично полю DKIMPendingHost, это поле покажет значение DNS TXT, ожидающее подтверждения у вашего регистратора или DNS-хостинга. |\n| DKIMRevokedHost | string | Как только новый DKIM будет подтвержден у вашего регистратора или DNS-хостинга, Haskimail отзовет старый DKIM-хост в рамках подготовки к его окончательному удалению из системы. |\n| DKIMRevokedTextValue | string | Аналогично DKIMRevokedHost, это поле покажет значение DNS TXT, которое скоро будет удалено из системы Haskimail.. |\n| SafeToRemoveRevokedKeyFromDNS | boolean | Указывает, можете ли вы безопасно удалить старые DKIM DNS TXT-записи у вашего регистратора или DNS-хостинга. Новый DKIM теперь безопасно используется. |\n| DKIMUpdateStatus | string | Пока выполняются или настраиваются операции по обновлению или созданию нового DKIM, это поле будет иметь значение Pending. После того как все DNS TXT-записи будут обновлены и любые ожидающие операции обновления завершены, оно изменится на `Verified`. |\n| ReturnPathDomain | string | Пользовательский домен Return-Path для этой подписи. Для получения дополнительной информации об этом поле, пожалуйста, ознакомьтесь с нашей статьей.. |\n| ReturnPathDomainVerified | boolean | Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования. |\n| ReturnPathDomainCNAMEValue | string | CNAME DNS-запись, которую Haskimail ожидает найти по адресу, указанному в ReturnPathDomain. |\n| ID | integer | Уникальный ID подписи отправителя. |\n\n[Метод в документации](https://haskimail.ru/developer/signatures-api/#verify-spf)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"Domain\": \"example.com\",\n \"EmailAddress\": \"ivan.ivanov@example.com\",\n \"ReplyToEmailAddress\": \"\",\n \"Name\": \"Иван Иванов\",\n \"Confirmed\": false,\n \"SPFVerified\": false,\n \"SPFHost\": \"example.com\",\n \"SPFTextValue\": \"v=spf1 a mx include:spf.mtasv.net ~all\",\n \"DKIMVerified\": false,\n \"DKIMHost\": \"\",\n \"DKIMTextValue\": \"\",\n \"DKIMPendingHost\": \"20140220130148.pm._domainkey.example.com\",\n \"DKIMPendingTextValue\": \"k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCQ35xZciGB0gMm3876S...\",\n \"DKIMRevokedHost\": \"\",\n \"DKIMRevokedTextValue\": \"\",\n \"SafeToRemoveRevokedKeyFromDNS\": false,\n \"DKIMUpdateStatus\": \"Pending\",\n \"ReturnPathDomain\": \"pm-bounces.example.com\",\n \"ReturnPathDomainVerified\": true,\n \"ReturnPathDomainCNAMEValue\": \"pm.mtasv.net\",\n \"ID\": 110396\n}"
}
]
},
{
"name": "Запрос нового DKIM-ключа",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/senders/:signatureid/requestnewdkim",
"host": [
"{{base_url}}"
],
"path": [
"senders",
":signatureid",
"requestnewdkim"
],
"variable": [
{
"key": "signatureid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "Создает новый DKIM-ключ. До тех пор, пока DNS-записи не будут подтверждены, новые значения будут находиться в полях DKIMPendingHost и DKIMPendingTextValue. После того как новое значение DKIM будет проверено в DNS, ожидающие значения переместятся в поля DKIMHost и DKIMTextValue, и Haskimail начнет подписывать письма новым DKIM-ключом.\n\n**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\n| ErrorCode | integer | [Коды ошибок API](/developer/api/overview#error-codes) |\n| --- | --- | --- |\n| Message | string | Ответ с результатом |\n\n[Метод в документации](https://haskimail.ru/developer/signatures-api/#request-dkim)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Account-Token",
"value": "{{account_token}}"
}
],
"url": {
"raw": "{{base_url}}/senders/:signatureid/requestnewdkim",
"host": [
"{{base_url}}"
],
"path": [
"senders",
":signatureid",
"requestnewdkim"
],
"variable": [
{
"key": "signatureid",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "Создает новый DKIM-ключ. До тех пор, пока DNS-записи не будут подтверждены, новые значения будут находиться в полях DKIMPendingHost и DKIMPendingTextValue. После того как новое значение DKIM будет проверено в DNS, ожидающие значения переместятся в поля DKIMHost и DKIMTextValue, и Haskimail начнет подписывать письма новым DKIM-ключом.\n\n**Заголовки запроса**\n\n| Content-Type | обязательный application/json |\n| --- | --- |\n| Accept | обязательный application/json |\n| X-Haskimail-Account-Token | обязательный Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail. |\n\n**Ответ**\n\n| ErrorCode | integer | [Коды ошибок API](/developer/api/overview#error-codes) |\n| --- | --- | --- |\n| Message | string | Ответ с результатом |\n\n[Метод в документации](https://haskimail.ru/developer/signatures-api/#request-dkim)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"ErrorCode\": 505,\n \"Message\": \"This DKIM is already being renewed.\"\n}"
}
]
}
]
},
{
"name": "API Статистики",
"description": "Позволяет получить всю статистику по вашим исходящим письмам для конкретного сервера. Эта статистика хранится постоянно и не имеет срока действия. Все статистические данные используют часовой пояс МСК (GMT+3). Если даты from/to не указаны, возвращается статистика за все время.",
"item": [
{
"name": "Обзор статистики по исходящим письмам",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/stats?fromdate=2014-01-01&todate=2014-02-01",
"host": [
"{{base_url}}"
],
"path": [
"stats"
],
"query": [
{
"key": "fromdate",
"value": "2014-01-01",
"description": ""
},
{
"key": "todate",
"value": "2014-02-01",
"description": ""
}
]
},
"description": "Получает краткий обзор статистики по всем вашим исходящим письмам.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры запроса**\n\n| tag | Фильтровать по тегу. |\n| --- | --- |\n| fromdate | Фильтровать статистику, начиная с указанной даты (включительно). Например, 2014-01-01. |\n| todate | Фильтровать статистику до указанной даты (включительно). Например, 2014-02-01. |\n| messagestream | Фильтровать по каналу. Если не указан, ответ будет содержать статистику по всем каналам на сервере. |\n\n**Ответ**\n\n| Sent | integer | Количество отправленных писем. |\n| --- | --- | --- |\n| Bounced | integer | Количество возвратов. |\n| BounceRate | double | Уровень возвратов в процентах, рассчитанный от общего числа отправленных. |\n| SpamComplaints | integer | Количество жалоб на спам. |\n| SpamComplaintsRate | double | Уровень жалоб на спам в процентах, рассчитанный от общего числа отправленных. |\n| Opened | integer | Количество открытий. |\n| OpenRate | double | Уровень открытий в процентах, рассчитанный от общего числа отправленных. |\n| Clicked | integer | Общее количество кликов по всем отслеживаемым ссылкам. |\n| ClickRate | double | Уровень кликов в процентах, рассчитанный от общего числа отправленных. |\n\n[Метод в документации](https://haskimail.ru/developer/stats-api/#overview)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/stats?fromdate=2014-01-01&todate=2014-02-01",
"host": [
"{{base_url}}"
],
"path": [
"stats"
],
"query": [
{
"key": "fromdate",
"value": "2014-01-01",
"description": ""
},
{
"key": "todate",
"value": "2014-02-01",
"description": ""
}
]
},
"description": "Получает краткий обзор статистики по всем вашим исходящим письмам.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры запроса**\n\n| tag | Фильтровать по тегу. |\n| --- | --- |\n| fromdate | Фильтровать статистику, начиная с указанной даты (включительно). Например, 2014-01-01. |\n| todate | Фильтровать статистику до указанной даты (включительно). Например, 2014-02-01. |\n| messagestream | Фильтровать по каналу. Если не указан, ответ будет содержать статистику по всем каналам на сервере. |\n\n**Ответ**\n\n| Sent | integer | Количество отправленных писем. |\n| --- | --- | --- |\n| Bounced | integer | Количество возвратов. |\n| BounceRate | double | Уровень возвратов в процентах, рассчитанный от общего числа отправленных. |\n| SpamComplaints | integer | Количество жалоб на спам. |\n| SpamComplaintsRate | double | Уровень жалоб на спам в процентах, рассчитанный от общего числа отправленных. |\n| Opened | integer | Количество открытий. |\n| OpenRate | double | Уровень открытий в процентах, рассчитанный от общего числа отправленных. |\n| Clicked | integer | Общее количество кликов по всем отслеживаемым ссылкам. |\n| ClickRate | double | Уровень кликов в процентах, рассчитанный от общего числа отправленных. |\n\n[Метод в документации](https://haskimail.ru/developer/stats-api/#overview)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"Sent\": 615,\n \"Bounced\": 64,\n \"BounceRate\": 10.4,\n \"SpamComplaints\": 10,\n \"SpamComplaintsRate\": 1.62,\n \"Opened\": 166,\n \"Clicked\": 72,\n \"OpenRate\": 12.5,\n \"ClickRate\": 7.82\n}"
}
]
},
{
"name": "Статистика по отправленным",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/stats/sends?fromdate=2014-01-01&todate=2014-02-01",
"host": [
"{{base_url}}"
],
"path": [
"stats",
"sends"
],
"query": [
{
"key": "fromdate",
"value": "2014-01-01",
"description": ""
},
{
"key": "todate",
"value": "2014-02-01",
"description": ""
}
]
},
"description": "Получает общее количество отправленных вами писем.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти на вкладке «Учетные данные» вашего сервера Haskimail. |\n\n**Параметры запроса**\n\n| tag | Фильтровать по тегу. |\n| --- | --- |\n| fromdate | Фильтровать статистику, начиная с указанной даты (включительно). Например, 2014-01-01. |\n| todate | Фильтровать статистику до указанной даты (включительно). Например, 2014-02-01. |\n| messagestream | Фильтровать по каналу. Если не указан, ответ будет содержать статистику по всем каналам на сервере. |\n\n**Ответ**\n\nДни, за которые нет статистики, не будут отображаться в JSON-ответе.\n\n| Days | array | Список объектов, каждый из которых представляет количество отправленных писем по дате. |\n| --- | --- | --- |\n| Sent | integer | Количество отправленных писем. |\n\n[Метод в документации](https://haskimail.ru/developer/stats-api/#sent-counts)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/stats/sends?fromdate=2014-01-01&todate=2014-02-01",
"host": [
"{{base_url}}"
],
"path": [
"stats",
"sends"
],
"query": [
{
"key": "fromdate",
"value": "2014-01-01",
"description": ""
},
{
"key": "todate",
"value": "2014-02-01",
"description": ""
}
]
},
"description": "Получает общее количество отправленных вами писем.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти на вкладке «Учетные данные» вашего сервера Haskimail. |\n\n**Параметры запроса**\n\n| tag | Фильтровать по тегу. |\n| --- | --- |\n| fromdate | Фильтровать статистику, начиная с указанной даты (включительно). Например, 2014-01-01. |\n| todate | Фильтровать статистику до указанной даты (включительно). Например, 2014-02-01. |\n| messagestream | Фильтровать по каналу. Если не указан, ответ будет содержать статистику по всем каналам на сервере. |\n\n**Ответ**\n\nДни, за которые нет статистики, не будут отображаться в JSON-ответе.\n\n| Days | array | Список объектов, каждый из которых представляет количество отправленных писем по дате. |\n| --- | --- | --- |\n| Sent | integer | Количество отправленных писем. |\n\n[Метод в документации](https://haskimail.ru/developer/stats-api/#sent-counts)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"Days\": [\n {\n \"Date\": \"2014-01-01\",\n \"Sent\": 140\n },\n {\n \"Date\": \"2014-01-02\",\n \"Sent\": 160\n },\n {\n \"Date\": \"2014-01-04\",\n \"Sent\": 50\n },\n {\n \"Date\": \"2014-01-05\",\n \"Sent\": 115\n }\n ]\n}"
}
]
},
{
"name": "Статистика по возвратам",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/stats/bounces?fromdate=2014-01-01&todate=2014-02-01",
"host": [
"{{base_url}}"
],
"path": [
"stats",
"bounces"
],
"query": [
{
"key": "fromdate",
"value": "2014-01-01",
"description": ""
},
{
"key": "todate",
"value": "2014-02-01",
"description": ""
}
]
},
"description": "Получает общее количество отправленных вами писем, которые были возвращены.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти на вкладке «Учетные данные» вашего сервера Haskimail. |\n\n**Параметры запроса**\n\n| tag | Фильтровать по тегу. |\n| --- | --- |\n| fromdate | Фильтровать статистику, начиная с указанной даты (включительно). Например, 2014-01-01. |\n| todate | Фильтровать статистику до указанной даты (включительно). Например, 2014-02-01. |\n| messagestream | Фильтровать по каналу. Если не указан, ответ будет содержать статистику по всем каналам на сервере. |\n\n**Ответ**\n\nДни, за которые нет статистики, не будут отображаться в JSON-ответе.\n\n| Days | array | Список объектов, каждый из которых представляет количество возвратов по дате. |\n| --- | --- | --- |\n| HardBounce | integer | Указывает общее количество жестких возвратов. |\n| SoftBounce | integer | Указывает общее количество мягких возвратов. |\n\n[Метод в документации](https://haskimail.ru/developer/stats-api/#bounce-counts)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/stats/bounces?fromdate=2014-01-01&todate=2014-02-01",
"host": [
"{{base_url}}"
],
"path": [
"stats",
"bounces"
],
"query": [
{
"key": "fromdate",
"value": "2014-01-01",
"description": ""
},
{
"key": "todate",
"value": "2014-02-01",
"description": ""
}
]
},
"description": "Получает общее количество отправленных вами писем, которые были возвращены.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти на вкладке «Учетные данные» вашего сервера Haskimail. |\n\n**Параметры запроса**\n\n| tag | Фильтровать по тегу. |\n| --- | --- |\n| fromdate | Фильтровать статистику, начиная с указанной даты (включительно). Например, 2014-01-01. |\n| todate | Фильтровать статистику до указанной даты (включительно). Например, 2014-02-01. |\n| messagestream | Фильтровать по каналу. Если не указан, ответ будет содержать статистику по всем каналам на сервере. |\n\n**Ответ**\n\nДни, за которые нет статистики, не будут отображаться в JSON-ответе.\n\n| Days | array | Список объектов, каждый из которых представляет количество возвратов по дате. |\n| --- | --- | --- |\n| HardBounce | integer | Указывает общее количество жестких возвратов. |\n| SoftBounce | integer | Указывает общее количество мягких возвратов. |\n\n[Метод в документации](https://haskimail.ru/developer/stats-api/#bounce-counts)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"Days\": [\n {\n \"Date\": \"2014-01-01\",\n \"HardBounce\": 12,\n \"SoftBounce\": 36\n },\n {\n \"Date\": \"2014-01-03\",\n \"HardBounce\": 7\n },\n {\n \"Date\": \"2014-01-04\",\n \"HardBounce\": 4\n },\n {\n \"Date\": \"2014-01-05\",\n \"HardBounce\": 25,\n \"SoftBounce\": 5\n }\n ]\n}"
}
]
},
{
"name": "Статистика по жалобам на спам",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/stats/spam?fromdate=2014-01-01&todate=2014-02-01",
"host": [
"{{base_url}}"
],
"path": [
"stats",
"spam"
],
"query": [
{
"key": "fromdate",
"value": "2014-01-01",
"description": ""
},
{
"key": "todate",
"value": "2014-02-01",
"description": ""
}
]
},
"description": "Получает общее количество получателей, которые отметили ваше письмо как спам.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти на вкладке «Учетные данные» вашего сервера Haskimail. |\n\n**Параметры запроса**\n\n| tag | Фильтровать по тегу. |\n| --- | --- |\n| fromdate | Фильтровать статистику, начиная с указанной даты (включительно). Например, 2014-01-01. |\n| todate | Фильтровать статистику до указанной даты (включительно). Например, 2014-02-01. |\n| messagestream | Фильтровать по каналу. Если не указан, ответ будет содержать статистику по всем каналам на сервере. |\n\n**Ответ**\n\nДни, за которые нет статистики, не будут отображаться в JSON-ответе.\n\n| Days | array | Список объектов, каждый из которых представляет количество жалоб на спам по дате. |\n| --- | --- | --- |\n| SpamComplaint | integer | Количество жалоб на спам. |\n\n[Метод в документации](https://haskimail.ru/developer/stats-api/#spam-complaints)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/stats/spam?fromdate=2014-01-01&todate=2014-02-01",
"host": [
"{{base_url}}"
],
"path": [
"stats",
"spam"
],
"query": [
{
"key": "fromdate",
"value": "2014-01-01",
"description": ""
},
{
"key": "todate",
"value": "2014-02-01",
"description": ""
}
]
},
"description": "Получает общее количество получателей, которые отметили ваше письмо как спам.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти на вкладке «Учетные данные» вашего сервера Haskimail. |\n\n**Параметры запроса**\n\n| tag | Фильтровать по тегу. |\n| --- | --- |\n| fromdate | Фильтровать статистику, начиная с указанной даты (включительно). Например, 2014-01-01. |\n| todate | Фильтровать статистику до указанной даты (включительно). Например, 2014-02-01. |\n| messagestream | Фильтровать по каналу. Если не указан, ответ будет содержать статистику по всем каналам на сервере. |\n\n**Ответ**\n\nДни, за которые нет статистики, не будут отображаться в JSON-ответе.\n\n| Days | array | Список объектов, каждый из которых представляет количество жалоб на спам по дате. |\n| --- | --- | --- |\n| SpamComplaint | integer | Количество жалоб на спам. |\n\n[Метод в документации](https://haskimail.ru/developer/stats-api/#spam-complaints)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"Days\": [\n {\n \"Date\": \"2014-01-01\",\n \"SpamComplaint\": 2\n },\n {\n \"Date\": \"2014-01-02\",\n \"SpamComplaint\": 3\n },\n {\n \"Date\": \"2014-01-05\",\n \"SpamComplaint\": 5\n }\n ]\n}"
}
]
},
{
"name": "Статистика по открытиям",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/stats/opens?fromdate=2014-01-01&todate=2014-02-01",
"host": [
"{{base_url}}"
],
"path": [
"stats",
"opens"
],
"query": [
{
"key": "fromdate",
"value": "2014-01-01",
"description": ""
},
{
"key": "todate",
"value": "2014-02-01",
"description": ""
}
]
},
"description": "Получает общее количество получателей, которые открыли ваши письма. Эта информация записывается, только если для письма включено отслеживание открытий.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти на вкладке «Учетные данные» вашего сервера Haskimail. |\n\n**Параметры запроса**\n\n| tag | Фильтровать по тегу. |\n| --- | --- |\n| fromdate | Фильтровать статистику, начиная с указанной даты (включительно). Например, 2014-01-01. |\n| todate | Фильтровать статистику до указанной даты (включительно). Например, 2014-02-01. |\n| messagestream | Фильтровать по каналу. Если не указан, ответ будет содержать статистику по всем каналам на сервере. |\n\n**Ответ**\n\nДни, за которые нет статистики, не будут отображаться в JSON-ответе.\n\n| Days | array | Список объектов, каждый из которых представляет количество отслеживаемых писем по дате. |\n| --- | --- | --- |\n| Opens | integer | Указывает общее количество открытых писем. Это число включает получателей, которые открывали ваше письмо несколько раз. |\n\n[Метод в документации](https://haskimail.ru/developer/stats-api/#email-open-counts)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/stats/opens?fromdate=2014-01-01&todate=2014-02-01",
"host": [
"{{base_url}}"
],
"path": [
"stats",
"opens"
],
"query": [
{
"key": "fromdate",
"value": "2014-01-01",
"description": ""
},
{
"key": "todate",
"value": "2014-02-01",
"description": ""
}
]
},
"description": "Получает общее количество получателей, которые открыли ваши письма. Эта информация записывается, только если для письма включено отслеживание открытий.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти на вкладке «Учетные данные» вашего сервера Haskimail. |\n\n**Параметры запроса**\n\n| tag | Фильтровать по тегу. |\n| --- | --- |\n| fromdate | Фильтровать статистику, начиная с указанной даты (включительно). Например, 2014-01-01. |\n| todate | Фильтровать статистику до указанной даты (включительно). Например, 2014-02-01. |\n| messagestream | Фильтровать по каналу. Если не указан, ответ будет содержать статистику по всем каналам на сервере. |\n\n**Ответ**\n\nДни, за которые нет статистики, не будут отображаться в JSON-ответе.\n\n| Days | array | Список объектов, каждый из которых представляет количество отслеживаемых писем по дате. |\n| --- | --- | --- |\n| Opens | integer | Указывает общее количество открытых писем. Это число включает получателей, которые открывали ваше письмо несколько раз. |\n\n[Метод в документации](https://haskimail.ru/developer/stats-api/#email-open-counts)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"Days\": [\n {\n \"Date\": \"2014-01-01\",\n \"Opens\": 44\n },\n {\n \"Date\": \"2014-01-02\",\n \"Opens\": 46\n },\n {\n \"Date\": \"2014-01-03\",\n \"Opens\": 25\n },\n {\n \"Date\": \"2014-01-04\",\n \"Opens\": 25\n },\n {\n \"Date\": \"2014-01-05\",\n \"Opens\": 26\n }\n ]\n}"
}
]
},
{
"name": "Статистика по кликам",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/stats/clicks?fromdate=2014-01-01&todate=2014-02-01",
"host": [
"{{base_url}}"
],
"path": [
"stats",
"clicks"
],
"query": [
{
"key": "fromdate",
"value": "2014-01-01",
"description": ""
},
{
"key": "todate",
"value": "2014-02-01",
"description": ""
}
]
},
"description": "Получает общее количество уникальных ссылок, по которым были совершены переходы.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти на вкладке «Учетные данные» вашего сервера Haskimail. |\n\n**Параметры запроса**\n\n| tag | Фильтровать по тегу. |\n| --- | --- |\n| fromdate | Фильтровать статистику, начиная с указанной даты (включительно). Например, 2014-01-01. |\n| todate | Фильтровать статистику до указанной даты (включительно). Например, 2014-02-01. |\n| messagestream | Фильтровать по каналу. Если не указан, ответ будет содержать статистику по всем каналам на сервере. |\n\n**Ответ**\n\nДни, за которые нет статистики, не будут отображаться в JSON-ответе.\n\n| Days | array | Список объектов, каждый из которых представляет количество кликов по дате. |\n| --- | --- | --- |\n| Clicks | integer | Указывает общее количество кликов по ссылкам. Это число включает получателей, которые кликали по ссылкам в вашем письме несколько раз. |\n\n[Метод в документации](https://haskimail.ru/developer/stats-api/#click-counts)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/stats/clicks?fromdate=2014-01-01&todate=2014-02-01",
"host": [
"{{base_url}}"
],
"path": [
"stats",
"clicks"
],
"query": [
{
"key": "fromdate",
"value": "2014-01-01",
"description": ""
},
{
"key": "todate",
"value": "2014-02-01",
"description": ""
}
]
},
"description": "Получает общее количество уникальных ссылок, по которым были совершены переходы.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти на вкладке «Учетные данные» вашего сервера Haskimail. |\n\n**Параметры запроса**\n\n| tag | Фильтровать по тегу. |\n| --- | --- |\n| fromdate | Фильтровать статистику, начиная с указанной даты (включительно). Например, 2014-01-01. |\n| todate | Фильтровать статистику до указанной даты (включительно). Например, 2014-02-01. |\n| messagestream | Фильтровать по каналу. Если не указан, ответ будет содержать статистику по всем каналам на сервере. |\n\n**Ответ**\n\nДни, за которые нет статистики, не будут отображаться в JSON-ответе.\n\n| Days | array | Список объектов, каждый из которых представляет количество кликов по дате. |\n| --- | --- | --- |\n| Clicks | integer | Указывает общее количество кликов по ссылкам. Это число включает получателей, которые кликали по ссылкам в вашем письме несколько раз. |\n\n[Метод в документации](https://haskimail.ru/developer/stats-api/#click-counts)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"Days\": [\n {\n \"Date\": \"2014-01-01\",\n \"Clicks\": 44\n },\n {\n \"Date\": \"2014-01-02\",\n \"Clicks\": 46\n },\n {\n \"Date\": \"2014-01-03\",\n \"Clicks\": 25\n },\n {\n \"Date\": \"2014-01-04\",\n \"Clicks\": 25\n },\n {\n \"Date\": \"2014-01-05\",\n \"Clicks\": 26\n }\n ]\n}"
}
]
}
]
},
{
"name": "API Стоп-списков",
"description": "Этот раздел API позволяет вам управлять (просматривать, создавать и удалять) стоп-списками в вашем канале. Если адрес находится в стоп-списке, это означает, что отправка писем на него временно приостановлена. Удаление исключения, созданного из-за жесткого возврата (HardBounce), равносильно повторной активации этого email-адреса.",
"item": [
{
"name": "Дамп стоп-списка",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/message-streams/:stream_id/suppressions/dump?origin=recipient&fromdate=2019-12-01",
"host": [
"{{base_url}}"
],
"path": [
"message-streams",
":stream_id",
"suppressions",
"dump"
],
"query": [
{
"key": "origin",
"value": "recipient",
"description": ""
},
{
"key": "fromdate",
"value": "2019-12-01",
"description": ""
}
],
"variable": [
{
"key": "stream_id",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры запроса**\n\n| SuppressionReason | Фильтр по причине исключения. Возможные значения:`HardBounce`, `SpamComplaint`, `ManualSuppression`. |\n| --- | --- |\n| Origin | Фильтр по источнику добавления адреса в список исключений. Возможные значения: `Recipient`, `Customer`, `Admin`. |\n| todate | Фильтровать исключения по указанную дату (включительно). Например: 2020-02-01. |\n| fromdate | Фильтровать исключения, начиная с указанной даты (включительно). Например: 2020-02-01. |\n| EmailAddress | Фильтр по email-адресу. |\n\n**Ответ**\n\n[Метод в документации](https://haskimail.ru/developer/suppressions-api/#suppression-dump)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/message-streams/:stream_id/suppressions/dump?origin=recipient&fromdate=2019-12-01",
"host": [
"{{base_url}}"
],
"path": [
"message-streams",
":stream_id",
"suppressions",
"dump"
],
"query": [
{
"key": "origin",
"value": "recipient",
"description": ""
},
{
"key": "fromdate",
"value": "2019-12-01",
"description": ""
}
],
"variable": [
{
"key": "stream_id",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры запроса**\n\n| SuppressionReason | Фильтр по причине исключения. Возможные значения:`HardBounce`, `SpamComplaint`, `ManualSuppression`. |\n| --- | --- |\n| Origin | Фильтр по источнику добавления адреса в список исключений. Возможные значения: `Recipient`, `Customer`, `Admin`. |\n| todate | Фильтровать исключения по указанную дату (включительно). Например: 2020-02-01. |\n| fromdate | Фильтровать исключения, начиная с указанной даты (включительно). Например: 2020-02-01. |\n| EmailAddress | Фильтр по email-адресу. |\n\n**Ответ**\n\n[Метод в документации](https://haskimail.ru/developer/suppressions-api/#suppression-dump)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"Suppressions\": [\n {\n \"EmailAddress\": \"address@wildbit.com\",\n \"SuppressionReason\": \"ManualSuppression\",\n \"Origin\": \"Recipient\",\n \"CreatedAt\": \"2019-12-17T08:58:33-05:00\"\n },\n {\n \"EmailAddress\": \"bounce.address@wildbit.com\",\n \"SuppressionReason\": \"HardBounce\",\n \"Origin\": \"Recipient\",\n \"CreatedAt\": \"2019-12-17T08:58:33-05:00\"\n },\n {\n \"EmailAddress\": \"spam.complaint.address@wildbit.com\",\n \"SuppressionReason\": \"SpamComplaint\",\n \"Origin\": \"Recipient\",\n \"CreatedAt\": \"2019-12-17T08:58:33-05:00\"\n }\n ]\n}"
}
]
},
{
"name": "Добавить в стоп-лист",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/message-streams/:stream_id/suppressions",
"host": [
"{{base_url}}"
],
"path": [
"message-streams",
":stream_id",
"suppressions"
],
"variable": [
{
"key": "stream_id",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n| Suppressions | array | обязательный Массив, содержащий email-адреса, для которых нужно создать исключения. Максимум 50 исключений могут быть созданы за один вызов. |\n| --- | --- | --- |\n| EmailAddress | string | Email-адрес, для которого запрашивается создание исключения. |\n\n**Ответ**\n\n| Suppressions | array | Список, представляющий исключения, для которых был запрошен процесс создания. |\n| --- | --- | --- |\n| EmailAddress | string | Email-адрес, для которого было запрошено создание исключения. |\n| Status | string | Статус запроса на создание исключения. Возможные значения: `Failed`, `Suppressed`. |\n| Message | string | Если адрес не может быть исключен (статус `Failed`), будет указана причина сбоя. Если исключение создано (статус `Suppressed`), сообщение будет null. |\n\n[Метод в документации](https://haskimail.ru/developer/suppressions-api/#create-a-suppression)",
"body": {
"mode": "raw",
"raw": "{\n \"Suppressions\": [\n {\n \"EmailAddress\": \"good.address@wildbit.com\"\n },\n {\n \"EmailAddress\": \"spammy.address@wildbit.com\"\n },\n {\n \"EmailAddress\": \"invalid-email-address\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/message-streams/:stream_id/suppressions",
"host": [
"{{base_url}}"
],
"path": [
"message-streams",
":stream_id",
"suppressions"
],
"variable": [
{
"key": "stream_id",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n| Suppressions | array | обязательный Массив, содержащий email-адреса, для которых нужно создать исключения. Максимум 50 исключений могут быть созданы за один вызов. |\n| --- | --- | --- |\n| EmailAddress | string | Email-адрес, для которого запрашивается создание исключения. |\n\n**Ответ**\n\n| Suppressions | array | Список, представляющий исключения, для которых был запрошен процесс создания. |\n| --- | --- | --- |\n| EmailAddress | string | Email-адрес, для которого было запрошено создание исключения. |\n| Status | string | Статус запроса на создание исключения. Возможные значения: `Failed`, `Suppressed`. |\n| Message | string | Если адрес не может быть исключен (статус `Failed`), будет указана причина сбоя. Если исключение создано (статус `Suppressed`), сообщение будет null. |\n\n[Метод в документации](https://haskimail.ru/developer/suppressions-api/#create-a-suppression)",
"body": {
"mode": "raw",
"raw": "{\n \"Suppressions\": [\n {\n \"EmailAddress\": \"good.address@wildbit.com\"\n },\n {\n \"EmailAddress\": \"spammy.address@wildbit.com\"\n },\n {\n \"EmailAddress\": \"invalid-email-address\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"Suppressions\": [\n {\n \"EmailAddress\": \"good.address@wildbit.com\",\n \"Status\": \"Suppressed\",\n \"Message\": null\n },\n {\n \"EmailAddress\": \"spammy.address@wildbit.com\",\n \"Status\": \"Failed\",\n \"Message\": \"You do not have the обязательный authority to change this suppression.\"\n },\n {\n \"EmailAddress\": \"invalid-email-address\",\n \"Status\": \"Failed\",\n \"Message\": \"An invalid email address was provided.\"\n }\n ]\n}"
}
]
},
{
"name": "Удаление исключений",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/message-streams/:stream_id/suppressions/delete",
"host": [
"{{base_url}}"
],
"path": [
"message-streams",
":stream_id",
"suppressions",
"delete"
],
"variable": [
{
"key": "stream_id",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "Исключения, созданные по причине жалоб на спам (`SpamComplaint`), не могут быть удалены.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n| Suppressions | array | обязательный Массив email-адресов, для которых нужно удалить исключения. Максимум 50 исключений могут быть удалены за один вызов. |\n| --- | --- | --- |\n| EmailAddress | string | Email-адрес, для которого запрашивается удаление исключения. |\n\n**Ответ**\n\n| Suppressions | array | Список, представляющий исключения, для которых был запрошен процесс удаления. |\n| --- | --- | --- |\n| EmailAddress | string | Email-адрес, для которого было запрошено удаление исключения. |\n| Status | string | Статус запроса на удаление исключения. Возможные значения: `Failed`, `Deleted`. |\n| Message | string | Если адрес не может быть удален (статус `Failed`), будет указана причина сбоя. Если удаление исключения прошло успешно (статус `Deleted`), сообщение будет null. |\n\n[Метод в документации](https://haskimail.ru/developer/suppressions-api/#delete-a-suppression)",
"body": {
"mode": "raw",
"raw": "{\n \"Suppressions\": [\n {\n \"EmailAddress\": \"bounced.address@wildbit.com\"\n },\n {\n \"EmailAddress\": \"not.suppressed@wildbit.com\"\n },\n {\n \"EmailAddress\": \"spammy.address@wildbit.com\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/message-streams/:stream_id/suppressions/delete",
"host": [
"{{base_url}}"
],
"path": [
"message-streams",
":stream_id",
"suppressions",
"delete"
],
"variable": [
{
"key": "stream_id",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "Исключения, созданные по причине жалоб на спам (`SpamComplaint`), не могут быть удалены.\n\n**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n| Suppressions | array | обязательный Массив email-адресов, для которых нужно удалить исключения. Максимум 50 исключений могут быть удалены за один вызов. |\n| --- | --- | --- |\n| EmailAddress | string | Email-адрес, для которого запрашивается удаление исключения. |\n\n**Ответ**\n\n| Suppressions | array | Список, представляющий исключения, для которых был запрошен процесс удаления. |\n| --- | --- | --- |\n| EmailAddress | string | Email-адрес, для которого было запрошено удаление исключения. |\n| Status | string | Статус запроса на удаление исключения. Возможные значения: `Failed`, `Deleted`. |\n| Message | string | Если адрес не может быть удален (статус `Failed`), будет указана причина сбоя. Если удаление исключения прошло успешно (статус `Deleted`), сообщение будет null. |\n\n[Метод в документации](https://haskimail.ru/developer/suppressions-api/#delete-a-suppression)",
"body": {
"mode": "raw",
"raw": "{\n \"Suppressions\": [\n {\n \"EmailAddress\": \"bounced.address@wildbit.com\"\n },\n {\n \"EmailAddress\": \"not.suppressed@wildbit.com\"\n },\n {\n \"EmailAddress\": \"spammy.address@wildbit.com\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"Suppressions\": [\n {\n \"EmailAddress\": \"good.address@wildbit.com\",\n \"Status\": \"Deleted\",\n \"Message\": null\n },\n {\n \"EmailAddress\": \"not.suppressed@wildbit.com\",\n \"Status\": \"Deleted\",\n \"Message\": null\n },\n {\n \"EmailAddress\": \"spammy.address@wildbit.com\",\n \"Status\": \"Failed\",\n \"Message\": \"You do not have the обязательный authority to change this suppression.\"\n }\n ]\n}"
}
]
}
]
},
{
"name": "API Вебхуков",
"description": "Позволяет управлять вебхуками для определенного транзакционного или массового канала.",
"item": [
{
"name": "Список вебхуков",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/webhooks?MessageStream=outbound",
"host": [
"{{base_url}}"
],
"path": [
"webhooks"
],
"query": [
{
"key": "MessageStream",
"value": "outbound",
"description": ""
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры запроса**\n\n**Ответ**\n\n[Метод в документации](https://haskimail.ru/developer/webhooks-api/#list-webhooks)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/webhooks?MessageStream=outbound",
"host": [
"{{base_url}}"
],
"path": [
"webhooks"
],
"query": [
{
"key": "MessageStream",
"value": "outbound",
"description": ""
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Параметры запроса**\n\n**Ответ**\n\n[Метод в документации](https://haskimail.ru/developer/webhooks-api/#list-webhooks)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"Webhooks\": [\n {\n \"ID\": 1234567,\n \"Url\": \"http://www.example.com/webhook-test-tracking\",\n \"MessageStream\": 1,\n \"Triggers\": {\n \"Open\": {\n \"Enabled\": true\n },\n \"Click\": {\n \"Enabled\": true\n },\n \"Delivery\": {\n \"Enabled\": true\n },\n \"Bounce\": {\n \"Enabled\": false\n },\n \"SpamComplaint\": {\n \"Enabled\": false\n }\n }\n },\n {\n \"ID\": 1234568,\n \"Url\": \"http://www.example.com/webhook-test-bounce\",\n \"MessageStream\": 2,\n \"Triggers\": {\n \"Open\": {\n \"Enabled\": false\n },\n \"Click\": {\n \"Enabled\": false\n },\n \"Delivery\": {\n \"Enabled\": false\n },\n \"Bounce\": {\n \"Enabled\": true\n },\n \"SpamComplaint\": {\n \"Enabled\": false\n }\n }\n }\n ]\n}"
}
]
},
{
"name": "Получение вебхука",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/webhooks/:Id",
"host": [
"{{base_url}}"
],
"path": [
"webhooks",
":Id"
],
"variable": [
{
"key": "Id",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ID | integer | ID вебхука. |\n| --- | --- | --- |\n| Url | string | URL вашего вебхука. |\n| MessageStream | integer | Канал, с которым связан этот вебхук. |\n| Triggers | object | Список различных триггеров, для которых вебхук может быть включен/отключен. |\n| Open | object | Детали вебхука для открытий. |\n| Enabled | boolean | Указывает, включен ли вебхук для открытий. |\n| Click | object | Детали вебхука для кликов. |\n| Enabled | boolean | Указывает, включен ли вебхук для кликов. |\n| Delivery | object | Детали вебхука для доставок. |\n| Enabled | boolean | Указывает, включен ли вебхук для доставок. |\n| Bounce | object | Детали вебхука для возвратов. |\n| Enabled | boolean | Указывает, включен ли вебхук для возвратов. |\n| SpamComplaint | object | Детали вебхука для жалоб на спам. |\n| Enabled | boolean | Указывает, включен ли вебхук для жалоб на спам. |\n\n[Метод в документации](https://haskimail.ru/developer/webhooks-api/#get-a-webhook)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/webhooks/:Id",
"host": [
"{{base_url}}"
],
"path": [
"webhooks",
":Id"
],
"variable": [
{
"key": "Id",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ID | integer | ID вебхука. |\n| --- | --- | --- |\n| Url | string | URL вашего вебхука. |\n| MessageStream | integer | Канал, с которым связан этот вебхук. |\n| Triggers | object | Список различных триггеров, для которых вебхук может быть включен/отключен. |\n| Open | object | Детали вебхука для открытий. |\n| Enabled | boolean | Указывает, включен ли вебхук для открытий. |\n| Click | object | Детали вебхука для кликов. |\n| Enabled | boolean | Указывает, включен ли вебхук для кликов. |\n| Delivery | object | Детали вебхука для доставок. |\n| Enabled | boolean | Указывает, включен ли вебхук для доставок. |\n| Bounce | object | Детали вебхука для возвратов. |\n| Enabled | boolean | Указывает, включен ли вебхук для возвратов. |\n| SpamComplaint | object | Детали вебхука для жалоб на спам. |\n| Enabled | boolean | Указывает, включен ли вебхук для жалоб на спам. |\n\n[Метод в документации](https://haskimail.ru/developer/webhooks-api/#get-a-webhook)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"ID\": 1234567,\n \"Url\": \"http://www.example.com/webhook-test-tracking\",\n \"MessageStream\": 1,\n \"Triggers\": {\n \"Open\": {\n \"Enabled\": true\n },\n \"Click\": {\n \"Enabled\": true\n },\n \"Delivery\": {\n \"Enabled\": true\n },\n \"Bounce\": {\n \"Enabled\": false\n },\n \"SpamComplaint\": {\n \"Enabled\": false\n }\n }\n}"
}
]
},
{
"name": "Создание вебхука",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/webhooks",
"host": [
"{{base_url}}"
],
"path": [
"webhooks"
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n| Url | string | обязательный URL вашего вебхука. |\n| --- | --- | --- |\n| MessageStream | string | Канал, с которым связан этот вебхук. Если MessageStream не указан, будет использован транзакционный канал по умолчанию. |\n| Triggers | object | Список различных событий вебхуков для включения. |\n| Open | object | Настройки для вебхука открытий. |\n| Click | object | Настройки для вебхука кликов. |\n| Delivery | object | Настройки для вебхука доставок. |\n| Bounce | object | Настройки для вебхука возвратов. |\n| SpamComplaint | object | Настройки для вебхука жалоб на спам. |\n\n**Ответ**\n\n| ID | integer | ID вебхука. |\n| --- | --- | --- |\n| Url | string | URL вашего вебхука. |\n| MessageStream | integer | Канал, с которым связан этот вебхук. |\n| Triggers | object | Список различных триггеров, для которых вебхук может быть включен/отключен. |\n| Open | object | Детали вебхука для открытий. |\n| Enabled | boolean | Указывает, включен ли вебхук для открытий. |\n| Click | object | Детали вебхука для кликов. |\n| Enabled | boolean | Указывает, включен ли вебхук для кликов. |\n| Delivery | object | Детали вебхука для доставок. |\n| Enabled | boolean | Указывает, включен ли вебхук для доставок. |\n| Bounce | object | Детали вебхука для возвратов. |\n| Enabled | boolean | Указывает, включен ли вебхук для возвратов. |\n| SpamComplaint | object | Детали вебхука для жалоб на спам. |\n| Enabled | boolean | Указывает, включен ли вебхук для жалоб на спам. |\n\n[Метод в документации](https://haskimail.ru/developer/webhooks-api/#create-a-webhook)",
"body": {
"mode": "raw",
"raw": "{\n \"Url\": \"http://www.example.com/webhook-test-tracking\",\n \"MessageStream\": \"outbound\",\n \"Triggers\": {\n \"Open\": {\n \"Enabled\": true\n },\n \"Click\": {\n \"Enabled\": true\n },\n \"Delivery\": {\n \"Enabled\": true\n },\n \"Bounce\": {\n \"Enabled\": false\n },\n \"SpamComplaint\": {\n \"Enabled\": false\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/webhooks",
"host": [
"{{base_url}}"
],
"path": [
"webhooks"
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n| Url | string | обязательный URL вашего вебхука. |\n| --- | --- | --- |\n| MessageStream | string | Канал, с которым связан этот вебхук. Если MessageStream не указан, будет использован транзакционный канал по умолчанию. |\n| Triggers | object | Список различных событий вебхуков для включения. |\n| Open | object | Настройки для вебхука открытий. |\n| Click | object | Настройки для вебхука кликов. |\n| Delivery | object | Настройки для вебхука доставок. |\n| Bounce | object | Настройки для вебхука возвратов. |\n| SpamComplaint | object | Настройки для вебхука жалоб на спам. |\n\n**Ответ**\n\n| ID | integer | ID вебхука. |\n| --- | --- | --- |\n| Url | string | URL вашего вебхука. |\n| MessageStream | integer | Канал, с которым связан этот вебхук. |\n| Triggers | object | Список различных триггеров, для которых вебхук может быть включен/отключен. |\n| Open | object | Детали вебхука для открытий. |\n| Enabled | boolean | Указывает, включен ли вебхук для открытий. |\n| Click | object | Детали вебхука для кликов. |\n| Enabled | boolean | Указывает, включен ли вебхук для кликов. |\n| Delivery | object | Детали вебхука для доставок. |\n| Enabled | boolean | Указывает, включен ли вебхук для доставок. |\n| Bounce | object | Детали вебхука для возвратов. |\n| Enabled | boolean | Указывает, включен ли вебхук для возвратов. |\n| SpamComplaint | object | Детали вебхука для жалоб на спам. |\n| Enabled | boolean | Указывает, включен ли вебхук для жалоб на спам. |\n\n[Метод в документации](https://haskimail.ru/developer/webhooks-api/#create-a-webhook)",
"body": {
"mode": "raw",
"raw": "{\n \"Url\": \"http://www.example.com/webhook-test-tracking\",\n \"MessageStream\": \"outbound\",\n \"Triggers\": {\n \"Open\": {\n \"Enabled\": true\n },\n \"Click\": {\n \"Enabled\": true\n },\n \"Delivery\": {\n \"Enabled\": true\n },\n \"Bounce\": {\n \"Enabled\": false\n },\n \"SpamComplaint\": {\n \"Enabled\": false\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"ID\": 1234567,\n \"Url\": \"http://www.example.com/webhook-test-tracking\",\n \"MessageStream\": \"outbound\",\n \"Triggers\": {\n \"Open\": {\n \"Enabled\": true\n },\n \"Click\": {\n \"Enabled\": true\n },\n \"Delivery\": {\n \"Enabled\": true\n },\n \"Bounce\": {\n \"Enabled\": false\n },\n \"SpamComplaint\": {\n \"Enabled\": false\n }\n }\n}"
}
]
},
{
"name": "Редактирование вебхука",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/webhooks/:Id",
"host": [
"{{base_url}}"
],
"path": [
"webhooks",
":Id"
],
"variable": [
{
"key": "Id",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n| Url | string | Необязательно. Ваш новый URL вебхука. |\n| --- | --- | --- |\n| Triggers | object | Необязательно. Список событий для включения/отключения вебхуков. Если вы передаете настройки только для одного триггера (например, click), остальные останутся без изменений. Если поле Triggers не передается, настройки всех триггеров также не изменятся. |\n| Open | object | Настройки для вебхука открытий. |\n| Click | object | Настройки для вебхука кликов. |\n| Delivery | object | Настройки для вебхука доставок. |\n| Bounce | object | Настройки для вебхука возвратов. |\n| SpamComplaint | object | Настройки для вебхука жалоб на спам. |\n\n**Ответ**\n\n| ID | integer | ID вебхука. |\n| --- | --- | --- |\n| Url | string | URL вашего вебхука. |\n| MessageStream | integer | Канал, с которым связан этот вебхук. |\n| Triggers | object | Список различных триггеров, для которых вебхук может быть включен/отключен. |\n| Open | object | Детали вебхука для открытий. |\n| Enabled | boolean | Указывает, включен ли вебхук для открытий. |\n| Click | object | Детали вебхука для кликов. |\n| Enabled | boolean | Указывает, включен ли вебхук для кликов. |\n| Delivery | object | Детали вебхука для доставок. |\n| Enabled | boolean | Указывает, включен ли вебхук для доставок. |\n| Bounce | object | Детали вебхука для возвратов. |\n| Enabled | boolean | Указывает, включен ли вебхук для возвратов. |\n| SpamComplaint | object | Детали вебхука для жалоб на спам. |\n| Enabled | boolean | Указывает, включен ли вебхук для жалоб на спам. |\n\n[Метод в документации](https://haskimail.ru/developer/webhooks-api/#edit-a-webhook)",
"body": {
"mode": "raw",
"raw": "{\n \"Url\": \"http://www.example.com/webhooks\",\n \"HttpAuth\": {\n \"Username\": \"user\",\n \"Password\": \"pass\"\n },\n \"HttpHeaders\": [\n {\n \"Name\": \"name\",\n \"Value\": \"value\"\n }\n ],\n \"Triggers\": {\n \"Open\": {\n \"Enabled\": true\n },\n \"Click\": {\n \"Enabled\": true\n },\n \"Delivery\": {\n \"Enabled\": true\n },\n \"Bounce\": {\n \"Enabled\": true\n },\n \"SpamComplaint\": {\n \"Enabled\": true\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{base_url}}/webhooks/:Id",
"host": [
"{{base_url}}"
],
"path": [
"webhooks",
":Id"
],
"variable": [
{
"key": "Id",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Формат тела запроса**\n\n| Url | string | Необязательно. Ваш новый URL вебхука. |\n| --- | --- | --- |\n| Triggers | object | Необязательно. Список событий для включения/отключения вебхуков. Если вы передаете настройки только для одного триггера (например, click), остальные останутся без изменений. Если поле Triggers не передается, настройки всех триггеров также не изменятся. |\n| Open | object | Настройки для вебхука открытий. |\n| Click | object | Настройки для вебхука кликов. |\n| Delivery | object | Настройки для вебхука доставок. |\n| Bounce | object | Настройки для вебхука возвратов. |\n| SpamComplaint | object | Настройки для вебхука жалоб на спам. |\n\n**Ответ**\n\n| ID | integer | ID вебхука. |\n| --- | --- | --- |\n| Url | string | URL вашего вебхука. |\n| MessageStream | integer | Канал, с которым связан этот вебхук. |\n| Triggers | object | Список различных триггеров, для которых вебхук может быть включен/отключен. |\n| Open | object | Детали вебхука для открытий. |\n| Enabled | boolean | Указывает, включен ли вебхук для открытий. |\n| Click | object | Детали вебхука для кликов. |\n| Enabled | boolean | Указывает, включен ли вебхук для кликов. |\n| Delivery | object | Детали вебхука для доставок. |\n| Enabled | boolean | Указывает, включен ли вебхук для доставок. |\n| Bounce | object | Детали вебхука для возвратов. |\n| Enabled | boolean | Указывает, включен ли вебхук для возвратов. |\n| SpamComplaint | object | Детали вебхука для жалоб на спам. |\n| Enabled | boolean | Указывает, включен ли вебхук для жалоб на спам. |\n\n[Метод в документации](https://haskimail.ru/developer/webhooks-api/#edit-a-webhook)",
"body": {
"mode": "raw",
"raw": "{\n \"Url\": \"http://www.example.com/webhooks\",\n \"HttpAuth\": {\n \"Username\": \"user\",\n \"Password\": \"pass\"\n },\n \"HttpHeaders\": [\n {\n \"Name\": \"name\",\n \"Value\": \"value\"\n }\n ],\n \"Triggers\": {\n \"Open\": {\n \"Enabled\": true\n },\n \"Click\": {\n \"Enabled\": true\n },\n \"Delivery\": {\n \"Enabled\": true\n },\n \"Bounce\": {\n \"Enabled\": true\n },\n \"SpamComplaint\": {\n \"Enabled\": true\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"ID\": 1234567,\n \"Url\": \"http://www.example.com/webhooks\",\n \"MessageStream\": \"outbound\",\n \"Triggers\": {\n \"Open\": {\n \"Enabled\": true\n },\n \"Click\": {\n \"Enabled\": true\n },\n \"Delivery\": {\n \"Enabled\": true\n },\n \"Bounce\": {\n \"Enabled\": true\n },\n \"SpamComplaint\": {\n \"Enabled\": true\n }\n }\n}"
}
]
},
{
"name": "Удаление вебхука",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/webhooks/:Id",
"host": [
"{{base_url}}"
],
"path": [
"webhooks",
":Id"
],
"variable": [
{
"key": "Id",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ErrorCode | integer | [Коды ошибок API](/developer/api/overview#error-codes) |\n| --- | --- | --- |\n| Message | string | Сообщение о результате |\n\n[Метод в документации](https://haskimail.ru/developer/webhooks-api/#delete-a-webhook)"
},
"response": [
{
"name": "HTTP 200 OK",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "X-Haskimail-Server-Token",
"value": "{{server_token}}"
}
],
"url": {
"raw": "{{base_url}}/webhooks/:Id",
"host": [
"{{base_url}}"
],
"path": [
"webhooks",
":Id"
],
"variable": [
{
"key": "Id",
"value": "",
"description": "(обязательный) Подставьте значение."
}
]
},
"description": "**Заголовки запроса**\n\n| Accept | обязательный application/json |\n| --- | --- |\n| Content-Type | обязательный application/json |\n| X-Haskimail-Server-Token | обязательный Для этого запроса требуются права доступа на уровне сервера. Этот токен можно найти в настройках вашего сервера Haskimail на вкладке «Токены API». |\n\n**Ответ**\n\n| ErrorCode | integer | [Коды ошибок API](/developer/api/overview#error-codes) |\n| --- | --- | --- |\n| Message | string | Сообщение о результате |\n\n[Метод в документации](https://haskimail.ru/developer/webhooks-api/#delete-a-webhook)"
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"body": "{\n \"ErrorCode\": 0,\n \"Message\": \"Webhook 1234 removed.\"\n}"
}
]
}
]
}
]
}