Update site

To update a site send a PATCH request to https://api.planadoapp.com/v2/sites/:site_id. Here :site_id is the uuid or the external_id value of the site.

Updating description of an existing site
$ curl --data "{\"description\":\"Set via API\"}" \
       -X PATCH \
       -H "X-Planado-API-Key:XXX" \
       https://api.planadoapp.com/v2/sites/137ecde7-93a4-6ba0-ae92-4e71e8543c7b | jq
{
  "site_uuid": "137ecde7-93a4-6ba0-ae92-4e71e8543c7b"
}
If you send an update with an external_id value that is not present in Planado yet then a new site will be created. This way you can use PATCH requests for both adding and creating sites.
Creating a new site with a PATCH request
$ curl --data "{\"name\":\"New site via PATCH\"}" \
       -X PATCH \
       -H "X-Planado-API-Key:XXX"\
       https://api.planadoapp.com/v2/sites/rv-media-933359946478696 | jq
{
  "site_uuid": "137ed01f-39ef-6960-bd93-46513db41965"
}

Request schema

Field Type JSON type Required Can be null Description

name

String

String

No

No

Site name. Limited to 300 characters

description

String

String

No

Yes

Text describing the site. Limited 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