Создание профиля пешего курьера

Создание профиля пешего курьера

Request

POST

https://fleet-api.taxi.yandex.net/v2/parks/contractors/walking-courier-profile

Headers

Name

Description

X-API-Key*

Type: string

API-ключ

Example: <API-ключ>

Min length: 1

X-Client-ID*

Type: string

Идентификатор клиента

Example: <Идентификатор клиента>

Min length: 1

X-Idempotency-Token*

Type: string

Токен идемпотентности запроса. Должен состоять только из печатных ASCII символов

Example: c56fa6537e5a4adbbce6ef3593210fb9

Min length: 16

Max length: 64

X-Park-ID*

Type: string

Идентификатор партнера

Example: ee6f33c4562b4e1f8646d157bd70b2c4

Body

application/json
{
    "full_name": {
        "first_name": "Ivan",
        "middle_name": "Ivanovich",
        "last_name": "Ivanov"
    },
    "phone": "+79999999999",
    "birth_date": "1970-01-01",
    "work_rule_id": "bc43tre6ba054dfdb7143ckfgvcby63e",
    "city": "Москва",
    "registration_country_code": "RU"
}

Name

Description

birth_date*

Type: string

Дата в формате ISO 8601 без временной зоны

Example: 1970-01-01

full_name*

Type: FullName

Полное имя водителя

phone*

Type: string

Номер телефона

Example: +79999999999

Pattern: ^\+\d{1,15}$

work_rule_id*

Type: string

Идентификатор условия работы

Example: bc43tre6ba054dfdb7143ckfgvcby63e

city

Type: string

Город

Example: Москва

Min length: 1

Max length: 50

registration_country_code

Type: string

Гражданство (код страны)

Example: RU

Min length: 1

Max length: 16

FullName

Полное имя водителя

Name

Description

first_name*

Type: string

Имя

Example: Ivan

last_name*

Type: string

Фамилия

Example: Ivanov

middle_name

Type: string

Отчество

Example: Ivanovich

Responses

200 OK

Создание профиля водителя

Body

application/json
{
    "contractor_profile_id": "2111ade6gk054dfdb9iu8c8cc9460mks"
}

Name

Description

contractor_profile_id*

Type: string

Идентификатор профиля водителя

Example: 2111ade6gk054dfdb9iu8c8cc9460mks

400 Bad Request

Некорректные параметры запроса

Body

application/json
{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

429 Too Many Requests

Превышено допустимое число запросов

Body

application/json
{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

500 Internal Server Error

Внутренняя ошибка сервера

Body

application/json
{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки