CAcarecycle
Custom Fields

Update a custom field definition

Change a custom field's settings, like its name or type.

put/v2/custom-fields/{id}

Request

  • Base URL
    https://api.carecycle.ai
  • URL
    https://api.carecycle.ai/v2/custom-fields/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring uuid required

Custom field definition ID

Request body

recordType'customers' | 'policies'
fieldLabelstring

Display name shown to users

fieldDescriptionstring

Description of the field's purpose

fieldType'text' | 'number' | 'boolean' | 'date' | 'select' | 'multi_select'

Type of data this field stores

isRequiredboolean nullable

Whether this field must have a value

optionsstring[] nullable

Available options for select/multi-select fields

Response

PUT /v2/custom-fields/:id Positive response

idstring uuid required
createdAtstring date-time nullable required

Custom field definition creation time. ISO 8601 timestamp

updatedAtstring date-time nullable required

Custom field definition last update time. ISO 8601 timestamp

clientIdstring uuid required
recordType'customers' | 'policies' required
fieldKeystring required

Generated identifier for the field

fieldLabelstring required

Display name shown to users

fieldDescriptionstring required

Description of the field's purpose

fieldType'text' | 'number' | 'boolean' | 'date' | 'select' | 'multi_select' required

Type of data this field stores

isRequiredboolean nullable required

Whether this field must have a value

optionsstring[] nullable required

Available options for select/multi-select fields

deletedboolean required
deletedAtstring date-time nullable required

Custom field definition deletion time. ISO 8601 timestamp

Changes

No recorded changes to this operation across all 2 revisions of this API.