Edits user

Updates user information by its ID.

Request

PATCH

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

Name

Description

company_id*

Type: integer<int64>

The ID of the company that is used in requests to the Track & Trace API.

user_id*

Type: integer<int64>

The ID of the user that is used in requests to the Track & Trace API.

application/json

{
    "login": "string",
    "role": "admin"
}

Name

Description

Type: string

User's login.

role

Type: string

Role of this user. Possible values: admin, manager, dispatcher, app.

Enum: admin, manager, dispatcher, app

Returns the updated object.

application/json

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

Name	Description
id	Type: integer User ID.
login	Type: string User's login.
role	Type: string Role of this user in the company. Possible values: yandex_staff, admin, manager, dispatcher, app. Enum: `yandex_staff`, `admin`, `manager`, `dispatcher`, `app`
role_end_time	Type: integer<int64> UNIX timestamp when the role gets revoked. Min value: `0`

Authorization failed. Send the correct OAuth token in the authorization header.

You do not have access to this object.

No object found.

Incorrect input.