---
metadata:
  - name: generator
    content: Diplodoc Platform v5.19.4
alternate:
  - https://yandex.ru/dev/audience/en/ref/openapi/pixels/editPixel.md
  - https://yandex.ru/dev/audience/ru/ref/openapi/pixels/editPixel.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/audience/ru/llms.txt

<div class="openapi">

# Изменение пикселя

<!-- markdownlint-disable-file -->

Изменяет указанный пиксель.

## Request

<div class="openapi__requests">

<div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-put);margin-bottom: 12px">

<div class="openapi__request">

PUT {.openapi__method}
```text translate=no
https://api-audience.yandex.ru/v1/management/pixel/{pixelId}
```

</div>

</div>

</div>

### Path parameters

#|
|| **Name** | **Description** ||
||

_pixelId_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Идентификатор пикселя, данные которого вы хотите изменить.
{.table-cell}
||
|#{.json-schema-properties}

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "pixel": {
    "name": "example"
  }
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_pixel_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [PixelRequest](#entity-PixelRequest)

Пиксель.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "name": "example"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### PixelRequest {#entity-PixelRequest}

Пиксель.

#|
|| **Name** | **Description** ||
||

_name_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Название пикселя.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "name": "example"
}
```

{% endcut %}

</div>

## Responses

<div class="openapi__response__code__200">

## 200 OK

OK

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "pixel": {
    "id": 0,
    "name": "example",
    "create_time": "2025-01-01T00:00:00Z",
    "segments": [
      {
        "type": "example",
        "id": 0,
        "name": "example",
        "status": "example",
        "create_time": "2025-01-01T00:00:00Z",
        "owner": "example",
        "has_guests": true,
        "guest_quantity": 0,
        "can_create_dependent": true,
        "has_derivatives": true,
        "derivatives": [
          null
        ],
        "cookies_matched_quantity": 0,
        "pixel_id": 0,
        "period_length": 0,
        "times_quantity": 0,
        "times_quantity_operation": "example",
        "utm_source": "example",
        "utm_content": "example",
        "utm_campaign": "example",
        "utm_term": "example",
        "utm_medium": "example",
        "pattern": "example"
      }
    ],
    "url": "example",
    "user_quantity_7": 0,
    "user_quantity_30": 0,
    "user_quantity_90": 0
  }
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_pixel_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [Pixel](#entity-Pixel)

Пиксель.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": 0,
  "name": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "segments": [
    {
      "type": "example",
      "id": 0,
      "name": "example",
      "status": "example",
      "create_time": "2025-01-01T00:00:00Z",
      "owner": "example",
      "has_guests": true,
      "guest_quantity": 0,
      "can_create_dependent": true,
      "has_derivatives": true,
      "derivatives": [
        0
      ],
      "cookies_matched_quantity": 0,
      "pixel_id": 0,
      "period_length": 0,
      "times_quantity": 0,
      "times_quantity_operation": "example",
      "utm_source": "example",
      "utm_content": "example",
      "utm_campaign": "example",
      "utm_term": "example",
      "utm_medium": "example",
      "pattern": "example"
    }
  ],
  "url": "example",
  "user_quantity_7": 0,
  "user_quantity_30": 0,
  "user_quantity_90": 0
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### BaseSegment {#entity-BaseSegment}

Тип для описания сегмента.

#|
|| **Name** | **Description** ||
||

_name_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Название сегмента.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_create_time_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string&lt;date-time&gt;

Время создания сегмента.

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
||

_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
{.table-cell}
||
||

_owner_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Логин владельца сегмента.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_status_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Статус обработки сегмента. Допустимые значения:

- `uploaded` — сегмент с данными пользователя загружен.
- `is_processed` — сегмент с заданными параметрами обрабатывается.
- `processed` — загрузка и обработка сегмента завершена. Сегмент готов для работы.
- `processing_failed` — обработка сегмента завершилась с ошибкой.
- `is_updated` — сегмент обновляется.
- `few_data` — сегмент содержит мало данных для работы.


_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_type_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Тип сегмента. Допустимые значения:

- `uploading` — сегмент, созданный из файла с пользовательскими данными.
- `metrika` — сегмент, импортируемый из Яндекс Метрики.
- `appmetrica` — сегмент, импортируемый из AppMetrica.
- `lookalike` — сегмент из пользователей, «похожих» на другой сегмент клиента (технология Look-alike).
- `geo` — сегмент на основе данных о геолокации по полигонам и по окружностям.
- `pixel` — сегмент, созданный по пикселю.


_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### PixelSegment {#entity-PixelSegment}

Сегмент, созданный по пикселю.

{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}

- **Type**: [BaseSegment](#entity-BaseSegment)

  Тип для описания сегмента.

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "type": "example",
    "id": 0,
    "name": "example",
    "status": "example",
    "create_time": "2025-01-01T00:00:00Z",
    "owner": "example",
    "has_guests": true,
    "guest_quantity": 0,
    "can_create_dependent": true,
    "has_derivatives": true,
    "derivatives": [
      0
    ],
    "cookies_matched_quantity": 0
  }
  ```

  {% endcut %}

