Objects

Add a form field

Adds a question to a form (on its first page). SINGLE_OPTION / MULTIPLE_OPTION fields require a non-empty values list of allowed options. Returns the updated field list.

post/forms/{id}/fields

Request

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

Path parameters

idstring required

Form ID (frm_ prefix)

Request body

labelstring required

Question label shown to respondents

dataType'TEXT' | 'LONG_TEXT' | 'EMAIL' | 'MOBILE' | 'NUMBER' | 'DATE' | 'SINGLE_OPTION' | 'MULTIPLE_OPTION' | 'FILE_PICKER' | 'SIGNATURE' | 'CURRENCY' | 'LINK' | 'RATING' | 'OPINION_SCALE' required

Field data type. SINGLE_OPTION / MULTIPLE_OPTION require values.

descriptionstring nullable

Optional help text under the question

requiredboolean

Whether an answer is required. Defaults to false.

placeholderstring nullable

Optional input placeholder

valuesstring[]

Allowed options. Required (non-empty) for SINGLE_OPTION and MULTIPLE_OPTION fields.

settingsobject

Extra config for RATING / OPINION_SCALE fields (e.g. { max: 5 }).

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.