Skip to main content
PATCH
/
v1
/
sites
/
{id}
Update a counterparty site
curl --request PATCH \
  --url https://api.cula.tech/tracking/v1/v1/sites/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Ackerman Farms (James Jr.)"
}
'
{
  "id": "ste_01kqzcjrpyf27tge6smsbnhkh5",
  "name": "GreenCarbon Refinery",
  "external_id": "<string>",
  "timezone": "America/Chicago",
  "location": {
    "lat": 46.8797,
    "long": -102.7903,
    "street": "100 Industrial Parkway",
    "city": "Richardton",
    "postcode": "58652",
    "country": "United States",
    "country_code": "US"
  },
  "owning_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

API key passed as a Bearer token. Keys are scoped to one organisation and a set of permitted sites. Two keys per scope (primary + secondary) are issued to support zero-downtime rotation.

Authorization: Bearer <api-key>

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 counterparty site. Only name and external_id can be updated.

​
name
string

Display name of the counterparty site.

​
external_id
string

Partner-assigned identifier.

Response

Site updated.

​
id
string
required
Example:

"ste_01kqzcjrpyf27tge6smsbnhkh5"

​
name
string
required
Example:

"GreenCarbon Refinery"

​
external_id
string | null
​
timezone
string | null

IANA timezone identifier. Set for registered sites, defaults to the owning site's timezone for counterparty sites.

Example:

"America/Chicago"

​
location
object

Geographic location of the site.

​
owning_site
object

The registered (Cula-managed) site that this counterparty site belongs to. Null for registered sites themselves.

​
organisation
object

The organisation that owns or operates this site.