Create site

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

Creating a site with only name filled
$ curl --data "{\"name\":\"New site\"}" -H "X-Planado-API-Key:XXX" https://api.planadoapp.com/v2/sites | jq
{
  "site_uuid": "137ecde7-93a4-6ba0-ae92-4e71e8543c7b"
}

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

You can use update requests for both creating and updating sites. In this case, external_id values must be filled.

Request schema

All fields are optional except for name.

Field Type JSON type Required Can be null Description

name

String

String

Yes

No

Site name. Up to 300 characters

external_id

String

String

No

Yes

External ID

description

String

String

No

Yes

Text describing the site. Up to 1000 characters

client

Client

Object

No

Yes

Reference to a client

address

Address

Object

No

No

Address fields

contacts

[Contact]

Array

No

No

List of contacts