Элементы списка

Данное API позволяет создавать произвольные списки и проводить различные операции над ними, которые возможно привязывать к пользователю или к боту.

Как правильно сформировать запрос?! Смотрим в основах

Получить элементы списка

POST https://app.cleverapp.pro/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"}

{
  "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:\/\/watbot.ru\/api\/v1\/getListItems?page=1",
    "last": "https:\/\/watbot.ru\/api\/v1\/getListItems?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https:\/\/watbot.ru\/api\/v1\/getListItems",
    "per_page": 50,
    "to": 3,
    "total": 3
  }
}

Добавить элемент в список

POST https://app.cleverapp.pro/api/v1/addListItem

Этот метод позволяет добавить элемент в список.

Request Body

Name
Type
Description

data*

object

Поля элемента. Пример {"slug поля": "значение"}

schema_id*

string

ID списка.

{
  "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.cleverapp.pro/api/v1/updateListItem

Этот метод позволяет удалить элемент в списке.

Request Body

Name
Type
Description

item_id

string

ID элемента в списке.

data*

object

Поля элемента. Пример {"slug поля": "значение"}

{
  "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.cleverapp.pro/api/v1/deleteListItem

Этот метод позволяет удалить элемент в списке.

Request Body

Name
Type
Description

item_id

string

ID элемента в списке.

{
    // Response
}
PreviousСпискиNextСообщения

Last updated