Создать офис организации

Создает новый офис организации.

Примечание

Чтобы выполнить запрос, приложению требуется разрешение directory:write_offices — просмотр и изменение данных офисов.

Запрос

POST https://cloud-api.yandex.net/v1/directory/organizations/{org_id}/offices

Path-параметры

Имя параметра	Тип	Описание
org_id *	integer	Идентификатор организации.

Заголовки

Authorization: OAuth <токен>
Content-Type: application/json

Тело

Имя параметра	Тип	Описание
name	string	Название офиса.
address	string	Адрес офиса.
city	string	Город, в котором расположен офис.

Пример

Пример запроса

curl --request POST \
  --url https://cloud-api.yandex.net/v1/directory/organizations/167730/offices \
  --header 'authorization: OAuth <токен>' \
  --header 'content-type: application/json' \
  --data '{
  "name": "Головной офис",
  "address": "115088, ул. Янтарная, 12, стр. 3",
  "city": "Соснополь"
}'

Ответ

Успешный ответ

Результатом корректного запроса является ответ с кодом 201 и телом в формате JSON, где содержится идентификатор созданного офиса.

201 Created — офис успешно создан.

Поле	Тип	Описание
id	string	Идентификатор созданного офиса.

Пример

Пример ответа

{
  "id": "c3e9a742-16bd-4f58-a201-8d4f7b1e2c93"
}

Неуспешный ответ

Ошибки могут быть со следующими HTTP-статусами:

400 Bad Request — параметры запроса не заданы или заданы неверно;
401 Unauthorized — пользователь не авторизован;
403 Forbidden — у пользователя или приложения нет прав на создание офиса;
404 Not Found — запрашиваемая организация не найдена;
409 Conflict — достигнуто максимальное количество офисов в организации;
415 Unsupported Media Type — ошибка в теле запроса;
422 Unprocessable Entity — переданы некорректные данные (например, неверное значение поля);
500 Internal Server Error — ошибка произошла на стороне сервера (в этом случае попробуйте повторно отправить запрос через некоторое время).

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

Получить список офисов

Изменить параметры офиса