Sign in

v1

latestOpenAPI 3.1.02026-08-0612447737.4 KB
Custom Field

Update Custom Field

Update an existing custom field

patch/custom_field

Query parameters

selectstring

Select columns to return

idstring required

Custom field ID

created_atstring

Custom field creation date

updated_atstring

Latest update

organisation_idstring

Organisation ID

namestring

Name of custom field

descriptionstring

Custom field description

typestring

Typ of custom field

keystring

Custom field key

entitystring

Request body

idstring uuid

Custom field ID

created_atstring timestamp with time zone

Custom field creation date

updated_atstring timestamp with time zone

Latest update

organisation_idstring uuid nullable

Organisation ID

namestring text

Name of custom field

descriptionstring text nullable

Custom field description

type'string' | 'datetime' | 'boolean' | 'number' | 'date' | 'string_list' public.field_type

Typ of custom field

keystring text

Custom field key

entity'contact' | 'deal' | 'appointment' public.custom_field_entity

Response

The updated Custom Field object

idstring uuid

Custom field ID

created_atstring timestamp with time zone

Custom field creation date

updated_atstring timestamp with time zone

Latest update

organisation_idstring uuid nullable

Organisation ID

namestring text

Name of custom field

descriptionstring text nullable

Custom field description

type'string' | 'datetime' | 'boolean' | 'number' | 'date' | 'string_list' public.field_type

Typ of custom field

keystring text

Custom field key

entity'contact' | 'deal' | 'appointment' public.custom_field_entity