Custom Fields
Custom fields let you extend contacts, companies, and projects with your own data. Define text, number, date, boolean, or dropdown fields and use them across your CRM.
The Custom Field Object
Section titled “The Custom Field Object”| Field | Type | Description |
|---|---|---|
id | uuid | |
account_id | uuid | |
entity_type | string | |
label | string | |
field_type | string | |
options | object | |
required | bool | |
display_order | int | |
created_at | datetime |
Create a custom field definition
Section titled “Create a custom field definition”Endpoint: custom-fields-create
| Field | Type | Required | Description |
|---|---|---|---|
entity_type | string | Yes | |
label | string | Yes | |
field_type | string | Yes | |
options | object | No | |
required | bool | No | |
display_order | int | No |
curl -X POST https://api.driftwoodapp.com/api/custom-fields-create \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"entity_type": "...", "label": "...", "field_type": "..."}'Delete a custom field definition
Section titled “Delete a custom field definition”Endpoint: custom-fields-delete
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes |
curl -X POST https://api.driftwoodapp.com/api/custom-fields-delete \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"id": "..."}'Get a custom field definition by ID
Section titled “Get a custom field definition by ID”Endpoint: custom-fields-get
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes |
curl -X POST https://api.driftwoodapp.com/api/custom-fields-get \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"id": "..."}'List custom field definitions
Section titled “List custom field definitions”Endpoint: custom-fields-list
| Field | Type | Required | Description |
|---|---|---|---|
entity_type | string | No |
curl -X POST https://api.driftwoodapp.com/api/custom-fields-list \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{}'Update a custom field definition
Section titled “Update a custom field definition”Endpoint: custom-fields-update
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
label | string? | No | |
options | object? | No | |
required | bool? | No | |
display_order | int? | No |
curl -X POST https://api.driftwoodapp.com/api/custom-fields-update \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"id": "..."}'