Skip to main content
POST
Create a site

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. Exchange your client_id and client_secret for an access token scoped to the organisation that provides data access.

Headers

Cula-Organisation-Id
string
required

ID of the organisation the request operates on behalf of (e.g. org_...). Must be an organisation the API client has access to.

Example:

"org_01k83mfmhgchya944v86ryvhpq"

Body

application/json
name
string
required

Human-readable name for the new managed site.

Required string length: 3 - 100
address
string
required

Free-form postal address of the new site (e.g. "Friedrichstr. 1, 10117 Berlin, Germany"). The server geocodes it before saving — check the response for the persisted location.

Required string length: 3 - 200
managed_by_site
object
required

The site managing this record. Must be a site within your API key's scope and must match the managing site of the provided organisation. Reference it either by its ID or by its external ID, but not both.

organisation
object
required

The organisation this site is grouped under. Reference it either by its ID or by its external ID, but not both.

external_id
string

A optional custom ID that can be set to an internal ID from your system. This ID must be unique within all objects of the organisation you operate in. You can later use this external ID to reference and query this object. Be aware that you can update this ID later. If you need an immutable ID, use the object ID returned when creating the object.

Required string length: 1 - 100
Pattern: ^[A-Za-z0-9\-_]+$
Example:

"MY-CUSTOM-ID"

Response

Site

id
string
required
Example:

"ste_01k8g7aec6dt5zrtamc72ww446"

name
string | null
required
Example:

"Biomass Lutz"

location
object
required
deprecated

Deprecated: use coordinates and address instead.

coordinates
object
required

Latitude/longitude coordinates of the site.

address
object | null
required

Postal address of the site, if known.

organisation_id
string | null
required
deprecated

Deprecated: use organisation instead.

Example:

"org_01k83mfmhgchya944v86ryvhpq"

organisation
object | null
required

The organisation this site is grouped under.

external_id
string | null
required
Example:

"SITE-EXT-0001"

managed_by_site
object | null
required

References a site by its ID and the external ID you assigned to it (if any).