Skip to navigation
Developer ReferenceAPI ReferenceStyle AgentTerminology

Update Custom Field

Update a custom field. Omitted fields are left unchanged.

Returns 404 if the field does not exist in this organization.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

field_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
namestring or nullOptional<=255 characters
displaynamestring or nullOptional<=255 characters
typestring or nullOptional
locationinteger or nullOptional
isconceptlevelboolean or nullOptional
ismultilineboolean or nullOptional
isnullableboolean or nullOptional
value_range_type_idstring or nullOptionalformat: "uuid"

Response

Successful Response
field_idstringformat: "uuid"
field_uuidstring
namestring
displaynamestring
typestring
isconceptlevelboolean
ismultilineboolean
isnullableboolean
locationinteger
value_range_type_idstring or nullOptionalformat: "uuid"

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error