Create a new survey in a study

Authorization

BearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

studyKey*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id?string

ObjectID

surveyKey?string

props?

prefillRules?array<>

contextRules?

maxItemsPerPage?

availableFor?string

requireLoginBeforeSubmission?boolean

published?integer

unpublished?integer

surveyDefinition?

versionId?string

metadata?

Response Body

`application/json`

curl -X POST "https://example.com/v1/studies/string/surveys/" \  -H "Content-Type: application/json" \  -d '{}'

{
  "survey": {
    "id": "string",
    "surveyKey": "string",
    "props": {},
    "prefillRules": [
      {}
    ],
    "contextRules": {},
    "maxItemsPerPage": {},
    "availableFor": "string",
    "requireLoginBeforeSubmission": true,
    "published": 0,
    "unpublished": 0,
    "surveyDefinition": {},
    "versionId": "string",
    "metadata": {
      "property1": "string",
      "property2": "string"
    }
  }
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

Create a new survey in a study

Authorization

Path Parameters

Request Body

Response Body

201application/json

400application/json

401application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`