Загрузка данных о клиентах (JSON)

Выполняет загрузку данных о клиентах. Данные передаются как JSON в теле POST-запроса.

Пример тела запроса

--data '{
        "contacts": [
            {
                "uniq_id": "J3QQ4-H7H2V-2HCH4-M3HK8-6M8VW",
                "name": "Иванов И.",
                "create_date_time": "2020-04-17 16:12:21",
                "update_date_time": "2020-04-17 16:12:21",
                "client_ids": [
                    "12345678910",
                    "10987654321"
                ],
                "emails": [
                    "exampl1@example.com",
                    "example2@example.com"
                ],
                "phones": [
                    "78005553535",
                    "73449932378"
                ]
            },
            {
                "uniq_id": "ZYX4-H7H2V-2HCH4-M3HK8-6M8VW",
                "name": "Петрова М.",
                "create_date_time": "2020-05-17 16:13:21",
                "update_date_time": "2020-05-17 16:14:21",
                "client_ids": [
                    "11223344556"
                ]
            }
        ]
    }'

Request

POST

https://api-metrika.yandex.net/cdp/api/v1/counter/{counterId}/data/contacts/json

Path parameters

Name

Description

counterId*

Type: integer<int32>

Идентификатор счетчика, для которого вы хотите загрузить контакты.
Example: 2215573

Query parameters

Name

Description

merge_mode*

Type: string

Режим сохранения данных. При любом из значений передавайте все обязательные поля — даже те, которые не меняются.

SAVE — вся ранее переданная информация полностью заменяется новой. Подробно.
UPDATE – обновляется только та информация, которую вы загружаете в данный момент. Подробно.
APPEND — новая информация добавляется к ранее загруженной. Подробно.
Example: SAVE

Body

application/json

{
    "contacts": [
        {
            "attribute_values": [
                {}
            ],
            "uniq_id": "string",
            "name": "string",
            "birth_date": "string",
            "create_date_time": "2022-12-29T18:02:01Z",
            "update_date_time": "2022-12-29T18:02:01Z",
            "client_ids": [
                0
            ],
            "emails": [
                "string"
            ],
            "phones": [
                "string"
            ],
            "emails_md5": [
                "string"
            ],
            "phones_md5": [
                "string"
            ],
            "user_comment": "string"
        }
    ]
}

Name

Description

contacts*

Type: ContactRow[]

Список клиентов.

Min items: 1

ContactRow

Список клиентов.

Name	Description
uniq_id*	Type: string Идентификатор клиента. Min length: `1`
attribute_values	Type: object[] Пользовательские атрибуты.
birth_date	Type: string<date> Дата рождения клиента.
client_ids	Type: integer<int64>[] Список ClientID клиента. Min items: `0` Max items: `500` Unique items
create_date_time	Type: string<date-time> Дата и время создания контакта в часовом поясе счетчика. Подробно.
emails	Type: string[] Список электронных адресов клиента. Min length: `1` Min items: `0` Max items: `50` Unique items
emails_md5	Type: string[] Список электронных адресов клиента, хешированных в формате md5. Min length: `1` Min items: `0` Max items: `50` Unique items
name	Type: string Название клиента. Если вы передаете фамилию, имя и отчество, строка будет сокращена до вида `Иванов И.`.
phones	Type: string[] Список телефонных номеров клиента. Min length: `1` Min items: `0` Max items: `50` Unique items
phones_md5	Type: string[] Список телефонных номеров клиента, хешированных в формате md5. Min length: `1` Min items: `0` Max items: `50` Unique items
update_date_time	Type: string<date-time> Дата и время обновления контакта в часовом поясе счетчика. Подробно.
user_comment	Type: string Комментарий к клиенту. Min length: `0` Max length: `1000`

Responses

200 OK

Body

application/json

{
    "uploading": {
        "uploading_id": "string",
        "datetime": "2022-12-29T18:02:01Z",
        "api_validation_status": "string",
        "elements_count": 0,
        "entity_type": "string",
        "uploading_format": "string",
        "uploading_source": "string"
    }
}

Name

Description

uploading

Type: UploadingMetaExternal

Информация о загрузке

UploadingMetaExternal

Информация о загрузке

Name	Description
api_validation_status	Type: string Статус валидации загрузки: `PASSED` — валидация прошла успешно. `FAILED` — валидация прошла не успешно.
datetime	Type: string<date-time> Время загрузки.
elements_count	Type: integer<int32> Количество элементов в загрузке.
entity_type	Type: string Тип сущности: `SYSTEM` — системная сущность, например, контакты или заказы. `CUSTOM_LIST` — пользовательский список. `SYSTEM_LIST` — системный список, например товары.
uploading_format	Type: string Формат загрузки. Возможные значения: `JSON`. `CSV`.
uploading_id	Type: string Идентификатор загрузки.
uploading_source	Type: string Источник загрузки. Возможные значения: `API`.

Была ли статья полезна?

Загрузка данных о клиентах (CSV)

Формат данных о заказах