Custom Fields

List custom field definitions

integer

default:"1"

Page number

integer

default:"25"

Items per page (max 250)

string

Sort field

string

default:"desc"

Sort order: asc or desc

string

Filter by entity type: contacts, companies, or deals

GET /api/v1/custom-fields

Get a custom field definition

GET /api/v1/custom-fields/:id

Create a custom field definition

POST /api/v1/custom-fields

string

required

Entity type: contacts, companies, or deals

string

required

Field name in snake_case (lowercase letters, numbers, underscores)

string

required

Human-readable display label

string

required

Field type: text, number, select, multiselect, date, or checkbox

string[]

Options for select and multiselect types

boolean

default:"false"

Whether the field is required

integer

default:"0"

Display order (lower numbers appear first)

Example

curl -X POST https://api.mossdesk.com/api/v1/custom-fields \
  -H "X-API-Key: moss_k_..." \
  -H "Content-Type: application/json" \
  -d '{
    "entity_type": "contacts",
    "field_name": "contract_tier",
    "field_label": "Contract Tier",
    "field_type": "select",
    "field_options": ["starter", "pro", "enterprise"],
    "required": true
  }'

Update a custom field definition

Field name and type cannot be changed after creation.

PATCH /api/v1/custom-fields/:id

string

Display label

string[]

Options (for select/multiselect types)

boolean

Whether the field is required

integer

Display order

Delete a custom field definition

Deletes the definition and all values across all entities.

DELETE /api/v1/custom-fields/:id

Overview

CRM Resources

Views & Search

Operations

List custom field definitions

Get a custom field definition

Create a custom field definition

Update a custom field definition

Delete a custom field definition

​List custom field definitions

​Get a custom field definition

​Create a custom field definition

​Update a custom field definition

​Delete a custom field definition

List custom field definitions

Get a custom field definition

Create a custom field definition

Update a custom field definition

Delete a custom field definition