- {% cut "**Type**: object" %}

  #|
  ||

  _period_length_{.json-schema-reset .json-schema-property}
  {.table-cell}|
  **Type**: integer

  Период, за время которого пользователь был замечен пикселем. Допустимые значения (в сутках): от 1 до 90 (включительно).
  {.table-cell}
  ||
  ||

  _pixel_id_{.json-schema-reset .json-schema-property}
  {.table-cell}|
  **Type**: integer

  Идентификатор пикселя.
  {.table-cell}
  ||
  ||

  _times_quantity_{.json-schema-reset .json-schema-property}
  {.table-cell}|
  **Type**: integer

  Пороговое значение (M). С этим значением сравнивается количество раз, когда пользователь был замечен пикселем за период.
  {.table-cell}
  ||
  ||

  _times_quantity_operation_{.json-schema-reset .json-schema-property}
  {.table-cell}|
  **Type**: string

  Условие попадания пользователей в сегмент из пикселя. Допустимые значения:

  - `lt` — меньше. Пользователь был замечен пикселем меньше, чем M раз за период.
  - `eq` — равно. Пользователь был замечен пикселем M раз за период.
  - `gt` — больше. Пользователь был замечен пикселем больше, чем M раз за период.


  _Example:_{.json-schema-reset .json-schema-example} `example`
  {.table-cell}
  ||
  ||

  _utm_campaign_{.json-schema-reset .json-schema-property}
  {.table-cell}|
  **Type**: string

  Метка `utm_campaign`. Может использоваться как условие попадания пользователей в сегмент из пикселя.

  _Example:_{.json-schema-reset .json-schema-example} `example`
  {.table-cell}
  ||
  ||

  _utm_content_{.json-schema-reset .json-schema-property}
  {.table-cell}|
  **Type**: string

  Метка `utm_content`. Может использоваться как условие попадания пользователей в сегмент из пикселя.

  _Example:_{.json-schema-reset .json-schema-example} `example`
  {.table-cell}
  ||
  ||

  _utm_medium_{.json-schema-reset .json-schema-property}
  {.table-cell}|
  **Type**: string

  Метка `utm_medium`. Может использоваться как условие попадания пользователей в сегмент из пикселя.

  _Example:_{.json-schema-reset .json-schema-example} `example`
  {.table-cell}
  ||
  ||

  _utm_source_{.json-schema-reset .json-schema-property}
  {.table-cell}|
  **Type**: string

  Метка `utm_source`. Может использоваться как условие попадания пользователей в сегмент из пикселя.

  _Example:_{.json-schema-reset .json-schema-example} `example`
  {.table-cell}
  ||
  ||

  _utm_term_{.json-schema-reset .json-schema-property}
  {.table-cell}|
  **Type**: string

  Метка `utm_term`. Может использоваться как условие попадания пользователей в сегмент из пикселя.

  _Example:_{.json-schema-reset .json-schema-example} `example`
  {.table-cell}
  ||
  |#{.json-schema-properties}

  {% endcut %}

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "pixel_id": 0,
    "period_length": 0,
    "times_quantity": 0,
    "times_quantity_operation": "example",
    "utm_source": "example",
    "utm_content": "example",
    "utm_campaign": "example",
    "utm_term": "example",
    "utm_medium": "example"
  }
  ```

  {% endcut %}

{% endcut %}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0,
  "pixel_id": 0,
  "period_length": 0,
  "times_quantity": 0,
  "times_quantity_operation": "example",
  "utm_source": "example",
  "utm_content": "example",
  "utm_campaign": "example",
  "utm_term": "example",
  "utm_medium": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### Pixel {#entity-Pixel}

Пиксель.

#|
|| **Name** | **Description** ||
||

_name_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Название пикселя.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_create_time_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string&lt;date-time&gt;

Время создания пикселя.

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
||

_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Идентификатор пикселя. Укажите данный параметр при обновлении пикселя.
{.table-cell}
||
||

_segments_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [PixelSegment](#entity-PixelSegment)[]

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "type": "example",
    "id": 0,
    "name": "example",
    "status": "example",
    "create_time": "2025-01-01T00:00:00Z",
    "owner": "example",
    "has_guests": true,
    "guest_quantity": 0,
    "can_create_dependent": true,
    "has_derivatives": true,
    "derivatives": [
      0
    ],
    "cookies_matched_quantity": 0,
    "pixel_id": 0,
    "period_length": 0,
    "times_quantity": 0,
    "times_quantity_operation": "example",
    "utm_source": "example",
    "utm_content": "example",
    "utm_campaign": "example",
    "utm_term": "example",
    "utm_medium": "example",
    "pattern": "example"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_user_quantity_30_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Охват пользователей за месяц.
{.table-cell}
||
||

_user_quantity_7_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Охват пользователей за неделю.
{.table-cell}
||
||

_user_quantity_90_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Охват пользователей за 90 дней.
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": 0,
  "name": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "segments": [
    {
      "type": "example",
      "id": 0,
      "name": "example",
      "status": "example",
      "create_time": "2025-01-01T00:00:00Z",
      "owner": "example",
      "has_guests": true,
      "guest_quantity": 0,
      "can_create_dependent": true,
      "has_derivatives": true,
      "derivatives": [
        0
      ],
      "cookies_matched_quantity": 0,
      "pixel_id": 0,
      "period_length": 0,
      "times_quantity": 0,
      "times_quantity_operation": "example",
      "utm_source": "example",
      "utm_content": "example",
      "utm_campaign": "example",
      "utm_term": "example",
      "utm_medium": "example",
      "pattern": "example"
    }
  ],
  "user_quantity_7": 0,
  "user_quantity_30": 0,
  "user_quantity_90": 0
}
```

{% endcut %}

</div>

</div>

</div>

[*Deprecated]: No longer supported, please use an alternative and newer version.