Skip to main content
POST
/
surveys
Create a new survey
curl --request POST \
  --url https://api.questra.ai/surveys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Org-Id: <x-org-id>' \
  --data '
{
  "name": "<string>",
  "slug": "<string>",
  "order": 1
}
'
{
  "id": "<string>",
  "surveyId": "<string>",
  "slug": "<string>",
  "file_id": "<string>",
  "fileId": "<string>",
  "target_platform": "<string>",
  "needs_platform": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.questra.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Org-Id
string
required

The ID of the organization to make requests against. Found on your Settings page.

Body

application/json
​
name
string
required

A human-readable name for the survey

​
slug
string

A unique slug for the survey (one will be created automatically if left empty)

​
order
integer
Required range: x >= 0

Response

Survey created. Creating a survey consumes one credit from the active organization.

​
id
string
required
​
surveyId
string
required
​
slug
string
required
​
file_id
string
required
​
fileId
string
required
​
status
enum<string>
required
Available options:
pending,
programming,
waiting_for_destination,
compiling,
reviewing,
live,
closed
​
target_platform
string | null
required
​
needs_platform
boolean
required