Skip to main content
POST
/
core.v1.WorkflowService
/
CreateForm
cURL
curl -X POST "https://api.joinformal.com/core.v1.WorkflowService/CreateForm" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "example": "value"
  }'
{
  "form": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "fields": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "<string>",
        "config": {
          "options": [
            {
              "label": "<string>",
              "value": "<string>"
            }
          ],
          "optionsSource": {
            "app": "<string>",
            "command": {
              "name": "<string>"
            },
            "machineUserId": "<string>",
            "input": {},
            "transform": "<string>"
          }
        }
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
X-API-KEY
string
header
required

API key authentication. Get your API key from the Formal console.

Body

application/json
​
name
string
Minimum string length: 1
​
description
string
​
fields
FormField · object[]

Response

Success

​
form
form · object