Обновление объекта

Для обновления объекта, отправьте PATCH-запрос на адрес https://api.planadoapp.com/v2/sites/:site_id. Здесь :site_id это значение uuid или external_id (внешний идентификатор).

Обновление описания существующего объекта
$ curl --data "{\"description\":\"Задано через API\"}" \
       -X PATCH \
       -H "X-Planado-API-Key:XXX" \
       https://api.planadoapp.com/v2/sites/137ecde7-93a4-6ba0-ae92-4e71e8543c7b | jq
{
  "site_uuid": "137ecde7-93a4-6ba0-ae92-4e71e8543c7b"
}
Если вы отправите запрос на обновление со значением external_id, которого еще нет в Планадо, то в результате будет создан новый объект. Таким образом можно создавать и обновлять объекты, используя один и тот же PATCH-запрос. Единственное требование — обязательные для добавления поля должны быть всегда переданы.
Создание нового объекта через запрос на обновление. name — единственное обязательное поле, достаточно передать только его
$ curl --data "{\"name\":\"Новый объект, добавленный через PATCH-запрос\"}" \
       -X PATCH \
       -H "X-Planado-API-Key:XXX"\
       https://api.planadoapp.com/v2/sites/rv-media-933359946478696 | jq
{
  "site_uuid": "137ed01f-39ef-6960-bd93-46513db41965"
}

Схема запроса

Поле Тип JSON-тип Обязательно Может быть null Описание

name

Строка

Строка

Нет

Нет

Название объекта. Ограничено 300 символами

description

Строка

Строка

Нет

Да

Описание объекта. Ограничено 1000 символов

client

Клиент

Объект

Нет

Да

Клиент

address

Адрес

Объект

Нет

Нет

Адрес

contacts

[Контакт]

Массив

Нет

Нет

Список контактов