Edit custom field
Updates an existing custom field.
The custom field type cannot be changed and is therefore not part of the request body.
For SINGLE_SELECT and MULTI_SELECT fields, options are managed through dedicated lists in the request body:
addOptions adds new options by value, removeOptions removes existing options by UID, deprecateOptions marks existing options as deprecated by UID, and undeprecateOptions reverts deprecated options by UID.
Authorizations
Get a token from auth/login endpoint and then pass it in the Authorization HTTP header in every subsequent API call. For more information visit our help center.
Path Parameters
Unique identifier of the custom field
Body
Custom field data to update
Entity (project or job) the custom field can be assigned to. Currently exactly one entity must be supplied
PROJECT, JOB Name of the custom field, at most 255 characters
255Option values to add to the field (SINGLE_SELECT and MULTI_SELECT only)
Options to deprecate, referenced by UID
Description of the custom field, at most 500 characters
500Options to remove from the field, referenced by UID
Whether the custom field must be filled in for its allowed entities
Previously deprecated options to reactivate, referenced by UID
Response
OK
Entities (project or job) the custom field can be assigned to
PROJECT, JOB Date and time the custom field was created
Description of the custom field
Date and time the custom field was last modified
Name of the custom field
Whether the custom field must be filled in for its allowed entities
Date and time from which the custom field is required; null when the field is not required
Type of the custom field
MULTI_SELECT, SINGLE_SELECT, STRING, NUMBER, URL, DATE Unique identifier of the custom field used in API paths