Create survey

POST

/surveys

Surveys

Creates a new survey with a SurveyJS definition.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Survey created successfully

Bodyapplication/json

🟠401Unauthorized

🟠409

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.aworld.cloud/dashboard/v1/surveys' \
--header 'x-idempotency-key;' \
--header 'Content-Type: application/json' \
--data '{
    "title": "string",
    "defaultLang": "en",
    "origin": "CATALOG",
    "background": "string",
    "textColor": "string",
    "boxColor": "string",
    "backgroundImage": "http://example.com",
    "backgroundSize": "cover",
    "backgroundPosition": "center",
    "fontFamily": "string",
    "contentJustify": "start",
    "parentId": "string",
    "parentType": "learningPath",
    "definition": {
        "property1": "string",
        "property2": "string"
    },
    "surveyId": "string"
}'

Response Example

{
    "surveyId": "string",
    "title": "string",
    "defaultLang": "en",
    "langs": [
        "en"
    ],
    "origin": "CATALOG",
    "background": "string",
    "textColor": "string",
    "boxColor": "string",
    "backgroundImage": "http://example.com",
    "backgroundSize": "cover",
    "backgroundPosition": "center",
    "fontFamily": "string",
    "contentJustify": "start",
    "parentId": "string",
    "parentType": "learningPath",
    "definition": {
        "property1": "string",
        "property2": "string"
    },
    "accountId": "stringstri",
    "workspaceId": "stringstri",
    "sourceRegion": "us-east-1",
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z"
}

Modified at 2026-06-15 16:41:21

Update survey tag assignment

List surveys