Update an object definition

PUT/api/unstable/objects/definitions/{id}

Updates the metadata and field configuration for an object definition.

Request Body

application/json

name*string

Display name for the object.

Example"Projects"

description*|

data*unknown

Object definition metadata, including fields and column config.

Example

{
  "titleColumn": "name",
  "fields": [
    {
      "name": "name",
      "type": "text"
    }
  ]
}

[key: string]?never

Response Body

`application/json`

curl -X PUT "https://loading/api/unstable/objects/definitions/{id}" \  -H "Content-Type: application/json" \  -d '{    "name": "Projects",    "description": "Projects tracked by the sales team.",    "data": {      "titleColumn": "name",      "fields": [        {          "name": "name",          "type": "text"        }      ]    }  }'

{
  "success": true
}

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

Empty

{
  "message": "string",
  "_tag": "ApiForbiddenError"
}

{
  "message": "string",
  "_tag": "ApiNotFoundError"
}

{
  "message": "string",
  "_tag": "ApiConflictError"
}

{
  "message": "string",
  "_tag": "ApiUnprocessableEntityError"
}

Empty

{
  "message": "string",
  "_tag": "ApiTimeoutError"
}

Update an object definition

Request Body

Response Body

200application/json

400application/json

401

403application/json

404application/json

409application/json

422application/json

503

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`