Update an object definition

PUT/api/objects/definitions/{id}

Updates the metadata and field configuration for an object definition.

Path Parameters

id*string

Resource identifier.

Example"objdef_123"

Request Body

application/json

Request payload for Update an object definition.

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Display name for the object.

Example"Projects"

description*|

Short description of the object.

data*unknown

Arbitrary JSON payload stored for the resource.

Response Body

`application/json`

curl -X PUT "https://example.com/api/objects/definitions/objdef_123" \  -H "Content-Type: application/json" \  -d '{    "name": "Projects",    "description": "Projects tracked by the sales team.",    "data": null  }'

{  "success": true}

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

{  "_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 an object definition

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`