Skip to main content
PATCH
/
v1
/
objects
/
{slug}
Update an object definition
curl --request PATCH \
  --url https://app.nex.ai/api/developers/v1/objects/{slug} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Project",
  "description": "Updated description"
}
'
{
  "attributes": [
    {
      "description": "<string>",
      "id": "<string>",
      "name": "<string>",
      "options": {
        "is_multi_value": true,
        "is_required": true,
        "is_unique": true,
        "is_whole_number": true,
        "select_options": [
          {
            "id": "<string>",
            "name": "<string>"
          }
        ],
        "use_raw_format": true
      },
      "slug": "<string>",
      "type": "<string>"
    }
  ],
  "created_at": "<string>",
  "description": "<string>",
  "id": "<string>",
  "name": "<string>",
  "name_plural": "<string>",
  "slug": "<string>",
  "type": "<string>"
}

Authorizations

Authorization
string
header
required

API key for authentication (format: "Bearer YOUR_API_KEY")

Path Parameters

slug
string
required

Object slug (e.g., 'person', 'company')

Body

application/json

Fields to update

name
string

New display name

name_plural
string

New plural name

description
string

New description

Response

Updated object definition

attributes
object[]
created_at
string
description
string
id
string
name
string
name_plural
string
slug
string
type
string
Last modified on March 7, 2026