Редактирует пользователя

Обновляет информацию о пользователе по его ID.

Request

PATCH

https://courier.yandex.ru/api/v1/companies/{company_id}/users/{user_id}

Path parameters

Name

Description

company_id*

Type: integer<int64>

ID компании, используемый в запросах к API Мониторинга.

user_id*

Type: integer<int64>

ID пользователя, используемый в запросах к API Мониторинга.

Body

application/json
{
    "login": "string",
    "role": "admin"
}

Name

Description

login

Type: string

Логин пользователя.

role

Type: string

Роль пользователя. Возможные значения: admin, manager, dispatcher, app.

Enum: admin, manager, dispatcher, app

Responses

200 OK

Возвращает обновленный объект.

Body

application/json
{
    "id": 0,
    "login": "string",
    "role": "yandex_staff",
    "role_end_time": 0
}

Name

Description

id

Type: integer

ID пользователя.

login

Type: string

Логин пользователя.

role

Type: string

Роль пользователя в данной компании. Возможные значения: yandex_staff, admin, manager, dispatcher, app.

Enum: yandex_staff, admin, manager, dispatcher, app

role_end_time

Type: integer<int64>

UNIX timestamp окончания действия роли.

Min value: 0

401 Unauthorized

Ошибка авторизации. Отправьте правильный OAuth-токен в заголовке авторизации.

403 Forbidden

У вас нет доступа к этому объекту.

404 Not Found

Объект не найден.

422 Unprocessable Entity

Неправильный ввод.