Обновить дело

PATCH /v1/activity-configurable/:id

Перезаписывает конфигурируемое дело. fields и layout передаются целиком — метод заменяет дело, а не обновляет отдельные поля. Незаданные значения сбрасываются.

Параметры

Параметр Тип Обяз. Описание
id (path) number да ID дела. Получен при создании

Поля запроса (body)

Поле Тип Обяз. Описание
fields object да Поля дела
fields.typeId string нет Тип дела. По умолчанию CONFIGURABLE
fields.completed boolean нет Дело закрыто. Принимает true/false, 1/0, Y/N
fields.deadline string нет Крайний срок исполнения, ISO 8601. Несовместим с fields.isIncomingChannel
fields.pingOffsets number[] нет Смещения в минутах относительно fields.deadline, в которые формируются напоминания
fields.isIncomingChannel boolean нет Дело создано из входящего канала. Принимает true/false, 1/0, Y/N
fields.responsibleId number нет ID ответственного сотрудника. Список: GET /v1/users
fields.badgeCode string нет Код значка дела на канбане
fields.originatorId string нет ID внешнего источника данных
fields.originId string нет ID записи во внешнем источнике
layout object да Оформление дела
layout.icon.code string да Код иконки дела
layout.header.title string да Заголовок дела
layout.body.logo.code string да Код логотипа в теле. Тело без logo Битрикс24 отклоняет
layout.body.blocks object нет Именованные блоки тела
layout.footer.buttons object нет Кнопки футера

Блок в layout.body.blocks имеет type и properties. Основные типы блоков:

  • text — значение
  • link — ссылка с действием
  • lineOfBlocks — строка из вложенных блоков
  • withTitle — блок с подписью

Действие у ссылок и кнопок задаёт поле type:

  • redirect — переход по адресу из поля uri
  • openRestApp — открытие приложения с параметрами actionParams
  • restEvent — событие приложению по id, для пунктов меню

Примеры

Примеры приведены только для OAuth-приложения.

curl — OAuth-приложение

Terminal 
curl -X PATCH https://vibecode.bitrix24.tech/v1/activity-configurable/8053 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "fields": { "typeId": "CONFIGURABLE", "completed": true, "responsibleId": 5 },
    "layout": {
      "icon": { "code": "call-completed" },
      "header": { "title": "Звонок обработан" },
      "body": { "logo": { "code": "call-incoming" }, "blocks": {} },
      "footer": { "buttons": {} }
    }
  }'

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/activity-configurable/8053', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    fields: { typeId: 'CONFIGURABLE', completed: true, responsibleId: 5 },
    layout: {
      icon: { code: 'call-completed' },
      header: { title: 'Звонок обработан' },
      body: { logo: { code: 'call-incoming' }, blocks: {} },
      footer: { buttons: {} },
    },
  }),
})

const { data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.activity.id number ID обновлённого дела

Пример ответа

JSON 
{
  "success": true,
  "data": { "activity": { "id": 8053 } }
}

Пример ответа при ошибке

404 — дело не найдено:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Элемент не найден"
  }
}

Ошибки

HTTP Код Описание
400 VALIDATION_ERROR id в пути не число, либо не передан fields или layout
404 ENTITY_NOT_FOUND Дела с указанным id не существует
422 BITRIX_ERROR Битрикс24 отклонил запрос: дело создано другим приложением ERROR_WRONG_APPLICATION, не заполнен layout.body.logo, пустой layout
403 SCOPE_DENIED Ключу не хватает скоупа crm
401 TOKEN_MISSING Ключ авторизации передан без токена сессии в заголовке Authorization: Bearer

Полный список общих ошибок API — Ошибки.

Известные особенности

Только в контексте приложения. Нужен ключ авторизации vibe_app_* с токеном сессии в заголовке Authorization: Bearer. Персональный API-ключ vibe_api_* Битрикс24 отклоняет с ERROR_WRONG_CONTEXT.

Обновляет только приложение-автор. Изменить дело может лишь то приложение, которое его создало. Чужое дело Битрикс24 отклоняет с ERROR_WRONG_APPLICATION.

Смотрите также