v6

latestOpenAPI 3.1.02026-08-047720752.5 KB

Objects

Update an object

Updates a single object. The object to be updated is identified by its object_id.

Required scopes: object_configuration:read-write.

patch/v2/objects/{object}

Path parameters

objectstring required

A UUID or slug to identify the object.

Example:people

Request body

Example request

{
  "data": {
    "api_slug": "people",
    "singular_noun": "Person",
    "plural_noun": "People"
  }
}

Response

Success

Example response

{
  "data": {
    "id": {
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
      "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795"
    },
    "api_slug": "people",
    "singular_noun": "Person",
    "plural_noun": "People",
    "created_at": "2022-11-21T13:22:49.061281000Z"
  }
}