Skip to main content
PATCH
/
sites
/
{id}
Update a site
curl --request PATCH \
  --url https://api.cula.tech/tracking/v1/sites/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Cula-Org-Id: <cula-org-id>' \
  --data '
{
  "name": "Ackerman Farms (James Jr.)"
}
'
{
  "id": "ste_01kqzcjrpyf27tge6smsbnhkh5",
  "name": "GreenCarbon Refinery",
  "coordinates": {
    "lat": 52.520008,
    "long": 13.404954
  },
  "external_id": "<string>",
  "timezone": "America/Chicago",
  "address": {
    "city": "Berlin",
    "country": "Germany",
    "country_code": "DE",
    "street": "Friedrichstrasse 1",
    "postcode": "10117"
  },
  "created_by_site": {
    "id": "<string>",
    "external_id": "<string>"
  },
  "organisation": {
    "id": "<string>",
    "external_id": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.cula.tech/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

OAuth2 client credentials flow. Exchange your client_id and client_secret for a short-lived access token, then pass it as a Bearer token in the Authorization header.

Headers

​
Cula-Org-Id
string
required

Organisation ID that scopes this request. The authenticated consumer must be authorized for this organisation. Omitting this header returns 400; passing an unauthorised org returns 403.

Path Parameters

​
id
string
required

Cula-assigned resource ID in TypeID format (e.g. stp_01kqzcjrpxf27tge33jwvjhkff). Alternatively, pass your external ID prefixed with ext- (e.g. ext-MY-STEP-001). The ext- prefix is unambiguous because TypeIDs use _ separators and never start with ext-.

Body

application/json

Partial update request for a site. Only name and external_id can be updated.

​
name
string

Display name of the site.

​
external_id
string

Partner-assigned identifier.

Response

Site updated.

​
id
string
required
Example:

"ste_01kqzcjrpyf27tge6smsbnhkh5"

​
name
string
required
Example:

"GreenCarbon Refinery"

​
coordinates
object
required

Latitude/longitude coordinates of the site.

​
external_id
string | null
​
timezone
string | null

IANA timezone identifier. Sites with created_by_site inherit the creating site's timezone when not explicitly set.

Example:

"America/Chicago"

​
address
object

Postal address of the site, if known.

​
created_by_site
object

The site that created this site record. Null for sites not created via the API.

​
organisation
object

The organisation that owns or operates this site.