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

`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 из [списка источников](/docs/entities/crm-tracking/sources-list) |
| `code` (path) | string | для пути по коду | Код встроенного источника из [списка источников](/docs/entities/crm-tracking/sources-list), например `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 — личный ключ

```bash

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-приложение

```bash

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 источника для [чтения](/docs/entities/crm-tracking/sources-get) |
| `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 | Код | Описание |
|------|-----|----------|
| 404 | `ENTITY_NOT_FOUND` | Источник не найден |
| 400 | `INVALID_PARAMS` | Некорректный тип поля, цвет или адрес источника |
| 400 | `UNKNOWN_FILTER_FIELD` | Передан query-параметр |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ разрешает только чтение |
| 403 | `SCOPE_DENIED` | Нет скоупа `crm` |
| 401 | `TOKEN_MISSING` | Для ключа не настроены токены |
| 422 | `METHOD_NOT_YET_AVAILABLE` | Возможность ещё не включена для портала |
| 502 | `BITRIX_UNAVAILABLE` | Получен некорректный ответ Битрикс24 |

Отказы Битрикс24 передаются с его кодом и сообщением. Общие ошибки — [Ошибки](/docs/errors).

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

- [Список источников](/docs/entities/crm-tracking/sources-list)

- [Получить источник](/docs/entities/crm-tracking/sources-get)

- [Создать источник](/docs/entities/crm-tracking/sources-create)