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

Для добавления клиента отправьте POST-запрос на адрес https://api.planadoapp.com/v2/clients.

Создание юрлица с указанием названия в поле organization_name
$ curl --data "{\"organization\":true,\"organization_name\":\"Новый клиент\"}" \
       -H "X-Planado-API-Key:XXX" \
       https://api.planadoapp.com/v2/clients | jq
{
  "client_uuid": "137ecf60-06cd-6930-bd93-46513db41965"
}

В ответ API возвращает uuid созданного клиента.

Значение organization не может быть изменено после создания клиента.

Схема запроса для юрлиц (организаций)

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

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

ogranization

Булев

Булев

Да

Нет

Должно быть true

ogranization_name

Строка

Строка

Да

Нет

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

external_id

Строка

Строка

Нет

Нет

Внешний идентификатор

site_address

Адрес

Объект

Нет

Нет

Адрес

contacts

[Контакт]

Массив

Нет

Нет

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

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

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

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

ogranization

Булев

Булев

Да

Нет

Должно быть false

first_name

Строка

Строка

Нет

Да

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

last_name

Строка

Строка

Нет

Да

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

middle_name

Строка

Строка

Нет

Да

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

external_id

Строка

Строка

Нет

Нет

Внешний идентификатор

site_address

Адрес

Объект

Нет

Нет

Адрес

contacts

[Контакт]

Массив

Нет

Нет

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