Website

Create a form field.

POST

/fields

name

string

The name of the field.

type

enum

The type of field. Options include: shortText, longText, dropdown, radio, checkboxes, email, phone.

details

object

Field type specific settings.

options

array of strings

Only for checkboxes, dropdown and radio types.

searchable

boolean

Only for checkboxes, dropdown and radio types. Includes a search input with the field to help users find the option they need faster.

required

boolean

Whether or not a field must be completed when it's included on a job step.

{
  "status": "ok",
  "code": 200,
  "data": {
    "field": {
      "key": "cklhanu5o010e3h66ukt6k3f6",
      "name": "Review Status",
      "type": "dropdown",
      "details": {
        "options": [
          {
            "key": "cklhan5jm00013h65k28s3vh5",
            "label": "Approved"
          },
          {
            "key": "cklhanmsw00023h65kd8gxh06k",
            "label": "Declined"
          }
        ]
      },
      "required": true
    }
  }
}

Resources

Workflows

Users

Roles

Jobs

Form fields

Resources

Workflows

Users

Roles

Jobs

Form fields

Resources

Workflows

Users

Roles

Jobs

Form fields

Form Fields

Create a Field

Resources

Workflows

Users

Roles

Jobs

Form fields