The following endpoints let you update or delete a custom field..
- Deleting a custom field will also delete all its arms and options.
- To delete a specific arm, see updating a custom field arm.
- To delete individual options from an arm, see updating options for a custom field arm.
| Name | Endpoint | Details |
|---|---|---|
| Update custom field | PUT /v3/companies/{companyId}/custom-fields/{customFieldId} | Update the name, description, or other top level properties of a custom field. URL path requires: companyId and customFieldId retrieved from the listing custom fields workflow.Request body requires: the full custom field object, including the id, which must match the customFieldId in the path, and the name. Since this is a full replacement rather than a partial update, send every optional property you want to keep in the API call. |
| Delete custom field | DELETE /v3/companies/{companyId}/custom-fields/{customFieldId} | Delete a custom field permanently. URL path requires: companyId and customFieldId retrieved from the listing custom fields workflow.Response will contain: a 200 status code indicating the custom field was deleted.Note: Deleting a custom field also removes all of its arms and their options. To stop a custom field from being used without deleting it, set enabled to false using the update custom field status endpoint instead. |