Update a survey

PATCH 
/v3/surveys/:id

Update a survey

Request

Path Parameters

id numberrequired

application/json

Body

name string

Possible values: <= 200 characters

workspace_id number
theme_id number
welcome_text string

thankyou_json

object[]

Array [

preAdded boolean

message string

description string

redirect_url string

branding boolean

]

archived 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

200

Successful

*/*

Schema

Schema

data

object[]

Array [

id number

name string

archived boolean

survey_type string

created_at date

updated_at date

survey_folder_id number

survey_folder_name string

]

Example (from schema)

{
  "data": [
    {
      "id": 1,
      "name": "Employee Satisfaction Survey",
      "archived": false,
      "survey_type": "Conversational",
      "created_at": "2022-02-28T07:25:44.268Z",
      "updated_at": "2022-02-28T07:25:44.268Z",
      "survey_folder_id": 10000034,
      "survey_folder_name": "General"
    }
  ]
}

Loading...