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

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

Обновление названия существующого юрлица
$ curl --data "{\"organization_name\":\"ACME Studio\"}" \
       -X PATCH \
       -H "X-Planado-API-Key:XXX" \
       https://api.planadoapp.com/v2/clients/137ecf60-06cd-6930-bd93-46513db41965 | jq
{
  "client_uuid": "137ecf60-06cd-6930-bd93-46513db41965"
}
Если вы отправите запрос на обновление со значением external_id, которого еще нет в Планадо, то в результате будет создан новый клиент. Таким образом можно создавать и обновлять клиентов, используя один и тот же PATCH-запрос. Единственное требование — обязательные для добавления поля должны быть всегда переданы.
Создание нового физлица через запрос на обновление
$ curl --data "{\"organization\":false,\"first_name\":\"John\",\"last_name\":\"Doe\"}" \
       -X PATCH \
       -H "X-Planado-API-Key:XXX" \
       https://api.planadoapp.com/v2/clients/rv-media-933359946478696 | jq
{
  "client_uuid": "137ed01f-39ef-6960-bd93-46513db41965"
}

Схема запроса для юрлиц

Все поля необязательны. Однако для добавления нового юрлица organization_name должно быть заполнено, а organization должно быть true.

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

ogranization

Булев

Булев

Нет

Нет

Должно быть true

ogranization_name

Строка

Строка

Да

Нет

Название юрлица. Ограничено 5000 символов

site_address

Адрес

Объект

Нет

Нет

Адрес

contacts

[Контакт]

Массив

Нет

Нет

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

Схема запроса для физлиц

Все поля необязательны. Однако для добавления нового юрлица одно из полей first_name, last_name, middle_name должно быть непустым, и organization должно быть false.

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

ogranization

Булев

Булев

Нет

Нет

Должно быть false

first_name

Строка

Строка

Нет

Да

Имя. Ограничено 50 символами

last_name

Строка

Строка

Нет

Да

Фамилия. Ограничено 50 символами

middle_name

Строка

Строка

Нет

Да

Отчество. Ограничено 50 символами

site_address

Адрес

Объект

Нет

Нет

Адрес

contacts

[Контакт]

Массив

Нет

Нет

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