Edits user

Updates user information by its ID.

Request

PATCH

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

Path parameters

Name

Description

company_id*

Type: integer

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

user_id*

Type: integer

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

Body

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

Name

Description

login

Type: string

User's login.

role

Type: string

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

Responses

200 OK

Returns the updated object.

Body

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

Name

Description

id

Type: integer

User ID.

login

Type: string

User's login.

role

Type: string

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

401 Unauthorized

Deprecated

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

403 Forbidden

Deprecated

You do not have access to this object.

404 Not Found

Deprecated

No object found.

422 Unprocessable Entity

Deprecated

Incorrect input.

Previous