CRM links

Изменить или закрыть дело

Признак done ставит и снимает отметку о выполнении: закрытое по ошибке дело возвращается в работу

patch/api/v1/crm/engagements/{id}

Request

  • Base URL: https://erp.akeda.ru
  • URL: https://erp.akeda.ru/api/v1/crm/engagements/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://erp.akeda.ru/oauth2/authorize, token URL https://erp.akeda.ru/oauth2/token, scopes: akeda:delegate)

Request body

kindstring

Код вида дела из справочника «Виды дел» кабинета (GET /api/v1/crm/engagement-kinds). Новому кабинету заведены call, meeting, measurement, email и task; свои виды кабинет добавляет в справочнике

titlestring
descriptionstring

Подробности дела

due_atstring date-time nullable

null снимает срок

remind_atstring date-time nullable

null снимает напоминание; новое время снова ставит его в очередь

repeat'none' | 'daily' | 'weekly' | 'monthly'

Повтор дела: закрытое повторяющееся дело само заводит следующее

owner_idinteger nullable
doneboolean

true закрывает дело, false возвращает в работу; закрытие повторяющегося дела заводит следующее

in_calendarboolean

true ставит в календарь дело, у которого события ещё нет

ends_atstring date-time nullable

Конец дела; null снимает. При переносе срока без конца встреча сохраняет длительность

all_dayboolean

Дело на весь день: начало и конец - границы суток в поясе timezone

timezonestring

Часовой пояс того, кто планировал (IANA, например Europe/Moscow): в нём встреча стоит в календаре

locationstring

Адрес встречи; только у видов с галочкой «Адрес»

conference_urlstring

Ссылка видеовстречи (http/https); только у видов с галочкой «Видеовстреча». Пусто снимает видеовстречу

conference_provider'' | 'telemost' | 'personal' | 'link'

Откуда ссылка; пусто при ссылке - вставленная руками

conference_idstring

Номер комнаты Телемоста

participant_idsinteger[]

Новый список коллег-участников целиком. Смена вида снимает поля, которых у нового вида нет

Response

Обновлённое дело

idstring uuid required
entity_type'lead' | 'deal' | 'customer' required
entity_idstring uuid required
kindstring required

Код вида дела из справочника «Виды дел» кабинета (GET /api/v1/crm/engagement-kinds). Новому кабинету заведены call, meeting, measurement, email и task; свои виды кабинет добавляет в справочнике

titlestring required
descriptionstring required

Подробности дела: что обсудить, адрес встречи

due_atstring date-time
done_atstring date-time

Пусто, пока дело не выполнено

remind_atstring date-time

Когда напомнить ответственному

reminded_atstring date-time

Когда напоминание ушло в центр уведомлений

repeat'none' | 'daily' | 'weekly' | 'monthly' required

Повтор дела: закрытое повторяющееся дело само заводит следующее

ends_atstring date-time

Конец дела; срок due_at - его начало

all_dayboolean

Дело на весь день: начало и конец - границы суток в поясе timezone

timezonestring

Часовой пояс того, кто планировал (IANA, например Europe/Moscow): в нём встреча стоит в календаре

locationstring

Адрес встречи; только у видов с галочкой «Адрес»

conference_urlstring

Ссылка видеовстречи; только у видов с галочкой «Видеовстреча»

conference_provider'' | 'telemost' | 'personal' | 'link'

Откуда ссылка: комната Телемоста, личная ссылка или вставленная руками

conference_idstring

Номер комнаты Телемоста

participant_idsinteger[]

Коллеги-участники (номера сотрудников из GET /api/v1/crm/members); ответственный - организатор и в список не входит

calendar_event_idstring uuid
task_idstring uuid
owner_idinteger
owner_namestring
entity_titlestring

Название карточки дела (в списке «Мои дела»)

warningsstring[]

Дело сохранено, но событие календаря не заведено или не обновлено

created_byinteger required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.