POST a Custom Field

POST /user-api/v1/custom-fields

Headers

HeaderValue
Content-Typeapplication/json
x-rolodex-api-keyf1e2d3c4b5a697...

Required Fields

name
string

Field name (1-50 characters)

field_type
string

Field type: SINGLE_LINE_TEXT, USER, SINGLE_SELECT, MULTI_SELECT, DATE, NUMERIC, BOOLEAN

entity_type
string

Entity type: CONTACT, COMPANY

Optional Fields

multi_select_options
array

Options for SINGLE_SELECT and MULTI_SELECT field types (1-50 characters each)

Request (Text Field)

{
  "name": "Department",
  "field_type": "SINGLE_LINE_TEXT",
  "entity_type": "CONTACT"
}

Request (Single Select Field)

{
  "name": "Priority Level",
  "field_type": "SINGLE_SELECT",
  "entity_type": "CONTACT",
  "multi_select_options": [
    "High",
    "Medium",
    "Low",
    {
      "value": "Critical"
    }
  ]
}

Request (Multi Select Field)

{
  "name": "Technologies",
  "field_type": "MULTI_SELECT",
  "entity_type": "COMPANY",
  "multi_select_options": [
    "JavaScript",
    "Python",
    "React",
    "Node.js",
    {
      "value": "TypeScript"
    }
  ]
}

Response (Single Select Field)

{
  "data": {
    "id": "field_99999",
    "name": "Priority Level",
    "field_type": "SINGLE_SELECT",
    "entity_type": "CONTACT",
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T10:30:00Z",
    "multi_select_options": [
      {
        "id": "option_301",
        "value": "Critical"
      },
      {
        "id": "option_302",
        "value": "High"
      },
      {
        "id": "option_303",
        "value": "Low"
      },
      {
        "id": "option_304",
        "value": "Medium"
      }
    ]
  }
}

Response (Text Field)

{
  "data": {
    "id": "field_88888",
    "name": "Department",
    "field_type": "SINGLE_LINE_TEXT",
    "entity_type": "CONTACT",
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T10:30:00Z"
  }
}

Field Types

TypeDescriptionExample Usage
SINGLE_LINE_TEXTSingle line text inputDepartment, Job Title
USERReference to workspace userAccount Manager, Sales Rep
SINGLE_SELECTSingle choice from optionsPriority Level, Status
MULTI_SELECTMultiple choices from optionsSkills, Technologies
DATEDate pickerStart Date, Follow-up Date
NUMERICNumber inputLead Score, Revenue
BOOLEANTrue/false checkboxIs VIP, Active Status

Entity Types

TypeDescription
CONTACTCustom fields for contacts/people
COMPANYCustom fields for companies/organizations