v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB

Forms::Field

Create Field

Add a new field

post/forms/field_sets/{field_set_id}/fields

Path parameters

field_set_idinteger required

Request body

Example request

{
  "forms_field": {
    "forms_field": {
      "label": "MyString",
      "field_type": "MyString",
      "allow_multiple": false,
      "key": "CustomKey",
      "hidden": false
    }
  }
}

Response

Created

idinteger

Field ID

public_idstring nullable

Field public ID

field_set_idinteger

Field set ID

labelstring

Label

field_typestring nullable

Field Type

allow_multipleboolean nullable

Allow Multiple

keystring

Key

hiddenboolean nullable

Hidden

sort_orderinteger nullable

Sort order

created_atstring date-time nullable

Added

updated_atstring date-time nullable

Updated

Example response

{
  "id": 9,
  "public_id": "eQlJiT",
  "field_set_id": 10,
  "label": "MyString",
  "field_type": "MyString",
  "allow_multiple": false,
  "key": "CustomKey",
  "hidden": false,
  "sort_order": 0,
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z"
}