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

uuidstring uuid

Unique identifier for this record

active0 | 1

Record active/deleted flag. Valid values are [0,1]

edit_datestring

Timestamp at which record was last modified

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.

Example request

{
  "uuid": "123e4567-4839-4c1b-b5c8-2329bc0989bb",
  "edit_date": "2025-08-01 12:00:00",
  "form_uuid": "123e4567-5996-45d9-9804-2329ba56fcdb"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes