Update a custom object record by handle and id

PATCH/api/objects/by-handle/{objectHandle}/records/{id}

Updates an object record using the object handle and record id.

Path Parameters

objectHandle*string

Object handle used to identify the object definition.

Example"projects"

id*string

Resource identifier.

Example"objrec_123"

Request Body

application/json

Request payload for Update a custom object record by handle and id.

data*object

Dynamic JSON object keyed by field handle.

Example

{
  "name": "Acme",
  "stage": "lead"
}

[key: string]?never

Response Body

`application/json`

curl -X PATCH "https://loading/api/objects/by-handle/projects/records/objrec_123" \  -H "Content-Type: application/json" \  -d '{    "data": {      "name": "Acme",      "stage": "lead"    }  }'

{
  "id": "objrec_123",
  "updatedAt": "2026-03-10T12:05:00.000Z"
}

{
  "_tag": "ApiBadRequestError",
  "code": "PRICE_IMPORT_DUPLICATE_SKUS",
  "message": "The request payload is invalid.",
  "description": "Remove duplicate SKU rows before importing the file.",
  "details": {}
}

{
  "_tag": "Unauthorized"
}

{
  "_tag": "ApiForbiddenError",
  "message": "You do not have permission to perform this action."
}

{
  "_tag": "ApiNotFoundError",
  "message": "The requested resource was not found."
}

{
  "_tag": "ApiConflictError",
  "message": "A resource with this handle already exists."
}

{
  "_tag": "ApiUnprocessableEntityError",
  "message": "The order cannot be submitted without items."
}

{
  "_tag": "ServiceUnavailable"
}

{
  "_tag": "ApiTimeoutError",
  "message": "The upstream operation timed out."
}

Update a custom object record by handle and id

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`