{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Updating a custom field","meta":[{"name":"robots","content":"noindex"}],"llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"updating-a-custom-field","__idx":0},"children":["Updating a custom field"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following endpoints let you update or delete a custom field.."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Deleting a custom field will also delete all its arms and options."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To delete a specific arm, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/spotnana/custom_field_arm_update_workflow"},"children":["updating a custom field arm"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To delete individual options from an arm, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/spotnana/custom_field_options_workflow"},"children":["updating options for a custom field arm"]},"."]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"25%","data-label":"Name"},"children":["Name "]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Details"},"children":["Details"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi/customfieldapi/custom-field-v3/updatecustomfieldv3"},"children":["Update custom field"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /v3/companies/{companyId}/custom-fields/{customFieldId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update the name, description, or other top level properties of a custom field.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["URL path requires:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["companyId"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customFieldId"]}," retrieved from the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/spotnana/custom_field_list_workflow"},"children":["listing custom fields"]}," workflow.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body requires:"]}," the full custom field object, including the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", which must match the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customFieldId"]}," in the path, and the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},". Since this is a full replacement rather than a partial update, send every optional property you want to keep in the API call."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi/customfieldapi/custom-field-v3/deletecustomfieldv3"},"children":["Delete custom field"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /v3/companies/{companyId}/custom-fields/{customFieldId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete a custom field permanently.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["URL path requires:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["companyId"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customFieldId"]}," retrieved from the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/spotnana/custom_field_list_workflow"},"children":["listing custom fields"]}," workflow.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response will contain:"]}," a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," status code indicating the custom field was deleted.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["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 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enabled"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}," using the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/openapi/customfieldapi/custom-field-v3/updatecustomfieldstatus"},"children":["update custom field status"]}," endpoint instead."]}]}]}]}]}]},"headings":[{"value":"Updating a custom field","id":"updating-a-custom-field","depth":1}],"frontmatter":{"seo":{"title":"Updating a custom field"}},"lastModified":"2026-09-16T16:41:37.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/spotnana/custom_field_update_workflow","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}