Элементы списка
Важно
В данных методах отправка в запросе данных контакта должна быть отключена.
Получить элементы списка
POST https://app.leadteh.ru/api/v1/getListItems
Этот метод позволяет получить элементы списка.
Request Body
| Name | Type | Description |
|---|---|---|
| schema_id* | string | ID списка |
| bot_id | integer | ID бота (если такое поле есть) |
| contact_id | integer | ID контакта (если такое поле есть) |
| order_by | string | Поле, по которому необходимо сделать сортировку. Например: created_at или created_at,desc |
| filters | object | Поля для фильтрации данных. Например: {"name": "Дмитрий"} или {"age": ">=,18"} |
| page | object | Выбор страницы |
200 Запрос успешно обработан.
{
"data": [
{
"id": "5dee39b68a7ab32ecf060264",
"contact_id": 1,
"created_at": "2019-12-09T12:10:30+00:00",
"updated_at": "2019-12-09T12:10:30+00:00",
"first_name": "Иван",
"last_name": "Иванов"
},
{
"id": "5dee39bb6637df57be7bc683",
"contact_id": 1,
"created_at": "2019-12-09T12:10:35+00:00",
"updated_at": "2019-12-09T12:10:35+00:00",
"first_name": "Петр",
"last_name": "Петров"
},
{
"id": "5dee39bdc2cc5a38ec797234",
"contact_id": 1,
"created_at": "2019-12-09T12:10:37+00:00",
"updated_at": "2019-12-09T12:10:37+00:00",
"first_name": "Василий",
"last_name": "Васильев"
}
],
"links": {
"first": "https:\/\/leadteh.ru\/api\/v1\/getListItems?page=1",
"last": "https:\/\/leadteh.ru\/api\/v1\/getListItems?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "https:\/\/leadteh.ru\/api\/v1\/getListItems",
"per_page": 50,
"to": 3,
"total": 3
}
}
Информация
Если вы указываете фильтр в запросе, то он прописывается в таком виде: \
filters[name]=Дмитрий
Важно
Для фильтрации по типу поля id контакта, надо в запросе указать client_id.
Пример: filters[client_id]={{id}}
Добавить элемент в список
POST https://app.leadteh.ru/api/v1/addListItem
Этот метод позволяет добавить элемент в список.
Request Body
| Name | Type | Description |
|---|---|---|
| schema_id* | string | ID списка |
| data | object | Поля элемента. |
201: Created Запрос успешно обработан.
{
"data": {
"id": "5dee62e46637df57be7bc686",
"contact_id": 443,
"created_at": "2019-12-09T15:06:12+00:00",
"updated_at": "2019-12-09T15:06:12+00:00",
"name": "Товар",
"quantity": null,
"is_vip": true,
"key": "secret"
}
}
Обновить элемент в списке
POST https://app.leadteh.ru/api/v1/updateListItem
Этот метод позволяет обновить элемент в списке.
Request Body
| Name | Type | Description |
|---|---|---|
| item_id* | string | ID элемента в списке |
| data | object | Поля элемента. |
200: OK Запрос успешно обработан.
{
"data": {
"id": "5dee62e46637df57be7bc686",
"contact_id": 1,
"created_at": "2019-12-09T15:06:12+00:00",
"updated_at": "2019-12-09T15:09:47+00:00",
"name": "Товар",
"quantity": null,
"is_vip": false,
"key": "secret"
}
}
Удалить элемент списка
POST https://app.leadteh.ru/api/v1/deleteListItem
Этот метод позволяет удалить элемент в списке.
Request Body
| Name | Type | Description |
|---|---|---|
| item_id* | string | ID элемента в списке |
204: No Content Запрос успешно обработан.
Онлайн-запись на услуги