Form Definition

Create a form definition

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

See Form Definition for the attributes and field types. name is required, and each field needs a name and type:

{
  "name": "Site Visit Checklist",
  "entities": ["contact", "project"],
  "key_definitions": [
    { "name": "Inspector notes", "type": "text" },
    { "name": "Rating", "type": "number", "default": 3 },
    { "name": "Areas checked", "type": "multiple_checkboxes", "options": ["Roof", "Basement", "Wiring"] }
  ]
}

A successful request returns 201 Created with the new definition's reference, e.g. {"location": "/v1/form_definitions/1000"}.

Body Params
string
required

Name of the form definition. Required.

string

Description.

boolean

Whether new forms can be made from this definition. Defaults to true.

entities
array of strings

The types of record the form can be added to. Replaces the current list.

entities
key_definitions
array of objects

The fields on the form (max 64), each identified by name. Sending an array replaces the fields it names and adds new ones. Send {"add": [...], "remove": [{"name": "..."}]} to add or remove specific fields.

key_definitions
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json