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


# POST/{resource-id}

Adds a new object to the specified resource.

## Request format {#input}

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

#|
|| **Parameter** | **Description** ||
|| `resource-id`
| ID of the resource to add a new object to.
||
|#


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

## JSON

```json
{
  "data": 
    {
      "type": "{string}",
      "attributes": {
        "brands": [
          {
            "bid": "{string}",
            "blocked": {boolean},
            "cpm": {integer}
          },
          {
            ...
          }
        ],
        "client_id": {integer},
        "email": "{string}",
        "excluded_domains": ["{string}"],
        "excluded_phones": ["{string}"],
        "geo": [
          {
            "id": "{string}",
            "cpm": {integer}
          },
          {
            ...
          }
        ]
      }
    }
}           
```

When creating ad units via the API, make sure to explicitly specify the display ad design settings.

Example: 
```
 
"design_templates":[
  {
    "caption":"Media design",
    "type":"media",
    "design_settings":
    {
      "filterSizes":false,
      "horizontalAlign":true
    }
  }
],

```

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

- **data** [*](*Required) Object with parameters.

  - **type** [*](*Required) Resource type.

  - **attributes** [*](*Required) 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 %}

    - **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).

\* Required parameter

<!--
<tree ><tree-item required="yes"><tree-itemname >data</tree-itemname><tree-itemdesc > Объект с параметрами. </tree-itemdesc><tree-item required="yes" id="type-patch"><tree-itemname >type</tree-itemname><tree-itemdesc > Тип ресурса. </tree-itemdesc></tree-item><tree-item 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 ><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-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": {
      },
      "links": {
        "self": "{string}"
      }
  },
  "links": {
    "first": "{string}",
    "next": "{string}",
    "prev": "{string}",
    "self": "{string}",
    "last": "{string}"
  }
}        
```

## Response parameters {#spec-output}

- **data** Information about the created 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.

  - **attributes** Array of object parameters. The list of parameters depends on the resource type. As an example, some of the parameters are shown below.

    - **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`).

    - **client_id** Client ID.

    - **editable_fields** Parameters of the current object that can be edited.

    - **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.

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

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


<!--
<tree ><tree-item ><tree-itemname >data</tree-itemname><tree-itemdesc >Информация о созданном объекте.</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 id="id-data"><tree-itemname >id</tree-itemname><tree-itemdesc > Идентификатор объекта. </tree-itemdesc></tree-item><tree-item id="attributes-def"><tree-itemname >attributes</tree-itemname><tree-itemdesc > Массив параметров объекта. Список параметров зависит от типа ресурса. Ниже, для примера, приведена часть параметров.</tree-itemdesc><tree-item ><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-item ><tree-itemname >client_id</tree-itemname><tree-itemdesc > Идентификатор клиента. </tree-itemdesc></tree-item><tree-item ><tree-itemname >editable_fields</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 ><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 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-item></tree>
-->


## Example for JSON {#example-JSON}

`$PI_TOKEN` must contain the token value for the partner interface API. For example, the value can start with "a7b8e0-". Make sure also to set your value for `page_id`.


> Request:
> 
> ```
> curl -v -H "Accept: application/vnd.api+json" \
> -H "Content-Type: application/vnd.api+json" \
> -H "Authorization: token $PI_TOKEN" \
> -X POST \
> --data \
>   '{
>     "data":{
>       "type":"context_on_site_rtb",
>       "attributes":{
>         "caption":"API-created block",
>         "page_id": "636326",
>         "site_version": "mobile",
>         
>         "design_templates":[{
>             "caption":"Media design",
>             "type":"media",
>             "design_settings":{
>               "filterSizes":false,
>               "horizontalAlign":true
>             }
>           },{
>             "caption":"Standard design",
>             "type":"tga",
>             "filter_tags":["adaptive","vertical"],
>             "is_custom_format_direct": false, 
>             "design_settings":{
>               "name":"adaptive0418",
>               "limit":1
>             }                    
>           }
>         ],
>         "dsp_blocks":["300x300","300x500","300x600","336x280","100%x250"],
>         "blind":0,
>         "strategy":1
>       }
>     }
>   }' \
> 'https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb' | json_pp
> ```
> 
> Response:
> 
> ```json
> HTTP/1.1 201 Created
> Content-Length: 683
> Content-Type: application/vnd.api+json
> Date: Fri, 13 Nov 2020 11:32:18 GMT
> Location: https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-636326-3
> Strict-Transport-Security: max-age=31536000; includeSubDomains
> X-Content-Type-Options: nosniff{
>    "data" :{
>       "attributes" :{},
>       "id" : "R-A-636326-4",
>       "links" :{
>          "self" : "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-636326-4"
>       },
>       "relationships" :{
>          "context_on_site_campaign" :{
>             "links" :{
>                "related" : "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-636326-4/context_on_site_campaign",
>                "self" : "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-636326-4/relationships/context_on_site_campaign"
>             }
>          },
>          "pages" :{
>             "links" :{
>                "related" : "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-636326-4/pages",
>                "self" : "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-636326-4/relationships/pages"
>             }
>          }
>       },
>       "type" : "context_on_site_rtb"
>    }
> }
> ```


[*Required]: Required parameter