Custom Fields

Update Custom Field Definition

Changed on

Requires role: Admin

patch/custom-fields/definitions/{id}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/custom-fields/definitions/{id}
  • Auth
    HTTP bearer

Request body

labelstring
requiredboolean
option_movesobject

select, multiselect and scored_select. Maps a removed option to the remaining option that should receive its answers: by id for scored_select, by option text for select and multiselect (so a renamed option maps old text to new text).

option_removalsstring[]

select, multiselect and scored_select. Removed options whose answers are deleted instead of moved (for multiselect, the option is dropped from each list; a list left empty is deleted). An option cannot be both moved and removed.

Response

Success

Changes