Skip to main content

Create a survey

POST 
/v3/surveys

Create a survey

Request​

Body

    name stringrequired

    Possible values: non-empty and <= 200 characters

    survey_type stringrequired

    Possible values: [ClassicForm, NPS, NPSChat, Conversational, CES, CESChat, CSAT, CSATChat]

    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 string

    Possible values: [Public, Mine]

    Default value: Public

    theme_id number
    primary_language string
    welcome_screen_button_text string

    Possible values: <= 250 characters

    welcome_text string
    welcome_description string

    thankyou_json

    object[]

  • Array [

    • preAdded boolean
    message string
    description string
    redirect_url string
    branding boolean

  • ]

    • settings

    object

    survey_randomize boolean

    Randomize questions in the survey

    submission_per_user

    object

    active booleanrequired

    Enable submission per user

    limit number

    Possible values: >= 1 and <= 9999999999

    limit_reset

    object

    Reset the limit after a period of time

    never booleanrequired
    frequency string

    Possible values: [day, week, month, year]

    value number

    Possible values: >= 1 and <= 9999999999

    throttling

    object

    active booleanrequired

    Enable throttling

    times number

    Possible values: >= 1 and <= 9999999999

    days number

    Possible values: >= 1 and <= 9999999999

    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

    Possible values: <= 1000000000

    Limit the number of responses this survey can get

    cut_off_date date

    dynamic_cut_off

    object

    enabled booleanrequired
    period string

    Possible values: [days, weeks, months, years, hours]

    value number

    Possible values: >= 1 and <= 999

    enable_offline_support boolean

    This feature is available only in ClassicForm

    password string

    Possible values: >= 5 characters and <= 256 characters

    Password for the survey

    disable_scroll_back boolean

    To disable the scroll back option

    disable_contact_tracking boolean

    To disable the contact tracking

Responses​

Successful

Schema

    data

    object

    id number
    name string
    archived boolean
    survey_type string
    created_at date
    updated_at date
    survey_folder_id number
    survey_folder_name string
Loading...