...
Параметр | Описание | Обязательный |
|---|---|---|
recipients | Массив получателей. Максимальный размер 10000 | Да |
run_triggers | Запустить связанные триггеры. Необходимо задать любое значение, например, true, t или 1. | Нет |
tags | Массив значений тегов | Нет |
callback_url | url, на который будет отправлен запрос после завершения импорта | нет |
Массив получателей recipients
Параметр | Описание | Обязательный |
|---|---|---|
Email получателя | Да | |
values | Массив значений для параметров | Нет |
Элементы массива значений values
Параметр | Описание | Обязательный |
|---|---|---|
parameter_id | ID параметра группы получателей | Да |
value | Значение параметра | Да |
Ответ сервера
Параметр | Описание |
|---|---|
id | Идентификатор импорта. В дальнейшем может использоваться для получения информации о ходе импорта |
status | Статус импорта |
callback_url | url, на который будет отправлен запрос после окончании импорта |
Пример JSON для запроса
| Code Block |
|---|
{
"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"
}
]
}
],
"tags":[
"buyer",
"regular customer"
]
}
|
Пример запроса
| Code Block |
|---|
curl -X POST https://api-em.prontosms.ru/v1/email/lists/1/recipients/imports \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer $API_TOKEN' \
-d '...JSON...'
|
...
| Code Block |
|---|
{
"id":7,
"status":"queued",
"callback_url": null
} |
Пример запроса после окончания импорта, если указан callback url
| Code Block |
|---|
{ "id":7, "status":"completed", "callback_url":"https://my-callback-url.com/some-secret" } |
Поиск получателей
Данный метод позволяет осуществить поиск получателя по email, например, чтобы определить в каких группах есть данный получатель.
...