Sign in
Custom fields

Edit a custom field

Requires the patient_custom_fields:write scope.

patch/v1/patient_custom_fields/{id}

Path parameters

idinteger required

Request body

field_namestring required
datatype'string' | 'number' | 'date' | 'time' | 'text' | 'selection' | 'phone' | 'email' | 'address' required
statusstring
orderinteger
extra_optionsobject

For 'selection': { choices: [...] }

Response

Updated

Changes