survey
v3

Create a survey

post/v3/surveys

Request

  • Base URL
    https://api.surveysparrow.com
  • URL
    https://api.surveysparrow.com/v3/surveys
  • Auth
    none declared

Request body

namestring required
survey_type'ClassicForm' | 'NPS' | 'NPSChat' | 'Conversational' | 'CES' | 'CESChat' | 'CSAT' | 'CSATChat' required
workspace_idnumber

"workspace" has been renamed to "survey folder". We suggest using survey_folder_id instead of workspace_id

survey_folder_idnumber
visibility'Public' | 'Mine'
theme_idnumber
primary_languagestring
welcome_screen_button_textstring
welcome_textstring
welcome_descriptionstring

Example request

{
  "name": "Employee satisfaction survey",
  "settings": {
    "cut_off_date": "2026-12-19T08:29:52.535Z"
  }
}

Response

Successful

Changes

No operation changes recorded.