---
metadata:
  - name: generator
    content: Diplodoc Platform v5.50.3
alternate:
  - https://yandex.com/dev/partner-objects/doc/en/reference/patch-resource-id-object-id.md
  - https://yandex.com/dev/partner-objects/doc/ru/reference/patch-resource-id-object-id.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/partner-objects/doc/en/llms.txt


# PATCH/{resource-id}/{object-id}

Edits parameters of the specified object.


## Request format {#input}

```
PATCH https://jsonapi.partner2.yandex.com/vX/{resource-id}/{object-id}
```

#|
|| **Parameter** | **Description** ||
|| `resource-id`
| ID of the resource where the object is located.
||
|| `object-id`
| ID of the object that you are changing parameters for.
||
|#


## Format of the request body {#structure-in}

## JSON

```json
{
  "data":
  {
    "type": "{string}",
    "id": "{string}",
    "attributes":
    {
      "actions": {...},
      "brands": [
        {
          "bid": "{string}",
          "blocked": {boolean},
          "cpm": {integer}
        },
        {
          ...
        }
      ],
      "client_id": {integer},
      "email": "{string}",
      "excluded_domains": ["{string}"],
      "excluded_phones": ["{string}"],
      "geo": [
        {
          "id": "{string}",
          "cpm": {integer}
        },
        {
          ...
        }
      ],
      "lang": "{string}",
      "lastname": "{string}",
      "level": {integer},
      "login": "{string}",
      "midname": "{string}",
      "multistate": {integer},
      "multistate_name": "{string}",
      "name": "{string}",
      "page_id": {integer},
      "parent_id": {integer},
      "regularity": {integer},
      "roles": "{string}",
      "status": "{string}"
    }
  }
}     
```

## Parameters of the request body {#spec-in}

