Objects

Update a form field

Updates a question on a form, identified by its field key. Only provided properties are changed. For choice fields, values replaces the full list of allowed options. A field's data type cannot be changed — delete the field and add a new one to change its type.

patch/forms/{id}/fields/{key}

Request

  • Base URL: https://api.heffl.com/api/v2
  • URL: https://api.heffl.com/api/v2/forms/{id}/fields/{key}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Form ID (frm_ prefix)

keystring required

Field key (e.g. cf_full_name)

Request body

labelstring

New question label

descriptionstring nullable

New help text under the question

requiredboolean

Whether an answer is required

placeholderstring nullable

New input placeholder

valuesstring[]

Replacement list of allowed options. For SINGLE_OPTION / MULTIPLE_OPTION fields this must be non-empty; ignored for non-choice fields.

settingsobject

Replacement config for RATING / OPINION_SCALE fields

Response

OK

formIdstring required

Form ID (frm_ prefix)

formTitlestring required

Form title

Changes

No recorded changes to this operation across all 1 revision of this API.