Skip to main content
POST
/
api
/
v1
/
management
/
surveys
Create Survey
curl --request POST \
  --url https://{baseurl}/api/v1/management/surveys \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "environmentId": "<string>",
  "name": "<string>",
  "status": "draft",
  "type": "link",
  "displayOption": "displayOnce",
  "languages": [
    {
      "default": true,
      "enabled": true,
      "language": "en"
    }
  ],
  "questions": [
    {
      "date": {
        "format": "M-d-y"
      },
      "id": "<string>",
      "inputType": "text",
      "rating": {
        "range": 3,
        "scale": "number"
      },
      "shuffleOption": "none",
      "type": "address"
    }
  ]
}
'
{}

Headers

x-api-key
string
required

Body

application/json
environmentId
string
required
name
string
required
status
enum<string>
required
Available options:
draft,
inProgress,
paused,
completed
type
enum<string>
required
Available options:
link,
app
displayOption
enum<string>
Available options:
displayOnce,
displayMultiple,
respondMultiple,
displaySome
languages
object[]
questions
object[]

Response

OK

The response is of type object.