Update object definition

Updates name and/or description for an existing object definition identified by handle.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?|

description?|

Response Body

`application/json`

curl -X PATCH "https://loading/api/objects/{handle}" \  -H "Content-Type: application/json" \  -d '{    "name": "Customer Account",    "description": "Updated label used by downstream automations"  }'

{
  "handle": "customer",
  "name": "Customer",
  "description": "Stores customer profile metadata",
  "createdAt": "2026-03-05T15:40:00.000Z",
  "updatedAt": "2026-03-05T15:40:00.000Z",
  "deletedAt": null
}

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

Empty

Update object definition

Request Body

Response Body

200application/json

400application/json

401

403

404

500

`application/json`

`application/json`