Schema

Create an attribute definition

Changed on

Creates a new attribute definition on an object type

post/v1/objects/{slug}/attributes

Request

  • Base URL
    https://app.nex.ai/api/developers
  • Auth
    API key in header Authorization

Path parameters

slugstring required

Object slug

Request body

namestring required

Display name

slugstring required

URL-safe identifier

type'text' | 'number' | 'email' | 'phone' | 'url' | 'date' | 'boolean' | 'currency' | 'location' | 'select' | 'social_profile' | 'domain' | 'full_name' required

Attribute value type

descriptionstring

Description

Example request

{
  "name": "Status",
  "slug": "status",
  "type": "select",
  "description": "Current status",
  "options": {
    "is_required": true,
    "select_options": [
      {
        "name": "Open"
      },
      {
        "name": "In Progress"
      },
      {
        "name": "Done"
      }
    ]
  }
}

Response

Created attribute definition

descriptionstring
idstring
namestring
slugstring
typestring

Changes