Buttondown logo

Updating a survey

Sample requests

These sample requests are autogenerated by the OpenAPI spec. This endpoint requires one or more parameters in the URL: those are offset in curly-braces.

import requests

url = "https://api.buttondown.com/v1/surveys/{id}"
headers = {
  "Authorization": "Token $BUTTONDOWN_API_KEY"
}
data = {
  "answers": [
    "Red",
    "Green",
    "Blue"
  ],
  "response_cadence": "once"
}

response = requests.request("PATCH", url, headers=headers, json=data)
print(response.text)

Sample responses

The IDs and values referenced in these responses are fake; please only rely on these responses for overall structure.

{
    "id": "srv_0k28edc3fw896bp4mrhc535z5k",
    "creation_date": "2020-09-29T00:00:00+00:00",
    "identifier": "color",
    "question": "What's your favorite color?",
    "response_count": 11,
    "answers": [
        "Red",
        "Green",
        "Blue"
    ],
    "notes": "",
    "randomize_answers": false,
    "response_cadence": "once",
    "status": "active",
    "is_freeform_response_enabled": false,
    "input_type": "radio"
}

Body parameters

All parameters are optional unless explicitly specified.

notes

Type

answers

Type
Example
[ "Red", "Green", "Blue" ]

response_cadence

Type
SurveyResponseCadence
Example
"once"

status

Type
SurveyStatus

is_freeform_response_enabled

Type

input_type

Type
SurveyInputType

randomize_answers

Type