Создать отдел

Внимание. Сервис Яндекс Коннект больше не поддерживается. Directory API прекратит работу с 1 апреля 2023 года. С 24 марта доступность сервиса будет ограничена.

Для управления организациями, пользователями и доменами используйте сервис Яндекс 360 для бизнеса.

Документация API 360

Запрос позволяет создать новый отдел вашей организации.

Ограничение.

Запрос может быть выполнен только если:

  • приложение имеет разрешение на управление отделами;

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

Формат запроса

Чтобы создать новый отдел, используйте HTTP-запрос с методом POST. Параметры нового отдела передаются в теле запроса в формате JSON:

POST /v6/departments/
Host: https://api.directory.yandex.net
Authorization: OAuth <токен>
X-Org-ID: <идентификатор организации>
Content-Type: application/json

{
 "description": <описаниие отдела>,
 "head_id": <id руководителя отдела>,
 "label": "<рассылка отдела>",
 "name": "<название отдела>",
 "parent_id": <id родительского отдела>
}
Заголовки запроса
Host

Адрес узла, предоставляющего API:

https://api.directory.yandex.net
Authorization

OAuth-токен в формате OAuth <значение токена>, например:

OAuth 0c4181a7c2cf4521964a72ff57a34a07
X-Org-ID

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

Content-Type

Формат тела запроса. Должен иметь значение application/json.

Тело запроса

Тело запроса содержит информацию, необходимую для создания нового отдела:

Параметр Описание Тип данных
description

Описание отдела.

Строка.

head_id

Идентификатор сотрудника-руководителя отдела.

Целое число.

label

Имя почтового ящика отдела. Имя может состоять только из символов латинского алфавита, цифр, знаков минус и нижнего подчеркивания.

Например, адрес ящика с именем new-department будет new-department@<ваш-домен>.tld.

Строка.

name Текстовое название отдела, например, «Отдел разработки». Обязательный параметр.

Строка/null.

parent_id

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

Целое число.

Параметр Описание Тип данных
description

Описание отдела.

Строка.

head_id

Идентификатор сотрудника-руководителя отдела.

Целое число.

label

Имя почтового ящика отдела. Имя может состоять только из символов латинского алфавита, цифр, знаков минус и нижнего подчеркивания.

Например, адрес ящика с именем new-department будет new-department@<ваш-домен>.tld.

Строка.

name Текстовое название отдела, например, «Отдел разработки». Обязательный параметр.

Строка/null.

parent_id

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

Целое число.

Формат ответа

В случае успешного выполнения запроса API возвращает ответ с кодом 201.