Skip to content
Shout Help Center

/v1/forms (POST)

POST
/v1/forms
 
curl --request POST \
  --url https://example.com/v1/forms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "title": "example", "description": "example", "workspaceId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "active": true, "questions": [ { "type": "example", "text": "example", "friendlyId": "example", "required": true, "options": [ "example" ], "otherText": "example", "minSelections": 1, "maxSelections": 1, "scales": [ { "text": "example", "opposingText": "example" } ], "scaleStart": 1, "scaleEnd": 1, "trueLabel": "example", "falseLabel": "example", "icon": "example", "maxStars": 1, "rows": 1, "inputLimitation": "example", "columnHeadings": [ "example" ], "rowHeadings": [ "example" ], "lastColumnIsNotWeighted": true, "rankOptions": [ "example" ], "contactFields": [ { "field": "example", "label": "example", "visible": true } ], "datePlaceholder": "example", "startDatePlaceholder": "example", "endDatePlaceholder": "example", "collectTime": true, "fileUploadSlots": [ "example" ], "amount": 1, "currency": "example", "formula": "example" } ], "pages": [ { "title": "example", "questions": [ { "type": "example", "text": "example", "friendlyId": "example", "required": true, "options": [ "example" ], "otherText": "example", "minSelections": 1, "maxSelections": 1, "scales": [ { "text": "example", "opposingText": "example" } ], "scaleStart": 1, "scaleEnd": 1, "trueLabel": "example", "falseLabel": "example", "icon": "example", "maxStars": 1, "rows": 1, "inputLimitation": "example", "columnHeadings": [ "example" ], "rowHeadings": [ "example" ], "lastColumnIsNotWeighted": true, "rankOptions": [ "example" ], "contactFields": [ { "field": "example", "label": "example", "visible": true } ], "datePlaceholder": "example", "startDatePlaceholder": "example", "endDatePlaceholder": "example", "collectTime": true, "fileUploadSlots": [ "example" ], "amount": 1, "currency": "example", "formula": "example" } ] } ] }'

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
object
title
string
nullable
description
string
nullable
workspaceId
string format: uuid
nullable
active
boolean
questions
Array<object>
nullable
object
type
string
nullable
text
string
nullable
friendlyId
string
nullable
required
boolean
options
Array<string>
nullable
otherText
string
nullable
minSelections
integer format: int32
nullable
maxSelections
integer format: int32
nullable
scales
Array<object>
nullable
object
text
string
nullable
opposingText
string
nullable
scaleStart
integer format: int32
nullable
scaleEnd
integer format: int32
nullable
trueLabel
string
nullable
falseLabel
string
nullable
icon
string
nullable
maxStars
integer format: int32
nullable
rows
integer format: int32
nullable
inputLimitation
string
nullable
columnHeadings
Array<string>
nullable
rowHeadings
Array<string>
nullable
lastColumnIsNotWeighted
boolean
rankOptions
Array<string>
nullable
contactFields
Array<object>
nullable
object
field
string
nullable
label
string
nullable
visible
boolean
datePlaceholder
string
nullable
startDatePlaceholder
string
nullable
endDatePlaceholder
string
nullable
collectTime
boolean
fileUploadSlots
Array<string>
nullable
amount
integer format: int64
nullable
currency
string
nullable
formula
string
nullable
pages
Array<object>
nullable
object
title
string
nullable
questions
Array<object>
nullable
object
type
string
nullable
text
string
nullable
friendlyId
string
nullable
required
boolean
options
Array<string>
nullable
otherText
string
nullable
minSelections
integer format: int32
nullable
maxSelections
integer format: int32
nullable
scales
Array<object>
nullable
object
text
string
nullable
opposingText
string
nullable
scaleStart
integer format: int32
nullable
scaleEnd
integer format: int32
nullable
trueLabel
string
nullable
falseLabel
string
nullable
icon
string
nullable
maxStars
integer format: int32
nullable
rows
integer format: int32
nullable
inputLimitation
string
nullable
columnHeadings
Array<string>
nullable
rowHeadings
Array<string>
nullable
lastColumnIsNotWeighted
boolean
rankOptions
Array<string>
nullable
contactFields
Array<object>
nullable
object
field
string
nullable
label
string
nullable
visible
boolean
datePlaceholder
string
nullable
startDatePlaceholder
string
nullable
endDatePlaceholder
string
nullable
collectTime
boolean
fileUploadSlots
Array<string>
nullable
amount
integer format: int64
nullable
currency
string
nullable
formula
string
nullable
Example generated
{
  "title": "example",
  "description": "example",
  "workspaceId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "active": true,
  "questions": [
    {
      "type": "example",
      "text": "example",
      "friendlyId": "example",
      "required": true,
      "options": [
        "example"
      ],
      "otherText": "example",
      "minSelections": 1,
      "maxSelections": 1,
      "scales": [
        {
          "text": "example",
          "opposingText": "example"
        }
      ],
      "scaleStart": 1,
      "scaleEnd": 1,
      "trueLabel": "example",
      "falseLabel": "example",
      "icon": "example",
      "maxStars": 1,
      "rows": 1,
      "inputLimitation": "example",
      "columnHeadings": [
        "example"
      ],
      "rowHeadings": [
        "example"
      ],
      "lastColumnIsNotWeighted": true,
      "rankOptions": [
        "example"
      ],
      "contactFields": [
        {
          "field": "example",
          "label": "example",
          "visible": true
        }
      ],
      "datePlaceholder": "example",
      "startDatePlaceholder": "example",
      "endDatePlaceholder": "example",
      "collectTime": true,
      "fileUploadSlots": [
        "example"
      ],
      "amount": 1,
      "currency": "example",
      "formula": "example"
    }
  ],
  "pages": [
    {
      "title": "example",
      "questions": [
        {
          "type": "example",
          "text": "example",
          "friendlyId": "example",
          "required": true,
          "options": [
            "example"
          ],
          "otherText": "example",
          "minSelections": 1,
          "maxSelections": 1,
          "scales": [
            {
              "text": "example",
              "opposingText": "example"
            }
          ],
          "scaleStart": 1,
          "scaleEnd": 1,
          "trueLabel": "example",
          "falseLabel": "example",
          "icon": "example",
          "maxStars": 1,
          "rows": 1,
          "inputLimitation": "example",
          "columnHeadings": [
            "example"
          ],
          "rowHeadings": [
            "example"
          ],
          "lastColumnIsNotWeighted": true,
          "rankOptions": [
            "example"
          ],
          "contactFields": [
            {
              "field": "example",
              "label": "example",
              "visible": true
            }
          ],
          "datePlaceholder": "example",
          "startDatePlaceholder": "example",
          "endDatePlaceholder": "example",
          "collectTime": true,
          "fileUploadSlots": [
            "example"
          ],
          "amount": 1,
          "currency": "example",
          "formula": "example"
        }
      ]
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK