PUT a Custom Field

PUT /user-api/v1/custom-fields/:id

Headers

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

Path Parameters

id
string

Custom Field ID

Endpoint Example

PUT /user-api/v1/custom-fields/field_99999

The field_type and entity_type cannot be updated after creation. For select fields, multi_select_options are replaced entirely with the provided values.

Request

{
  "name": "Updated Priority Level",
  "multi_select_options": [
    "Urgent",
    "High",
    "Medium",
    "Low",
    {
      "value": "Deferred"
    }
  ]
}

Response

{
  "data": {
    "id": "field_99999",
    "name": "Updated Priority Level",
    "field_type": "SINGLE_SELECT",
    "entity_type": "CONTACT",
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T12:45:00Z",
    "multi_select_options": [
      {
        "id": "option_401",
        "value": "Deferred"
      },
      {
        "id": "option_402",
        "value": "High"
      },
      {
        "id": "option_403",
        "value": "Low"
      },
      {
        "id": "option_404",
        "value": "Medium"
      },
      {
        "id": "option_405",
        "value": "Urgent"
      }
    ]
  }
}

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