Creating attributes

Creates attributes of customers and orders. When creating custom attributes, don't use the IDs of system attributes. You can get the list of IDs of system attributes using the GET /cdp/api/v1/counter/{counterId}/schema/attributes method.

Sample request body

--data '{
        "attributes": [
            {
                "name": "dates_of_meetings",
                "type_name": "date",
                "multivalued": true,
                "humanized": "Даты обращений в магазин"
            },
            {
                "name": "age",
                "type_name": "numeric",
                "multivalued": false,
                "humanized": "Возраст"
            },
            {
                "name": "first_seen",
                "type_name": "date",
                "multivalued": false,
                "humanized": "Первый заказ"
            }
        ]
    }'

Request

POST

https://api-metrika.yandex.net/cdp/api/v1/counter/{counterId}/schema/attributes

Path parameters

Name

Description

counterId

Type: integer

Counter ID.

Query parameters

Name

Description

entity_type

Type: string

Attribute ownership. Possible values:

CONTACT: Attributes belong to contacts.
COMPANY: Attributes belong to companies.
ORDER: Attributes belong to orders.
SIMPLE_ORDER: Attributes belong to simple orders.

Example: CONTACT

Body

application/json

{
  "attributes": [
    {
      "name": "example",
      "type_name": "example",
      "type_group": "example",
      "type_humanized": "example",
      "multivalued": true,
      "humanized": "example"
    }
  ]
}

Name

Description

attributes

Type: Attribute[]

List attributes.

Example

[
  {
    "name": "example",
    "type_name": "example",
    "type_group": "example",
    "type_humanized": "example",
    "multivalued": true,
    "humanized": "example"
  }
]

Attribute

Description of the Attribute object.

Name	Description
multivalued	Type: boolean Determines whether the attribute can have multiple values.
name	Type: string Attribute ID. Min length: `1` Max length: `255` Pattern: `^[\w-:]+$` Example: `example`
humanized	Type: string Attribute name. Min length: `0` Max length: `4096` Example: `example`
type_group	Type: string Attribute type group. Possible values: `PREDEFINED`: Scalar attribute type. Examples of `type_name` values: `numeric`, `date`, `datetime`, `email`, and `text`. `CUSTOM_LIST`: Arbitrary attribute type. `SYSTEM_LIST`: Product list, `type_name`: `product`. Example: `example`
type_humanized	Type: string Attribute type name. Example: `example`
type_name	Type: string Attribute type ID. Example: `example`

Example

{
  "name": "example",
  "type_name": "example",
  "type_group": "example",
  "type_humanized": "example",
  "multivalued": true,
  "humanized": "example"
}

Responses

200 OK

Body

application/json

{
  "success": true
}

Name

Description

success

Type: boolean

Result of performing the action.

Default: true

Was the article helpful?

Uploading orders (JSON)

Creating a product list