Добавление клиента
Для добавления клиента отправьте POST-запрос на адрес https://api.planadoapp.com/v2/clients.
organization_name$ curl --data "{\"organization\":true,\"organization_name\":\"Новый клиент\"}" \
-H "Authorization: Bearer api-key" \
https://api.planadoapp.com/v2/clients | jq
{
"client_uuid": "137ecf60-06cd-6930-bd93-46513db41965"
}
В ответ API возвращает uuid созданного клиента.
Значение organization не может быть изменено после создания клиента.
|
Схема запроса для юрлиц (организаций)
Все поля необязательны кроме organization_name и organization, которое должно быть true.
| Поле | Тип | JSON-тип | Обязательно | Может быть null |
Описание |
|---|---|---|---|---|---|
|
Булев |
Булев |
Да |
Нет |
Должно быть |
|
Строка |
Строка |
Да |
Нет |
Название юрлица. Ограничено 5000 символов |
|
Строка |
Строка |
Нет |
Нет |
|
|
Объект |
Нет |
Нет |
Адрес |
|
|
[Контакт] |
Массив |
Нет |
Нет |
Список контактов |
Схема запроса для физлиц
Все поля необязательные кроме organization, которое должно быть false. В дополнение хотя бы одно из полей first_name, last_name, middle_name должно быть непустым.
| Поле | Тип | JSON-тип | Обязательно | Может быть null |
Описание |
|---|---|---|---|---|---|
|
Булев |
Булев |
Да |
Нет |
Должно быть |
|
Строка |
Строка |
Нет |
Да |
Имя. Ограничено 50 символами |
|
Строка |
Строка |
Нет |
Да |
Фамилия. Ограничено 50 символами |
|
Строка |
Строка |
Нет |
Да |
Отчество. Ограничено 50 символами |
|
Строка |
Строка |
Нет |
Нет |
|
|
Объект |
Нет |
Нет |
Адрес |
|
|
[Контакт] |
Массив |
Нет |
Нет |
Список контактов |