Update Custom Fields

Update an existing custom field. Changing its options does not clear the values already assigned to users.

Authentication

Api-Keystring

API key of the organization. Always sent together with the Secret-Access header.

Path parameters

idintegerRequired
organization_slugstringRequired

Headers

Secret-AccessstringRequired

Query parameters

versionstringOptionalDefaults to 1

Request

This endpoint expects an object.
namestringRequired
descriptionstringRequired
typeenumRequired
An enumeration.
can_editbooleanRequired
is_mandatorybooleanRequired
is_visiblebooleanRequired
max_lengthintegerOptional
where_mandatoryenumOptional
An enumeration.
custom_field_choiceslist of objectsOptional

Response

Successful Response

Errors

422
Unprocessable Entity Error