Schema

Create an object definition

Changed on

Creates a new object definition (entity type) in the workspace

post/v1/objects

Request

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

Request body

namestring required

Display name for the object

name_pluralstring

Plural display name

slugstring required

URL-safe identifier

descriptionstring

Description of the object type

type'person' | 'company' | 'custom' | 'deal'

Object type

Example request

{
  "name": "Project",
  "name_plural": "Projects",
  "slug": "project",
  "description": "Project tracker",
  "type": "custom"
}

Response

Created object definition

created_atstring
descriptionstring
idstring
namestring
name_pluralstring
slugstring
typestring

Changes