latestOpenAPI 3.1.02026-08-1667114116.2 KB

2590aa53fcf2

Custom Fields

Update custom field

Updates custom field

post/v1/custom-fields/{id}

Path parameters

idstring uuid required

Request body

keystring nullable

companyIdstring uuid nullable

displayNamestring nullable

descriptionstring nullable

category'account' | 'customer' | 'ticket'

fieldMetadatastring[] nullable

dynamicFieldMetadataobject nullable

type'Text' | 'Number' | 'Decimal' | 'Boolean' | 'Date' | 'List' | 'MultiSelect' | 'Agent' | 'Customer' | 'Ticket' | 'Account' | 'URL' | 'Address' | 'DynamicList' | 'DynamicMultiSelect'

requiredboolean nullable

editableByEditableBy[] nullable

activeboolean nullable

dependsOnstring[] nullable

Response

Successful Response

updatedAtstring date-time nullable

createdAtstring date-time nullable

keystring nullable

companyIdstring uuid nullable

displayNamestring nullable

descriptionstring nullable

category'account' | 'customer' | 'ticket'

fieldMetadatastring[] nullable

dynamicFieldMetadataobject nullable

type'Text' | 'Number' | 'Decimal' | 'Boolean' | 'Date' | 'List' | 'MultiSelect' | 'Agent' | 'Customer' | 'Ticket' | 'Account' | 'URL' | 'Address' | 'DynamicList' | 'DynamicMultiSelect'

requiredboolean nullable

editableByEditableBy[] nullable

activeboolean nullable

dependsOnstring[] nullable

idstring uuid nullable