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

Справочник API 360

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

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

HTTP-запрос

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

Path-параметры

orgId *	integer Идентификатор организации.
departmentId *	integer Идентификатор подразделения.

* Обязательный параметр

Тело запроса

{
  "description": string,
  "externalId": string,
  "headId": string,
  "label": string,
  "name": string,
  "parentId": integer
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

description	string Описание подразделения.
externalId	string Произвольный внешний идентификатор подразделения.
headId	string Идентификатор сотрудника-руководителя подразделения. `0` что бы удалить руководителя.
label	string Имя почтовой рассылки подразделения. Например, для адреса `new-department@ваш-домен.ru` имя почтовой рассылки — это `new-department`.
name	string Название подразделения.
parentId	integer Идентификатор родительского подразделения.

* Обязательный параметр

Ответы

Код 200

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

{
  "aliases": [
    string
  ],
  "createdAt": string,
  "description": string,
  "email": string,
  "externalId": string,
  "headId": string,
  "id": integer,
  "label": string,
  "membersCount": integer,
  "name": string,
  "parentId": integer
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

aliases[]	array Алиасы почтовых рассылок.
createdAt	string Дата и время создания подразделения.
description	string Описание подразделения.
email	string Адрес почтовой рассылки подразделения.
externalId	string Произвольный внешний идентификатор подразделения.
headId	string Руководитель подразделения.
id	integer Идентификатор подразделения.
label	string Имя почтовой рассылки подразделения. Например, для адреса `new-department@ваш-домен.ru` имя почтовой рассылки — это `new-department`.
membersCount	integer Количество сотрудников подразделения с учетом вложенных подразделений.
name	string Название подразделения.
parentId	integer Идентификатор родительского подразделения.

* Обязательный параметр

Код 401

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

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

code	integer
details[]	array
details[].@type	string
message	string

* Обязательный параметр

Код 403

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

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

code	integer
details[]	array
details[].@type	string
message	string

* Обязательный параметр

Код 404

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

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

code	integer
details[]	array
details[].@type	string
message	string

* Обязательный параметр

Код 500

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

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

code	integer
details[]	array
details[].@type	string
message	string

* Обязательный параметр

Была ли статья полезна?

Расскажите, что вам не понравилось в статье:

Добавить подразделению алиас

Посмотреть информацию о подразделении

Добавить подразделению алиас

Посмотреть информацию о подразделении