Статусы

Получить список всех статусов аккаунта

GET /v1.3/statuses

После успешного выполнения возвращается массив объектов, описывающих статусы.

id integer Идентификатор статуса
name string Название статуса
order integer Поле для сортировки
type string Тип статуса
color string Цвет статуса

Пример:

GET https://api.umnico.com/v1.3/statuses

Response:

[
  {
      "id": 1,
      "type": "active",
      "name": "Первичный контакт",
      "order": 1,
      "color": "#64e4a3"
  },
  {
      "id": 12,
      "type": "completed",
      "name": "Тестовый статус",
      "order": 51,
      "color": "#0e5451"
  },
  {
      "id": 6,
      "type": "ignore",
      "name": "Спам",
      "order": 70,
      "color": "#ff5b60"
  }
]

Добавить статус

POST /v1.3/statuses

Тело запроса:

  • name - название статуса
  • order - поле для сортировки в рамках одного типа
  • type - один из типов статуса:
    • active - активный тип
    • completed - архивный успешный тип
    • failed - архивный неуспешный тип
    • ignore - тип «Не обращение»

После успешного выполнения возвращается созданный объект, описывающий статус (см. выше).


Пример:

POST https://api.umnico.com/v1.3/statuses

Body:

{
   "name": "Лучший статус сделки в мире",
   "order": 2,
   "type": "active"
}

Response:

{
  "id": 13,
  "type": "active",
  "name": "Лучший статус сделки в мире",
  "order": 2,
  "color": "#373ccc"
}

Изменить статус в разработке

PUT /v1.3/statuses/<id>

  • id - идентификатор статуса

Тело запроса:

  • name - название статуса
  • color - цвет статуса

После успешного выполнения возвращается объект, описывающий статус (см. выше).

Изменить порядок статусов в разработке

Примечание

Порядок менять можно только в рамках одного типа. Если вы хотите перенести статус в другой тип, то удалите данный статус и создайте новый.

PUT /v1.3/statuses/reorder


Тело запроса:

  • массив, состоящий из объектов
    • id - идентификатор статуса
    • order - значение сортировки в рамках одного типа

Удалить статус

DELETE /v1.3/statuses/<id>

  • id - идентификатор статуса

Пример:

DELETE https://api.umnico.com/v1.3/statuses/13

Response: status 200