Create Form

Create a new form

POST /api/v1/form

Create Form

cURL

curl --request POST \
  --url 'https://api.example.com/api/v1/form?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "trigger_instructions": "<string>",
  "form_type": "natural",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attributes": {},
  "fields": [],
  "webhook_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "trigger_tools": [],
  "contact_mapping": {}
}
'

201

{
  "message": "Data created successfully",
  "meta": {},
  "data": {
    "name": "<string>",
    "trigger_instructions": "<string>",
    "form_type": "natural",
    "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attributes": {},
    "fields": [],
    "webhook_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "trigger_tools": [],
    "contact_mapping": {}
  }
}

Authorizations

api_key · string · query · required

Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.

Body

application/json

name · string | null · required

trigger_instructions · string | null · required

form_type · enum<string> | null · required

Available options: natural, simple

org_id · string<uuid> | null

attributes · Attributes · object

fields · any[]

webhook_id · string<uuid> | null

trigger_tools · any[] | null

contact_mapping · Contact Mapping · object

Response

201

application/json

Successful Response

message · string | null · default: Data created successfully

meta · Meta · object

data · IFormCreate · object

Show child attributes