Create client

To create a client, send a POST request to https://api.planadoapp.com/v2/clients.

Creating an organization with only organization_name filled
$ curl --data "{\"organization\":true,\"organization_name\":\"New organization\"}" \
       -H "Authorization: Bearer api-key" \
       https://api.planadoapp.com/v2/clients | jq
{
  "client_uuid": "137ecf60-06cd-6930-bd93-46513db41965"
}

In response, the API returns the uuid value of the newly created client.

organization value cannot be changed after adding a client.

Request schema for organizations

All fields are optional except for organization_name and organization which must be true.

Field Type JSON type Required Can be null Description

organization

Boolean

Boolean

Yes

No

Must be true

organization_name

String

String

Yes

No

Organization name. Limited to 5000 characters

external_id

String

String

No

No

External ID

site_address

Address

Object

No

No

Address fields

contacts

[Contact]

Array

No

No

List of contacts

territory

Territory

Object

No

Yes

Territory reference

Request schema for individuals

All fields are optional except for organization which must be false. Additionally, at least one of first_name, last_name, and middle_name must not be empty.

Field Type JSON type Required Can be null Description

organization

Boolean

Boolean

Yes

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

external_id

String

String

No

No

External ID

site_address

Address

Object

No

No

Address fields

contacts

[Contact]

Array

No

No

List of contacts

territory

Territory

Object

No

Yes

Territory reference