Update client

To update a clientwww send a PATCH request to https://api.planadoapp.com/v2/clients/:client_id. Here :client_id is the uuid or the external_id value of the client.

Updating name of an existing organization
$ 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"
}
If you send an update with an external_id value that is not present in Planado yet, then a new client can be created. This way, you can use PATCH requests for both adding and creating clients.
Creating a new individual with a PATCH request
$ 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"
}

Request schema for organizations

All fields are optional. However, for adding a new organization, organization_name must be filled and organization must be true.

Field Type JSON type Required Can be null Description

ogranization

Boolean

Boolean

No

No

Must be true

ogranization_name

String

String

No

No

Organization name. Limited to 5000 characters

site_address

Address

Object

No

No

Address fields

contacts

[Contact]

Array

No

No

List of contacts

Request schema for individuals

All fields are optional. However, for adding a new individual, one of first_name, last_name, and middle_name must not be empty and organization must be false.

Field Type JSON type Required Can be null Description

ogranization

Boolean

Boolean

No

No

Must be false

first_name

String

String

No

Yes

First name. Up to 50 characters

last_name

String

String

No

Yes

Last name. Up to 50 characters

middle_name

String

String

No

Yes

Middle name. Up to 50 characters

site_address

Address

Object

No

No

Address fields

contacts

[Contact]

Array

No

No

List of contacts