Headers

Header name Description
Content-Type
required
application/json
X-API-KEY
required
YOUR_API_KEY

Params

Param name Description
field_group_id
required

Field group ID

Validations:

  • Must be a String

name
required

Fields name

Validations:

  • Must be a String

field_type
required

Fields type

Validations:

  • Must be one of: date, textbox, textarea, rich_text, dropdown, boolean, datetime, integer.

dropdown_options
optional

Dropdown fields options

Validations:

  • Must be an array of Hash

searchable
optional

Is field searchable

Validations:

  • Must be one of: true, false.

read_only
optional

Is field read only

Validations:

  • Must be one of: true, false.

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters