Sign in
Form Fields

Create a new Form Field

OAuth Scope

This endpoint requires the following OAuth scope manage_forms.

Record UUID

UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the x-record-uuid response header.

post/formfield.json

Request body

form_uuidstring uuid

The UUID of the form this field belongs to.

namestring

The name of the form field.

field_data_jsonstring

JSON configuration for this question, including type, mandatory, choices and conditions.

sort_orderinteger

The sort order of the form field.

uuidstring uuid

Unique identifier for this record

Example request

{
  "form_uuid": "123e4567-ad44-428c-a7a3-23e93b32424b",
  "uuid": "123e4567-164f-459b-a57c-23e93cbeabeb"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes