---
title: "Create a survey"
method: POST
path: "/v3/surveys"
tags: ["survey", "v3"]
---

# Create a survey

`POST /v3/surveys`

## Request body

- CreateSurveySchema
  - `name` string, required
  - `survey_type` 'ClassicForm' | 'NPS' | 'NPSChat' | 'Conversational' | 'CES' | 'CESChat' | 'CSAT' | 'CSATChat', required
  - `workspace_id` number — "workspace" has been renamed to "survey folder". We suggest using survey_folder_id instead of workspace_id
  - `survey_folder_id` number
  - `visibility` 'Public' | 'Mine'
  - `theme_id` number
  - `primary_language` string
  - `welcome_screen_button_text` string
  - `welcome_text` string
  - `welcome_description` string
  - `thankyou_json` SurveyThankyouPageSchema[]
    - `preAdded` boolean
    - `message` string
    - `description` string
    - `redirect_url` string
    - `branding` boolean
  - `settings` SurveySettings
    - `survey_randomize` boolean — Randomize questions in the survey
    - `submission_per_user` SubmissionPerUser
      - `active` boolean, required — Enable submission per user
      - `limit` number
      - `limit_reset` LimitReset — Reset the limit after a period of time
        - `never` boolean, required
        - `frequency` 'day' | 'week' | 'month' | 'year'
        - `value` number
    - `throttling` Throttling
      - `active` boolean, required — Enable throttling
      - `times` number
      - `days` number
    - `track_ip` boolean — To Track the IP address of the user
    - `track_location` boolean — To Track the location of the user
    - `edit_response` boolean — To allow the user to edit the response
    - `copy_of_response` boolean — To allow the user to send a copy of the response to themselves
    - `partial_submission` boolean — To allow the user to submit partially
    - `auto_submission` boolean — To allow the user to submit automatically. Only available in Chat Surveys
    - `response_limit` number — Limit the number of responses this survey can get
    - `cut_off_date` string, date
    - `dynamic_cut_off` DynamicCutOff
      - `enabled` boolean, required
      - `period` 'days' | 'weeks' | 'months' | 'years' | 'hours'
      - `value` number
    - `enable_offline_support` boolean — This feature is available only in ClassicForm
    - `password` string — Password for the survey
    - `disable_scroll_back` boolean — To disable the scroll back option
    - `disable_contact_tracking` boolean — To disable the contact tracking

## Response `200`

Successful

---

[API](https://skmtc.net/surveysparrow/apis/api-documentation.md) · [All operations](https://skmtc.net/surveysparrow/apis/api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/surveysparrow/api-documentation/versions/25b2eba467de/schema)