Для AI-агентов: markdown этой страницы — /docs-content/entities/crm-tracking/sources-update.md индекс документации — /llms.txt

Обновить источник сквозной аналитики

PATCH /v1/crm-tracking/sources/:id

PATCH /v1/crm-tracking/sources/by-code/:code

Изменяет переданные поля источника сквозной аналитики и возвращает его состояние после сохранения.

Метод выходит в обновлении crm 26.2100.0 и доступен не на всех порталах Битрикс24. Пока возможность не включена для портала, API возвращает 422 METHOD_NOT_YET_AVAILABLE.

Требуется скоуп crm и ключ с правом записи.

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типnumber Обяз.для пути по ID ОписаниеПоложительный целый ID из списка источников
Параметрcode (path) Типstring Обяз.для пути по коду ОписаниеКод встроенного источника из списка источников, например google

Выберите ровно один адрес: /sources/2 или /sources/by-code/google. Параметры адреса в query не принимаются.

Первое изменение встроенного источника по code создаёт его запись. До сохранения такой источник может иметь id: null.

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

Поле Тип Обяз. Описание
Полеname Типstring Обяз.нет ОписаниеНазвание источника
Полеcolor Типstring Обяз.нет ОписаниеЦвет собственного источника в формате #rgb или #rrggbb. Попытка изменить цвет встроенного источника отклоняется
ПолеrefDomains Типstring[] Обяз.нет ОписаниеПолный список доменов перехода. Для встроенных источников с предустановленными доменами попытка изменить список отклоняется
ПолеutmSources Типstring[] Обяз.нет ОписаниеПолный список значений utm_source

Списки заменяются целиком. [] очищает список, непереданное поле сохраняет значение. Битрикс24 удаляет внешние пробелы и пустые значения и ограничивает каждый список 100 значениями. API проверяет форму: массив строк.

Пустой объект передаётся без добавления полей. color: null сохраняет прежний цвет.

Примеры

curl — личный ключ

Terminal 

curl -X PATCH "https://vibecode.bitrix24.tech/v1/crm-tracking/sources/2" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Partner campaign updated",
  "utmSources": [
    "partner-new"
  ]
}'

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

Terminal 

curl -X PATCH "https://vibecode.bitrix24.tech/v1/crm-tracking/sources/2" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Partner campaign updated",
  "utmSources": [
    "partner-new"
  ]
}'

JavaScript — личный ключ

javascript 

const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-tracking/sources/2', {

  method: 'PATCH',

  headers: {
    "X-Api-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },

  body: JSON.stringify({
    "name": "Partner campaign updated",
    "utmSources": [
      "partner-new"
    ]
  }),

})

const { success, data } = await res.json()

console.log(data.id)

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

javascript 

const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-tracking/sources/2', {

  method: 'PATCH',

  headers: {
    "X-Api-Key": "YOUR_APP_KEY",
    "Authorization": "Bearer USER_SESSION_TOKEN",
    "Content-Type": "application/json"
  },

  body: JSON.stringify({
    "name": "Partner campaign updated",
    "utmSources": [
      "partner-new"
    ]
  }),

})

const { success, data } = await res.json()

console.log(data.id)

Поля ответа

HTTP 200. Источник перечитывается после сохранения.

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue при успехе
Полеdata Типobject ОписаниеСостояние источника
Полеdata.id Типnumber / null ОписаниеID источника для чтения
Полеdata.code Типstring / null ОписаниеКод встроенного источника, null у собственного
Полеdata.kind Типstring Описаниеown — собственный, builtIn — встроенный
Полеdata.name Типstring ОписаниеНазвание
Полеdata.color Типstring / null ОписаниеЦвет
Полеdata.isActive Типboolean ОписаниеИсточник активен
Полеdata.isConfigurable Типboolean ОписаниеИсточник допускает настройку
Полеdata.isConfigured Типboolean ОписаниеЗаданы значения UTM или домены перехода
Полеdata.refDomains Типstring[] ОписаниеДомены перехода
Полеdata.utmSources Типstring[] ОписаниеЗначения utm_source

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

Пример структуры ответа, не результат живого вызова.

JSON 

{
  "success": true,
  "data": {
    "id": 2,
    "code": null,
    "kind": "own",
    "name": "Partner campaign updated",
    "color": "#55d0e0",
    "isActive": true,
    "isConfigurable": true,
    "isConfigured": true,
    "refDomains": [
      "partner.example.com"
    ],
    "utmSources": [
      "partner-new"
    ]
  }
}

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

400 — некорректный цвет в теле обновления:

JSON 

{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "color must be #rgb or #rrggbb"
  }
}

Ошибки

HTTP Код Описание
HTTP404 КодENTITY_NOT_FOUND ОписаниеИсточник не найден
HTTP400 КодINVALID_PARAMS ОписаниеНекорректный тип поля, цвет или адрес источника
HTTP400 КодUNKNOWN_FILTER_FIELD ОписаниеПередан query-параметр
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч разрешает только чтение
HTTP403 КодSCOPE_DENIED ОписаниеНет скоупа crm
HTTP401 КодTOKEN_MISSING ОписаниеДля ключа не настроены токены
HTTP422 КодMETHOD_NOT_YET_AVAILABLE ОписаниеВозможность ещё не включена для портала
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеПолучен некорректный ответ Битрикс24

Отказы Битрикс24 передаются с его кодом и сообщением. Общие ошибки — Ошибки.

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