Справочник API

Колонки воронки

Колонки воронки задают этапы вашей доски диалогов, например «Заинтересованы» или «Созвон назначен». Каждый диалог находится в одной колонке. Колонки «Запросы», «Входящие», «Написали», «Ответили» и колонки персон входят в саму доску, остальные создаёте вы. На доске может быть не больше 50 колонок.

Эндпоинты

GET/v1/pipeline_columns
POST/v1/pipeline_columns
PATCH/v1/pipeline_columns/:column_id
DELETE/v1/pipeline_columns/:column_id
POST/v1/pipeline_columns/reorder

Объект колонки воронки

Колонка доски диалогов, например «Заинтересованы» или «Созвон назначен». Каждый диалог находится в одной колонке.

Атрибуты

idstring
Уникальный идентификатор колонки.
objectstring
Всегда pipeline_column.
namestring
Название колонки.
kindstring
requests, inbox, contacted и replied обозначают собственные колонки доски, persona привязана к персоне, custom означает вашу колонку.
requestsinboxcontactedrepliedpersonacustom
persona_idstring или null
Персона колонки persona.
positioninteger
Позиция на доске, начиная с 0 слева.
collapsedboolean
Свёрнута ли она на доске.
deletableboolean
Можно ли её удалить. Удалять можно только колонки custom.

Объект колонки воронки

{
  "id": "q7m2xk4p",
  "object": "pipeline_column",
  "name": "Interested",
  "kind": "custom",
  "persona_id": null,
  "position": 2,
  "collapsed": false,
  "deletable": true
}

Список колонок воронки

GET/v1/pipeline_columnsПраво readMCPlist_pipeline_columns

Возвращает колонки доски слева направо.

Возвращает

Список объектов колонки воронки.

GET/v1/pipeline_columns

curl https://gemlead.ai/api/v1/pipeline_columns \
  -H "Authorization: Bearer $GEMLEAD_API_KEY"

Ответ200