- **data** [*](*Обязательный_параметр) Object with parameters.

  - **ID** [*](*Обязательный_параметр) Object ID.

  - **type** [*](*Обязательный_параметр) Resource type.
  
  - **attributes** [*](*Обязательный_параметр) Object parameters.

      {% note alert "Restriction." %}

      The allowed values depend on the resource that the object belongs to. They are listed in the `editable_fields` parameter for the [GET/{resource-id}/{object-id}](https://yandex.com/dev/partner-objects/doc/en/reference/get-resource-id-object-id.md) operation. As an example, some of the parameters are shown below.

      {% endnote %}

    - **actions** Actions allowed for the current object.

    - **brands** Brands set for this object.

      - **bid** The minimum bid required for showing the brand (in rubles).

      - **blocked** The brand is blocked (`true` or `false`).

      - **cpm** The minimum CPM required for showing the brand in the current region (in rubles).

    - **client_id** Client ID.

    - **email** The client's email address.

    - **excluded_domains** Excluded domains.

    - **excluded_phones** Excluded phones.

    - **geo** Regional targeting set for this object.

      - **id** Region ID. Use the [GET/{resource-id}](https://yandex.com/dev/partner-objects/doc/en/reference/get-resource-id.md) operation to get the region.

      - **cpm** The minimum CPM required for showing the brand in the current region (in rubles).

    - **lang** Interface language.

    - **lastname** The client's last name.

    - **level** The nesting level.

    - **login** User login.

    - **midname** The user's middle name.

    - **multistate** The current status of the object.

    - **multistate_name** Text description of the object's status.

    - **name** Object name.

    - **page_id** Site ID.

    - **parent_id** ID of the parent object.

    - **regularity** Sorting order in the interface.

    - **roles**	The user's roles.

    - **status** Object status. Acceptable values:

                   - **sync** — Synchronized.

                   - **pending** — Sending.

\* Required parameter


<!--
<tree ><tree-item id="object-params" required="yes"><tree-itemname >data</tree-itemname><tree-itemdesc > Объект с параметрами. </tree-itemdesc><tree-item required="yes"><tree-itemname >id</tree-itemname><tree-itemdesc > Идентификатор объекта. </tree-itemdesc></tree-item><tree-item required="yes" id="type-patch"><tree-itemname >type</tree-itemname><tree-itemdesc > Тип ресурса. </tree-itemdesc></tree-item><tree-item id="attributes-patch" required="yes"><tree-itemname >attributes</tree-itemname><tree-itemdesc > Параметры объекта, которые необходимо изменить. 

{% note alert %}

Допустимые значения зависят от ресурса, к которому относится объект, и перечислены в параметре `editable_fields` операции [GET/{resource-id}/{object-id}](https://yandex.com/dev/partner-objects/doc/en/reference/get-resource-id-object-id.md). Ниже, для примера, приведена часть параметров.

{% endnote %}

</tree-itemdesc><tree-item id="actions"><tree-itemname >actions</tree-itemname><tree-itemdesc > Действия, допустимые для текущего объекта. </tree-itemdesc></tree-item><tree-item ><tree-itemname >brands</tree-itemname><tree-itemdesc > Бренды, установленные на текущем объекте. </tree-itemdesc><tree-item ><tree-itemname >bid</tree-itemname><tree-itemdesc > Минимальная ставка, необходимая для показа бренда (в рублях). </tree-itemdesc></tree-item><tree-item ><tree-itemname >blocked</tree-itemname><tree-itemdesc > Бренд заблокирован (`true` или `false`). </tree-itemdesc></tree-item><tree-item ><tree-itemname >cpm</tree-itemname><tree-itemdesc > Минимальный CPM, необходимый для показа бренда (в рублях). </tree-itemdesc></tree-item></tree-item><tree-item ><tree-itemname >client_id</tree-itemname><tree-itemdesc > Идентификатор клиента. </tree-itemdesc></tree-item><tree-item ><tree-itemname >email</tree-itemname><tree-itemdesc > Электронная почта клиента. </tree-itemdesc></tree-item><tree-item ><tree-itemname >excluded_domains</tree-itemname><tree-itemdesc > Исключенные домены. </tree-itemdesc></tree-item><tree-item ><tree-itemname >excluded_phones</tree-itemname><tree-itemdesc > Исключенные телефоны. </tree-itemdesc></tree-item><tree-item id="geo"><tree-itemname >geo</tree-itemname><tree-itemdesc > Региональные таргетинги, установленные на текущем объекте. </tree-itemdesc><tree-item ><tree-itemname >id</tree-itemname><tree-itemdesc id="geo-id"> Идентификатор региона. Узнать регион можно с помощью операции [GET/{resource-id}](https://yandex.com/dev/partner-objects/doc/en/reference/get-resource-id.md). </tree-itemdesc></tree-item><tree-item ><tree-itemname >cpm</tree-itemname><tree-itemdesc > Минимальный CPM, необходимый для показа в текущем регионе (в рублях). </tree-itemdesc></tree-item></tree-item><tree-item ><tree-itemname >lang</tree-itemname><tree-itemdesc > Язык интерфейса. </tree-itemdesc></tree-item><tree-item ><tree-itemname >lastname</tree-itemname><tree-itemdesc > Фамилия клиента. </tree-itemdesc></tree-item><tree-item ><tree-itemname >level</tree-itemname><tree-itemdesc > Уровень вложенности. </tree-itemdesc></tree-item><tree-item ><tree-itemname >login</tree-itemname><tree-itemdesc > Логин пользователя. </tree-itemdesc></tree-item><tree-item ><tree-itemname >midname</tree-itemname><tree-itemdesc > Отчество пользователя. </tree-itemdesc></tree-item><tree-item ><tree-itemname >multistate</tree-itemname><tree-itemdesc > Текущий статус объекта. </tree-itemdesc></tree-item><tree-item ><tree-itemname >multistate_name</tree-itemname><tree-itemdesc > Текстовое описание статуса объекта. </tree-itemdesc></tree-item><tree-item ><tree-itemname >name</tree-itemname><tree-itemdesc > Имя объекта. </tree-itemdesc></tree-item><tree-item ><tree-itemname >page_id</tree-itemname><tree-itemdesc > Идентификатор площадки. </tree-itemdesc></tree-item><tree-item ><tree-itemname >parent_id</tree-itemname><tree-itemdesc > Идентификатор родительского объекта. </tree-itemdesc></tree-item><tree-item ><tree-itemname >regularity</tree-itemname><tree-itemdesc > Порядок сортировки в интерфейсе. </tree-itemdesc></tree-item><tree-item ><tree-itemname >roles</tree-itemname><tree-itemdesc > Роли пользователя. </tree-itemdesc></tree-item><tree-item ><tree-itemname >status</tree-itemname><tree-itemdesc > Статус объекта. Допустимые значения:
- sync — синхронизирован;
- pending — отправляется.
</tree-itemdesc></tree-item></tree-item></tree-item></tree>
-->

The general structure of the response is given below. The elements may appear in a different order. The structure may contain internal parameters that are not described in the table.


## Response format {#output-structure}

## JSON

```json
{
  "data":
  {
    "relationships": {
      "{string}": {
        "links": {
          "related": "{string}",
          "self": "{string}"
        }
      },
      ...
    },
    "id": "{string}",
    "type": "{string}",
    "attributes": {
      "actions": {...},
      "brands": [
        {
          "bid": "{string}",
          "blocked": {boolean},
          "cpm": {integer}
        },
        {
          ...
        }
      ],
      "client_id": {integer},
      "email": "{string}",
      "excluded_domains": ["{string}"],
      "excluded_phones": ["{string}"],
      "geo": [
        {
          "id": "{string}",
          "cpm": {integer}
        },
        {
          ...
        }
      ],
      "lang": "{string}",
      "lastname": "{string}",
      "level": {integer},
      "login": "{string}",
      "midname": "{string}",
      "multistate": {integer},
      "multistate_name": "{string}",
      "name": "{string}",
      "page_id": {integer},
      "parent_id": {integer},
      "regularity": {integer},
      "roles": "{string}",
      "status": "{string}"
    }
  },
  "meta": {
    "fields": ["{string}"]
  },
  "links": {
    "self": "{string}"
  }
}       
```

## Response parameters {#spec-output}

- **data** Array with information for the specified object.

  - **relationships** Related resources and objects.

    - **links** References to objects related to the current object.

      - **related** Reference to a list of related objects with parameters.

      - **self** Reference to a list of related objects.

  - **id** Object ID.

  - **type** Resource type.

  - **attributes** [*](*Обязательный_параметр) Object parameters.

      {% note alert "Restriction." %}

      The allowed values depend on the resource that the object belongs to. They are listed in the `editable_fields` parameter for the [GET/{resource-id}/{object-id}](https://yandex.com/dev/partner-objects/doc/en/reference/get-resource-id-object-id.md) operation. As an example, some of the parameters are shown below.

      {% endnote %}

    - **actions** Actions allowed for the current object.

    - **brands** Brands set for this object.

      - **bid** The minimum bid required for showing the brand (in rubles).

      - **blocked** The brand is blocked (`true` or `false`).

      - **cpm** The minimum CPM required for showing the brand in the current region (in rubles).

    - **client_id** Client ID.

    - **email** The client's email address.

    - **excluded_domains** Excluded domains.

    - **excluded_phones** Excluded phones.

    - **geo** Regional targeting set for this object.

      - **id** Region ID. Use the [GET/{resource-id}](https://yandex.com/dev/partner-objects/doc/en/reference/get-resource-id.md) operation to get the region.

      - **cpm** The minimum CPM required for showing the brand in the current region (in rubles).

    - **lang** Interface language.

    - **lastname** The client's last name.

    - **level** The nesting level.

    - **login** User login.

    - **midname** The user's middle name.

    - **multistate** The current status of the object.

    - **multistate_name** Text description of the object's status.

    - **name** Object name.

    - **page_id** Site ID.

    - **parent_id** ID of the parent object.

    - **regularity** Sorting order in the interface.

    - **roles**	The user's roles.

    - **status** Object status. Acceptable values:

                   - **sync** — Synchronized.

                   - **pending** — Sending.

- **meta** This object contains meta information.

  - **fields** Changed object parameters.

- **links** Links associated with the object.

  - **self** Reference to the current object.

\* Required parameter



<!--
<tree ><tree-item ><tree-itemname >data</tree-itemname><tree-itemdesc id="data"> Массив с информацией по указанному объекту. </tree-itemdesc><tree-item id="relationships"><tree-itemname >relationships</tree-itemname><tree-itemdesc > Связанные ресурсы и объекты. </tree-itemdesc><tree-item ><tree-itemname >links</tree-itemname><tree-itemdesc > Ссылки на объекты, связанные с текущим объектом. </tree-itemdesc><tree-item ><tree-itemname >related</tree-itemname><tree-itemdesc > Ссылка на список связанных объектов с параметрами. </tree-itemdesc></tree-item><tree-item ><tree-itemname >self</tree-itemname><tree-itemdesc > Ссылка на список связанных объектов. </tree-itemdesc></tree-item></tree-item></tree-item><tree-item ><tree-itemname >id</tree-itemname><tree-itemdesc > Идентификатор объекта. </tree-itemdesc></tree-item><tree-item ><tree-itemname >type</tree-itemname><tree-itemdesc > Тип ресурса. </tree-itemdesc></tree-item><tree-item id="attributes-patch" required="yes"><tree-itemname >attributes</tree-itemname><tree-itemdesc > Параметры объекта, которые необходимо изменить. 

{% note alert %}

Допустимые значения зависят от ресурса, к которому относится объект, и перечислены в параметре `editable_fields` операции [GET/{resource-id}/{object-id}](https://yandex.com/dev/partner-objects/doc/en/reference/get-resource-id-object-id.md). Ниже, для примера, приведена часть параметров.

{% endnote %}

</tree-itemdesc><tree-item id="actions"><tree-itemname >actions</tree-itemname><tree-itemdesc > Действия, допустимые для текущего объекта. </tree-itemdesc></tree-item><tree-item ><tree-itemname >brands</tree-itemname><tree-itemdesc > Бренды, установленные на текущем объекте. </tree-itemdesc><tree-item ><tree-itemname >bid</tree-itemname><tree-itemdesc > Минимальная ставка, необходимая для показа бренда (в рублях). </tree-itemdesc></tree-item><tree-item ><tree-itemname >blocked</tree-itemname><tree-itemdesc > Бренд заблокирован (`true` или `false`). </tree-itemdesc></tree-item><tree-item ><tree-itemname >cpm</tree-itemname><tree-itemdesc > Минимальный CPM, необходимый для показа бренда (в рублях). </tree-itemdesc></tree-item></tree-item><tree-item ><tree-itemname >client_id</tree-itemname><tree-itemdesc > Идентификатор клиента. </tree-itemdesc></tree-item><tree-item ><tree-itemname >email</tree-itemname><tree-itemdesc > Электронная почта клиента. </tree-itemdesc></tree-item><tree-item ><tree-itemname >excluded_domains</tree-itemname><tree-itemdesc > Исключенные домены. </tree-itemdesc></tree-item><tree-item ><tree-itemname >excluded_phones</tree-itemname><tree-itemdesc > Исключенные телефоны. </tree-itemdesc></tree-item><tree-item id="geo"><tree-itemname >geo</tree-itemname><tree-itemdesc > Региональные таргетинги, установленные на текущем объекте. </tree-itemdesc><tree-item ><tree-itemname >id</tree-itemname><tree-itemdesc id="geo-id"> Идентификатор региона. Узнать регион можно с помощью операции [GET/{resource-id}](https://yandex.com/dev/partner-objects/doc/en/reference/get-resource-id.md). </tree-itemdesc></tree-item><tree-item ><tree-itemname >cpm</tree-itemname><tree-itemdesc > Минимальный CPM, необходимый для показа в текущем регионе (в рублях). </tree-itemdesc></tree-item></tree-item><tree-item ><tree-itemname >lang</tree-itemname><tree-itemdesc > Язык интерфейса. </tree-itemdesc></tree-item><tree-item ><tree-itemname >lastname</tree-itemname><tree-itemdesc > Фамилия клиента. </tree-itemdesc></tree-item><tree-item ><tree-itemname >level</tree-itemname><tree-itemdesc > Уровень вложенности. </tree-itemdesc></tree-item><tree-item ><tree-itemname >login</tree-itemname><tree-itemdesc > Логин пользователя. </tree-itemdesc></tree-item><tree-item ><tree-itemname >midname</tree-itemname><tree-itemdesc > Отчество пользователя. </tree-itemdesc></tree-item><tree-item ><tree-itemname >multistate</tree-itemname><tree-itemdesc > Текущий статус объекта. </tree-itemdesc></tree-item><tree-item ><tree-itemname >multistate_name</tree-itemname><tree-itemdesc > Текстовое описание статуса объекта. </tree-itemdesc></tree-item><tree-item ><tree-itemname >name</tree-itemname><tree-itemdesc > Имя объекта. </tree-itemdesc></tree-item><tree-item ><tree-itemname >page_id</tree-itemname><tree-itemdesc > Идентификатор площадки. </tree-itemdesc></tree-item><tree-item ><tree-itemname >parent_id</tree-itemname><tree-itemdesc > Идентификатор родительского объекта. </tree-itemdesc></tree-item><tree-item ><tree-itemname >regularity</tree-itemname><tree-itemdesc > Порядок сортировки в интерфейсе. </tree-itemdesc></tree-item><tree-item ><tree-itemname >roles</tree-itemname><tree-itemdesc > Роли пользователя. </tree-itemdesc></tree-item><tree-item ><tree-itemname >status</tree-itemname><tree-itemdesc > Статус объекта. Допустимые значения:
- sync — синхронизирован;
- pending — отправляется.
</tree-itemdesc></tree-item></tree-item></tree-item><tree-item ><tree-itemname >meta</tree-itemname><tree-itemdesc > Объект содержит метаинформацию. </tree-itemdesc><tree-item ><tree-itemname >fields</tree-itemname><tree-itemdesc > Измененные параметры объекта. </tree-itemdesc></tree-item></tree-item><tree-item id="links-self"><tree-itemname >links</tree-itemname><tree-itemdesc id="links"> Ссылки, связанные с объектом. </tree-itemdesc><tree-item ><tree-itemname >self</tree-itemname><tree-itemdesc id="self"> Ссылка на текущий объект. </tree-itemdesc></tree-item></tree-item></tree>
-->


## Example for JSON {#example-JSON}

> Request:
> 
> ```
> curl -i -g -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: token 66..." -X PATCH 'https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/12' -d '{"data":{"type":"context_on_site_campaign","id":"12","attributes":{"excluded_domains":["test-domain1.ru","test-domain2.ru"]}}}'
> ```
> 
> Response:
> 
> ```json
> HTTP/1.1 200 OK
> Server: nginx/1.8.1
> Date: Tue, 17 Jan 2017 09:13:07 GMT
> Content-Type: application/vnd.api+json
> Content-Length: 1373
> Connection: keep-alive{
>   "data":{
>     "relationships":{
>       "context_on_site_adblock":{
>         "links":{
>           "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/12/context_on_site_adblock",
>           "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/12/relationships/context_on_site_adblock"
>         }
>       },
>       "blocks":{
>         "links":{
>           "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/12/blocks",
>           "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/12/relationships/blocks"
>         }
>       },
>       "context_on_site_adfox":{
>         "links":{
>           "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/12/context_on_site_adfox",
>           "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/12/relationships/context_on_site_adfox"
>         }
>       },
>       "context_on_site_rtb":{
>         "links":{
>           "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/12/context_on_site_rtb",
>           "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/12/relationships/context_on_site_rtb"
>         }
>       }
>     },
>     "id": "12",
>     "type": "context_on_site_campaign",
>     "attributes":{
>       "excluded_domains": ["test-domain1.ru","test-domain2.ru"]
>     }
>   },
>   "meta":{
>     "fields": ["excluded_domains"]
>   },
>   "links":{
>     "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_campaign/12"
>   }
> }      
> ```


[*Required]: Required parameter