Custom Fields API

Custom fields let you add tenant-specific data fields to Contacts, Accounts, Opportunities, and Conversations.

List Field Definitions


GET /api/v1/custom-fields

Scope: custom_fields:read

Query Parameters

Param	Type	Description
`object_type`	string	Filter by: `contact`, `account`, `opportunity`, `conversation`

Response


{
  "fields": [
    {
      "id": "uuid",
      "object_type": "contact",
      "field_key": "assessment_score",
      "field_label": "Assessment Score",
      "field_type": "number",
      "options": null,
      "is_required": false,
      "section": "Assessment",
      "description": "Score from AI opportunity assessment"
    }
  ]
}

Create Field Definition


POST /api/v1/custom-fields

Scope: custom_fields:write

Request Body


{
  "object_type": "contact",
  "field_label": "Assessment Score",
  "field_type": "number",
  "is_required": false,
  "section": "Assessment",
  "description": "Score from SprintmoreIQ assessment"
}

Field Types

Type	Description	Example
`text`	Single-line text	License Number
`long_text`	Multi-line text	Special Instructions
`number`	Integer or decimal	Fleet Size
`currency`	Number with $ formatting	Annual Premium
`date`	Date picker	Policy Expiry Date
`dropdown`	Single-select from options	Policy Type
`multi_select`	Multi-select from options	Coverage Types
`checkbox`	True/false toggle	Has Active Policy
`email`	Email input	Secondary Email
`phone`	Phone input	Mobile Number
`url`	URL input	LinkedIn Profile

Dropdown/Multi-Select Options

For dropdown and multi_select types, include an options array:


{
  "object_type": "contact",
  "field_label": "Policy Type",
  "field_type": "dropdown",
  "options": ["Auto", "Home", "Life", "Commercial", "Umbrella"]
}

Limits

Maximum 50 custom fields per object type per tenant
field_key is auto-generated from field_label if not provided
field_key must be unique per object type

Using Custom Fields

Once defined, custom fields can be set on contacts, accounts, and opportunities via the custom_fields JSON object:


curl -X POST https://app.scendcore.com/api/v1/contacts \
  -H "Authorization: Bearer sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "email": "john@acme.com",
    "custom_fields": {
      "assessment_score": 85,
      "policy_type": "Commercial"
    }
  }'