Создание получателя в группе
Пример json данных для HTTP запроса:
{
"email":"alice@example.org",
"unconfirmed": true,
"values":[
{
"parameter_id":"1",
"value":"Alice"
},
{
"parameter_id":"2",
"value":"22"
}
]
}
Пример HTTP запроса:
curl -X POST https://api.msndr.net/v1/email/lists/1/recipients \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer $API_TOKEN' \
-d '...JSON...'
Используется метод POST и ссылка /email/lists/:id/recipients
Где id это идентификатор группы получателей
Пример ответа в случае успешного HTTP запроса:
{
"id":1,
"email":"alice@example.org",
"confirmed":false,
"list_id":1,
"status": "active",
"values":[
{
"value":"Alice",
"kind":"string",
"parameter_id":1
},
{
"value":22.0,
"kind":"numeric",
"parameter_id":2
}
]
}
Пояснение к параметрам запроса приведено ниже в таблице:
Параметр |
Описание |
Обязательный |
|
Email адрес получателя |
Да |
unconfirmed |
Создать неподтвержденного получателя. Необходимо задать любое значение, например, true, t или 1. По умолчанию создается подтвержденный получатель |
Нет |
values |
Массив значений для параметров |
Нет |
Параметры элементов массива значений ( values ) и их описание приведены ниже:
Параметр |
Описание |
Обязательный |
parameter_id |
ID параметра группы получателей |
Да |
value |
Да |
Описание атрибутов json ответа от сервера приведено ниже в таблице:
Атрибут |
Описание |
id |
Идентификатор |
|
Email адрес получателя |
confirmed |
Подтвержден получатель или нет |
status |
Статус получателя. Возможные значения: active, incorrect, unconfirmed, unsubscribed |
values |
Массив значений |
Пояснение атрибутов элементов массива значений ( values ) в json ответе сервера приведено в таблице ниже:
Параметр |
Описание |
parameter_id |
ID параметра группы получателей |
kind |
Тип параметра |
value |
Значение параметра |
Получение информации о получателе в группе
Пример HTTP запроса:
curl -X GET https://api.msndr.net/v1/email/lists/1/recipients/2 \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer $API_TOKEN'
Здесь используется метод GET и ссылка /email/lists/:list_id/recipients/:id
Где list_id это идентификатор группы получателей, а id идентификатор получателя
Пример ответа в случае успешного запроса:
{
"id":2,
"email":"alice@example.org",
"confirmed":false,
"list_id":1,
"status": "active",
"values":[
{
"value":"Alice",
"kind":"string",
"parameter_id":1
},
{
"value":22.0,
"kind":"numeric",
"parameter_id":2
}
]
}
Ниже в таблице приведено пояснение параметров HTTP запроса:
Параметр |
Описание |
Обязательный |
list_id |
ID группы |
Да |
id |
ID получателя |
Да |
Пояснение атрибутов json ответа сервера:
Атрибут |
Описание |
id |
Идентификатор получателя |
|
Email адрес получателя |
confirmed |
Подтвержден получатель или нет |
status |
Статус получателя. Возможные значения: active, incorrect, unconfirmed, unsubscribed |
values |
Массив значений |
Пояснение атрибутов элементов массива значений ( values ) в json ответе сервера приведено ниже в таблице:
Параметр |
Описание |
parameter_id |
ID параметра группы получателей |
kind |
Тип параметра |
value |
Значение |
Редактирование параметров получателя в группе:
Пример json данных для HTTP запроса:
{
"email":"alice@example.org",
"values":[
{
"parameter_id":"1",
"value":"Alice"
},
{
"parameter_id":"2",
"destroy":"true"
}
]
}
Пример HTTP запроса:
curl -X PATCH https://api.msndr.net/v1/email/lists/1/recipients/1 \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer $API_TOKEN' \
-d '...JSON...'
Используется метод PATCH и ссылка /email/lists/:list_id/recipients/:id
Где list_id это идентификатор группы получателей, id это идентификатор получателя
Пример ответа в случае успешно запроса:
{
"id":1,
"email":"alice@example.org",
"confirmed":true,
"status": "active",
"list_id":1,
"values":[
{
"value":"Alice",
"kind":"string",
"parameter_id":1
}
]
}
Пояснение параметров запроса приведено ниже в таблице:
Параметр |
Описание |
Обязательный |
|
Email адрес получателя |
Нет |
values |
Массив значений для параметров |
Пояснение параметров элемента массива значений ( values ) в HTTP запросе приведено в таблице ниже:
Параметр |
Описание |
Обязательный |
parameter_id |
ID параметра группы получателей |
Да |
value |
Не может быть одновременно использован с параметром destroy |
Нет |
destroy |
Используется для удаления значения. Для удаления значения необходимо задать любое значение, например, true, t или 1. Не можеть быть использован одновременно с параметром value |
Пояснение атрибутов в json ответе от сервера:
Атрибут |
Описание |
id |
Идентификатор |
|
Адрес |
confirmed |
Подтвержден получатель или нет |
status |
Статус получателя. Возможные значения: active, incorrect, unconfirmed, unsubscribed |
values |
Массив значений |
Пояснение параметров элементов массива значений ( values ) в json ответе сервера приведено ниже в таблице:
Параметр |
Описание |
parameter_id |
ID параметра группы получателей |
kind |
Тип параметра |
value |
Значение параметра |
Получение списка получателей в группе
Пример HTTP запроса:
curl -X GET https://api.msndr.net/v1/email/lists/1/recipients \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer $API_TOKEN'
Здесь используется метод GET и ссылка /email/lists/:id/recipients
Где id это идентификатор группы получателей
Данный метод поддерживает постраничный вывод. Максимальный размер страницы ( page_size ) является 1000
Пример json ответа в случае успешного запроса:
{
"total_count":2,
"total_pages":1,
"page_number":1,
"page_size":25,
"collection":[
{
"id":1,
"email":"alice@example.org",
"confirmed":true,
"status": "active",
"list_id":1,
"values":[
{
"value":"Alice",
"kind":"string",
"parameter_id":9
},
{
"value":22.0,
"kind":"numeric",
"parameter_id":10
}
]
},
{
"id":2,
"email":"bob@example.org",
"confirmed":true,
"status": "active",
"list_id":1,
"values":[
]
}
]
}
Пояснение параметров элементов массива получателей ( collection ) json ответа от сервера приведено ниже в таблице:
Атрибут |
Описание |
id |
Идентификатор получателя |
|
Email адрес получателя |
confirmed |
Подтвержден получатель или нет |
status |
Статус получателя. Возможные значения: active, incorrect, unconfirmed, unsubscribed |
values |
Массив значений |
Пояснение параметров элементов массива значений ( values ) для каждого получателя:
Параметр |
Описание |
parameter_id |
ID параметра группы получателей |
kind |
Тип параметра |
value |
Значение параметра |
Удаление получателя в группе
Пример HTTP запроса:
curl -X DELETE https://api.msndr.net/v1/email/lists/1/recipients/1 \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer $API_TOKEN'
Здесь используется метод DELETE и ссылка /email/lists/:list_id/recipients/:id
Где list_id это идентификатор группы получателей, id это идентификатор получателя.
Импорт большого количества получателей в группу получателей
Пример json данных для HTTP запроса:
{
"recipients":[
{
"email":"alice@example.org",
"values":[
{
"parameter_id":"1",
"value":"Alice"
},
{
"parameter_id":"2",
"value":"22"
}
]
},
{
"email":"bob@example.org",
"values":[
{
"parameter_id":"1",
"value":"Bob"
},
{
"parameter_id":"2",
"value":"11"
}
]
}
]
}
Пример HTTP запроса:
curl -X POST https://api.msndr.net/v1/email/lists/1/recipients/imports \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer $API_TOKEN' \
-d '...JSON...'
Здесь используется метод POST и ссылка /email/lists/:id/recipients/imports
Где id это идентификатор группы получателей
Пример json ответа в случае успешного запроса:
{
"id":7,
"status":"queued"
}
Пояснение параметров в json данных HTTP запроса представлено ниже в таблице:
Параметр |
Описание |
Обязательный |
recipients |
Массив получателей. Максимальный размер 10000 |
Да |
run_triggers |
Запустить связанные триггеры. Необходимо задать любое значение, например, true, t или 1. |
Нет |
Описание параметров элементов массива получателей ( recipients ), которых необходимо импортировать представлено ниже в таблице:
Параметр |
Описание |
Обязательный |
|
Email адрес получателя |
Да |
values |
Массив значений для параметров |
Описание параметров элементов массива значений ( values ) для каждого получателя приведено ниже в таблице:
Параметр |
Описание |
Обязательный |
parameter_id |
ID параметра группы получателей |
Да |
value |
Да |
Пояснение параметров json ответа сервера приведено ниже в таблице:
Параметр |
Описание |
id |
Идентификатор импорта. В дальнейшем может использоваться для получения информации о ходе импорта |
status |
Статус импорта получателей |
Поиск получателей по email адресу
Пример HTTP запроса:
curl -X GET https://api.msndr.net/v1/email/recipients/search?email=foo@bar.com \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer $API_TOKEN'
Здесь используется метод GET и ссылка /email/recipients/search
Пример ответа в случае успешного HTTP запроса:
{
"total_count": 2,
"total_pages": 1,
"page_number": 1,
"page_size": 25,
"collection": [
{
"email": "foo@bar.com",
"recipients": [
{
"list_id": 1,
"list_title": "List #1",
"recipient_id": 1
},
{
"list_id": 2,
"list_title": "List #2",
"recipient_id": 2
}
]
}
],
"query": "test"
}
Параметры HTTP запроса описаны ниже в таблице:
Параметр |
Описание |
Обязательный |
|
Email адрес получателя |
Да |
Ниже в таблице представлено описание параметров элементов в массиве получателей ( recipients ) в json ответе сервера:
Атрибут Описание
email Email адрес получателя
recipients Массив, содержащий информацию о списках, в которых есть искомый получатель