Изменить параметры подразделения

Изменяет информацию о подразделении. Изменяются значения только тех параметров, которые были переданы в запросе.

Примечание

Требуется разрешение на изменение данных о подразделениях.

Request

PATCH

https://api360.yandex.net/directory/v1/org/{orgId}/departments/{departmentId}

Path parameters

Name

Description

departmentId*

Type: integer<int64>

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

orgId*

Type: integer<int64>

Идентификатор организации.

Body

application/json
{
    "name": "string",
    "parentId": 0,
    "description": "string",
    "externalId": "string",
    "label": "string",
    "headId": "string"
}

Name

Description

description

Type: string

Описание подразделения.

externalId

Type: string

Произвольный внешний идентификатор подразделения.

headId

Type: string<uint64>

Идентификатор сотрудника — руководителя подразделения.Чтобы удалить руководителя, укажите 0.

label

Type: string

Имя почтовой рассылки подразделения. Например, для адреса new-department@ваш-домен.ru имя почтовой рассылки — это new-department.

name

Type: string

Название подразделения.

parentId

Type: integer<int64>

Идентификатор родительского подразделения.

Responses

200 OK

Запрос успешно выполнен.

Body

application/json
{
    "id": 0,
    "name": "string",
    "parentId": 0,
    "description": "string",
    "createdAt": "2022-12-29T18:02:01Z",
    "externalId": "string",
    "label": "string",
    "email": "string",
    "headId": "string",
    "membersCount": 0,
    "aliases": [
        "string"
    ]
}

Name

Description

aliases

Type: string[]

Алиасы почтовых рассылок.

createdAt

Type: string<date-time>

Дата и время создания подразделения.

description

Type: string

Описание подразделения.

email

Type: string

Адрес почтовой рассылки подразделения.

externalId

Type: string

Произвольный внешний идентификатор подразделения.

headId

Type: string<uint64>

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

id

Type: integer<int64>

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

label

Type: string

Имя почтовой рассылки подразделения. Например, для адреса new-department@ваш-домен.ru имя почтовой рассылки — это new-department.

membersCount

Type: integer<int64>

Количество сотрудников подразделения с учетом вложенных подразделений.

name

Type: string

Название подразделения.

parentId

Type: integer<int64>

Идентификатор родительского подразделения.

401 Unauthorized

Пользователь не авторизован.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.

403 Forbidden

У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.

500 Internal Server Error

Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.
Предыдущая
Удалить подразделение
Следующая
Добавить подразделению алиас