v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB

Objects

Update object

Updates an object's display name, emoji, color, or description. Requires a USER API key with ADMIN or OWNER role.

patch/public/v1/objects/{name}

Path parameters

namestring required

Example:deals

Request body

displayNamestring

emojistring

icon_colorstring

iconColorstring

descriptionstring

Example request

{
  "displayName": "example",
  "emoji": "example",
  "icon_color": "example",
  "iconColor": "example",
  "description": "example"
}

Response

Updated object

oktrue required

Example response

{
  "ok": true,
  "data": {
    "id": 1,
    "name": "example",
    "display_name": "example",
    "type": "table",
    "created_at": "example",
    "updated_at": "example",
    "description": "example",
    "emoji": "example",
    "icon_color": "example",
    "field_count": 1
  }
}