Получение списка подписчиков сегмента
Запрос
POST /pub/v1/marketing/segment/{id}/subscribers
Параметры пути (path)
| Имя параметра | Тип | Описание | Дополнительно |
|---|---|---|---|
| id | uuid | Идентификатор сегмента |
Обязательный |
Тело запроса (body)
Тело запроса принимает ресурс Получение списка подписчиков сегмента — Request. Содержит следующие доступные для записи свойства:
{
"filter": {
"<key>": {}
},
"from": "uint32",
"size": "uint32"
}Свойства
| Имя | Тип | Описание | Дополнительно |
|---|---|---|---|
| filter | object |
Фильтрация |
Опциональное |
| filter.<key> | map of object | Опциональное | |
| from | uint32 |
Возвращать начиная с элемента |
Опциональное |
| size | uint32 |
Количество возвращаемых элементов (максимум 10000) |
Опциональное |
Авторизация
Запрос обязательно должен использовать один из следующих методов авторизации:
API key
Ответ
Могут быть возвращены следующие коды состояния HTTP:
| HTTP-статус | Описание | Модель ответа |
|---|---|---|
| 200 | OK Модель списка подписчиков сегмента |
Модель списка подписчиков сегмента (Получение списка подписчиков сегмента) |
| 400 | Bad Request Ошибка проверки входных данных или выполнения метода |
|
| 412 | Precondition Failed Отсутствует лицензия CRM |