PUT a Custom Field
PUT /user-api/v1/custom-fields/:id
| Header | Value |
|---|
Content-Type | application/json |
x-rolodex-api-key | f1e2d3c4b5a697... |
Path Parameters
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
| Type | Description | Example Usage |
|---|
SINGLE_LINE_TEXT | Single line text input | Department, Job Title |
USER | Reference to workspace user | Account Manager, Sales Rep |
SINGLE_SELECT | Single choice from options | Priority Level, Status |
MULTI_SELECT | Multiple choices from options | Skills, Technologies |
DATE | Date picker | Start Date, Follow-up Date |
NUMERIC | Number input | Lead Score, Revenue |
BOOLEAN | True/false checkbox | Is VIP, Active Status |
Entity Types
| Type | Description |
|---|
CONTACT | Custom fields for contacts/people |
COMPANY | Custom fields for companies/organizations |
