Skip to main content
PATCH
/
material-application
/
{id}
Partially update a material application step
curl --request PATCH \
  --url https://api.demo.cula.earth/tracking/v1/material-application/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Cula-Organisation-Id: <cula-organisation-id>' \
  --data '
{
  "external_id": "<string>",
  "display_key": "<string>",
  "site": {
    "id": "ste_01kqzcjrpyf27tge6smsbnhkh5"
  },
  "executed_at": "2023-11-07T05:31:56Z",
  "data_points": [
    {
      "config_id": "dpc_01kqzcjrpyf27tgey9d27c4edu",
      "input_value": {
        "value": 47079.76,
        "unit": "lbs"
      }
    }
  ],
  "file_ids": [
    "<string>"
  ],
  "input_containers": [
    {
      "data_points": [
        {
          "config_id": "dpc_01kqzcjrpyf27tgey9d27c4edu",
          "input_value": {
            "value": 47079.76,
            "unit": "lbs"
          }
        }
      ]
    }
  ]
}
'
{
  "id": "stp_01kqzcjrpxf27tge33jwvjhkff",
  "config_id": "stc_01kqzcjrpyf27tgeeekpvvx0zt",
  "config_version_id": "scv_01kqzcjrpyf27tgefhb58rc9d4",
  "site": {
    "id": "<string>",
    "external_id": "<string>"
  },
  "executed_at": "2026-05-01T19:30:00Z",
  "data_points": [
    {
      "config_id": "dpc_01kqzcjrpyf27tgey9d27c4edu",
      "config_version_id": "dpv_01kqzcjrpyf27tgeyv9d27c4edu",
      "name": "Weight net",
      "input_value": {
        "value": 47079.76,
        "unit": "lbs"
      },
      "result_value": {
        "value": 21353.12,
        "unit": "kg"
      }
    }
  ],
  "file_ids": [],
  "created_at": "2026-05-06T19:34:00Z",
  "updated_at": "2026-05-06T19:34:00Z",
  "input_containers": [
    {
      "id": "mct_01kqzcjrpyf27tgenyy2stmy5z",
      "data_points": [
        {
          "config_id": "dpc_01kqzcjrpyf27tgey9d27c4edu",
          "config_version_id": "dpv_01kqzcjrpyf27tgeyv9d27c4edu",
          "name": "Weight net",
          "input_value": {
            "value": 47079.76,
            "unit": "lbs"
          },
          "result_value": {
            "value": 21353.12,
            "unit": "kg"
          }
        }
      ],
      "contents": [
        {
          "material": {
            "id": "mat_01kqzcjrpyf27tge9dnvsqv8t2"
          },
          "weight_in_kg": 21353.12
        }
      ]
    }
  ],
  "external_id": "GC-HARVEST-2026-001",
  "display_key": "GC-HARVEST-2026-001",
  "location": {
    "lat": 46.8797,
    "long": -102.7903,
    "street": "100 Industrial Parkway",
    "city": "Richardton",
    "postcode": "58652",
    "country": "United States",
    "country_code": "US"
  }
}

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-Organisation-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

Request body for partially updating a material application step. All fields optional.

​
external_id
string

Partner-assigned identifier.

​
display_key
string

Human-readable display identifier.

​
site
object

The site where the step was executed.

Example:
{ "id": "ste_01kqzcjrpyf27tge6smsbnhkh5" }
​
location
object

Override location. Set to null to clear.

​
executed_at
string<date-time>

When the step was executed. ISO-8601 with explicit UTC offset.

​
data_points
object[]

Step-level data points.

​
file_ids
string[]

Complete replacement for the linked file array. Provide the full set of file IDs that should remain linked after the PATCH. Omit this field to leave existing file links unchanged.

​
input_containers
object[]

Input material containers.

Response

Material application step updated.

A material application step as returned in responses.

​
id
string
required

Cula-assigned TypeID.

Example:

"stp_01kqzcjrpxf27tge33jwvjhkff"

​
config_id
string
required

Root step config ID.

Example:

"stc_01kqzcjrpyf27tgeeekpvvx0zt"

​
config_version_id
string
required
read-only

Resolved config version used at creation time.

Example:

"scv_01kqzcjrpyf27tgefhb58rc9d4"

​
site
object
required

A resolved resource reference as returned in responses.

​
executed_at
string<date-time>
required

When the step was executed. Stored and returned in UTC.

Example:

"2026-05-01T19:30:00Z"

​
data_points
object[]
required

Step-level resolved data points.

​
file_ids
string[]
required

IDs of files linked to this resource.

Example:
[]
​
created_at
string<date-time>
required
read-only
Example:

"2026-05-06T19:34:00Z"

​
updated_at
string<date-time>
required
read-only
Example:

"2026-05-06T19:34:00Z"

​
input_containers
object[]
required

Input material containers with resolved data points and computed contents.

​
external_id
string | null

Partner-assigned external identifier.

Example:

"GC-HARVEST-2026-001"

​
display_key
string | null

Human-readable display identifier.

Example:

"GC-HARVEST-2026-001"

​
location
object

Override location. If the step was executed at a different physical location than the site, this field captures those coordinates. Cula attributes additional transport emissions for the distance between the site and this location.