{
  "object": "list",
  "data": [
    {
      "id": "r1n8vd2c",
      "object": "pipeline_column",
      "name": "Requests",
      "kind": "requests",
      "persona_id": null,
      "position": 0,
      "collapsed": true,
      "deletable": false
    },
    {
      "id": "h5t0bw9e",
      "object": "pipeline_column",
      "name": "Inbox",
      "kind": "inbox",
      "persona_id": null,
      "position": 1,
      "collapsed": false,
      "deletable": false
    },
    {
      "id": "q7m2xk4p",
      "object": "pipeline_column",
      "name": "Interested",
      "kind": "custom",
      "persona_id": null,
      "position": 2,
      "collapsed": false,
      "deletable": true
    },
    {
      "id": "z3c6lf8a",
      "object": "pipeline_column",
      "name": "Call booked",
      "kind": "custom",
      "persona_id": null,
      "position": 3,
      "collapsed": false,
      "deletable": true
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Создание колонки воронки

POST/v1/pipeline_columnsПраво writeMCPedit_pipeline_columns

Добавляет колонку на доску.

Параметры тела

namestringОбязательно
Название колонки, до 60 символов.
positioninteger
Позиция колонки, 0 ставит её первой. По умолчанию в конец.

Возвращает

Колонки доски, список объектов колонки воронки.

Ошибки

400parameter_missing
Отсутствует обязательный параметр. Название параметра указано в param.
400parameter_invalid
API не принимает значение параметра. Название параметра указано в param.
400limit_reached
На доске уже 50 колонок.

POST/v1/pipeline_columns

curl -X POST https://gemlead.ai/api/v1/pipeline_columns \
  -H "Authorization: Bearer $GEMLEAD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Call booked",
    "position": 3
  }'

Ответ200

{
  "object": "list",
  "data": [
    {
      "id": "r1n8vd2c",
      "object": "pipeline_column",
      "name": "Requests",
      "kind": "requests",
      "persona_id": null,
      "position": 0,
      "collapsed": true,
      "deletable": false
    },
    {
      "id": "h5t0bw9e",
      "object": "pipeline_column",
      "name": "Inbox",
      "kind": "inbox",
      "persona_id": null,
      "position": 1,
      "collapsed": false,
      "deletable": false
    },
    {
      "id": "q7m2xk4p",
      "object": "pipeline_column",
      "name": "Interested",
      "kind": "custom",
      "persona_id": null,
      "position": 2,
      "collapsed": false,
      "deletable": true
    },
    {
      "id": "z3c6lf8a",
      "object": "pipeline_column",
      "name": "Call booked",
      "kind": "custom",
      "persona_id": null,
      "position": 3,
      "collapsed": false,
      "deletable": true
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Изменение колонки воронки

PATCH/v1/pipeline_columns/:column_idПраво writeMCPedit_pipeline_columns

Переименовывает колонку или сворачивает её на доске.

Параметры пути

column_idstringОбязательно
ID колонки.

Параметры тела

namestring
Название колонки, до 60 символов.
collapsedboolean
Свернуть колонку на доске.

Возвращает

Колонки доски, список объектов колонки воронки.

Ошибки

404resource_missing
В аккаунте ключа нет колонки с этим ID.
400parameter_invalid
API не принимает значение параметра. Название параметра указано в param.
400parameter_unknown
В теле есть поле, которое этот эндпоинт не принимает.

PATCH/v1/pipeline_columns/:column_id

curl -X PATCH \
  https://gemlead.ai/api/v1/pipeline_columns/z3c6lf8a \
  -H "Authorization: Bearer $GEMLEAD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Demo booked"
  }'

Ответ200

{
  "object": "list",
  "data": [
    {
      "id": "r1n8vd2c",
      "object": "pipeline_column",
      "name": "Requests",
      "kind": "requests",
      "persona_id": null,
      "position": 0,
      "collapsed": true,
      "deletable": false
    },
    {
      "id": "h5t0bw9e",
      "object": "pipeline_column",
      "name": "Inbox",
      "kind": "inbox",
      "persona_id": null,
      "position": 1,
      "collapsed": false,
      "deletable": false
    },
    {
      "id": "q7m2xk4p",
      "object": "pipeline_column",
      "name": "Interested",
      "kind": "custom",
      "persona_id": null,
      "position": 2,
      "collapsed": false,
      "deletable": true
    },
    {
      "id": "z3c6lf8a",
      "object": "pipeline_column",
      "name": "Demo booked",
      "kind": "custom",
      "persona_id": null,
      "position": 3,
      "collapsed": false,
      "deletable": true
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Удаление колонки воронки

DELETE/v1/pipeline_columns/:column_idПраво writeMCPedit_pipeline_columns

Удаляет одну из ваших колонок. Её диалоги возвращаются в колонку «Входящие».

Параметры пути

column_idstringОбязательно
ID колонки.

Возвращает

Объект с id колонки и deleted, равным true.

Ошибки

404resource_missing
В аккаунте ключа нет колонки с этим ID.
400column_protected
Колонка входит в саму доску, например «Входящие» или колонка персоны.

DELETE/v1/pipeline_columns/:column_id

curl -X DELETE \
  https://gemlead.ai/api/v1/pipeline_columns/z3c6lf8a \
  -H "Authorization: Bearer $GEMLEAD_API_KEY"

Ответ200

{
  "id": "z3c6lf8a",
  "object": "pipeline_column",
  "deleted": true
}

Изменение порядка колонок воронки

POST/v1/pipeline_columns/reorderПраво writeMCPedit_pipeline_columns

Расставляет колонки доски в новом порядке. Передайте каждую колонку ровно один раз.

Параметры тела

column_idsмассив stringsОбязательно
Все ID колонок доски слева направо.

Возвращает

Колонки доски в новом порядке, список объектов колонки воронки.

Ошибки

400parameter_missing
Отсутствует обязательный параметр. Название параметра указано в param.
400parameter_invalid
API не принимает значение параметра. Название параметра указано в param.
404resource_missing
Один из ID не принадлежит колонкам доски.

POST/v1/pipeline_columns/reorder

curl -X POST \
  https://gemlead.ai/api/v1/pipeline_columns/reorder \
  -H "Authorization: Bearer $GEMLEAD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "column_ids": ["r1n8vd2c", "h5t0bw9e", "z3c6lf8a", "q7m2xk4p"]
  }'

Ответ200

{
  "object": "list",
  "data": [
    {
      "id": "r1n8vd2c",
      "object": "pipeline_column",
      "name": "Requests",
      "kind": "requests",
      "persona_id": null,
      "position": 0,
      "collapsed": true,
      "deletable": false
    },
    {
      "id": "h5t0bw9e",
      "object": "pipeline_column",
      "name": "Inbox",
      "kind": "inbox",
      "persona_id": null,
      "position": 1,
      "collapsed": false,
      "deletable": false
    },
    {
      "id": "z3c6lf8a",
      "object": "pipeline_column",
      "name": "Call booked",
      "kind": "custom",
      "persona_id": null,
      "position": 2,
      "collapsed": false,
      "deletable": true
    },
    {
      "id": "q7m2xk4p",
      "object": "pipeline_column",
      "name": "Interested",
      "kind": "custom",
      "persona_id": null,
      "position": 3,
      "collapsed": false,
      "deletable": true
    }
  ],
  "has_more": false,
  "next_cursor": null
}