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

Field	Type	Description
id	uuid	Unique identifier of the custom field definition
account_id	uuid	ID of the account that owns this definition
entity_type	string	Record type this field attaches to One of: contact, company, project, deal
label	string	Human-readable field label shown in the UI
field_type	string	Data type of the field One of: text, number, date, boolean, enum
options	object	Allowed values as a JSON string array; non-empty for enum fields, otherwise empty
required	bool	Whether a value must be provided when saving the record
display_order	int	Sort position of the field within its entity type (ascending)
created_at	datetime	Creation timestamp (ISO 8601)

Create a custom field definition

Endpoint: custom-fields-create

Field	Type	Required	Description
entity_type	string	Yes	Record type this field attaches to One of: contact, company, project, deal
label	string	Yes	Human-readable field label shown in the UI
field_type	string	Yes	Data type of the field One of: text, number, date, boolean, enum
options	object	No	Allowed values as a JSON string array; required and non-empty for enum field_type
required	bool	No	Whether a value must be provided when saving the record
display_order	int	No	Sort position of the field within its entity type (ascending)

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

Endpoint: custom-fields-delete

Field	Type	Required	Description
id	string	Yes	ID of the custom field definition to delete

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

Endpoint: custom-fields-get

Field	Type	Required	Description
id	string	Yes	ID of the custom field definition to retrieve

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

Endpoint: custom-fields-list

Field	Type	Required	Description
entity_type	string	No	Filter definitions by record type; omit to list all One of: contact, company, project, deal

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

Endpoint: custom-fields-update

Field	Type	Required	Description
id	string	Yes	ID of the custom field definition to update
label	string?	No	New field label; omit to leave unchanged
options	object?	No	New allowed values as a JSON string array; non-empty required for enum fields. Omit to leave unchanged
required	bool?	No	Whether a value is required; omit to leave unchanged
display_order	int?	No	New sort position; omit to leave unchanged

curl -X POST https://api.driftwoodapp.com/api/custom-fields-update \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"id": "..."}'

Error Codes

Code	Description
custom_fields.invalid_entity_type	Invalid entity type
custom_fields.label_required	Label required
custom_fields.invalid_field_type	Invalid field type
custom_fields.options_required	Options required
custom_fields.invalid_id	Invalid id
custom_fields.not_found	Not found