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

Изменяет название, адрес или город для офиса организации.

Примечание

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

Запрос

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

Path-параметры

Имя параметра

Тип

Описание

org_id *

integer

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

office_id *

string

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

Заголовки

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

Тело

Имя параметра

Тип

Описание

name

string

Название офиса.

address

string

Адрес офиса.

city

string

Город, в котором расположен офис.

Пример

Пример запроса
curl --request PATCH \
  --url https://cloud-api.yandex.net/v1/directory/organizations/167730/offices/c3e9a742-16bd-4f58-a201-8d4f7b1e2c93 \
  --header 'authorization: OAuth <токен>' \
  --header 'content-type: application/json' \
  --data '{
  "name": "Центральный офис",
  "address": "394018, ул. Липовая, 44",
  "city": "Верхнеуральск"
}'

Ответ

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

Результатом корректного запроса является ответ с кодом 204 без тела.

204 No Content — офис успешно обновлен.

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

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

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