Skip to main content
POST
Create a custom CRM object

Slug rules

  • 3–60 characters, lowercase letters, numbers, hyphens, and underscores only
  • Must be unique within your workspace
  • Immutable after creation — the slug cannot be renamed
The slugs people and companies are reserved for standard objects and cannot be used.

Auto-created attributes

Every new object automatically receives three system attributes that cannot be removed: Add custom attributes to the object using POST /crm/objects/{slug}/attributes after creation.

Authorizations

Authorization
string
header
required

Body

application/json
slug
string
required

Unique identifier for the object. Must be 3–60 characters, alphanumeric with dots or hyphens. Cannot use reserved slugs (people, companies, etc.).

Required string length: 3 - 60
Pattern: ^(?=.{1,60}$)[\w]+((\.|-)[\w]+)*$
Example:

"products"

singularName
string
required

Singular display name shown in the UI.

Maximum string length: 255
Example:

"Product"

pluralName
string
required

Plural display name shown in the UI.

Maximum string length: 255
Example:

"Products"

isActive
boolean
default:true

Whether the object is enabled. Defaults to true.

Response

Created

success
boolean
Example:

true

status
integer
Example:

201

object
object

A CRM object definition including its full attribute schema.

Last modified on June 11, 2026