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": 0,
    "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.

notesstring

Internal notes about the survey. Not shown to subscribers.

answersarray

The list of pre-defined answer choices. Order is preserved unless randomize_answers is true.

example
[ "Red", "Green", "Blue" ]

response_cadencestring · enum

How often a given subscriber can respond — e.g. once (single response per subscriber) or unlimited.

example
"once"
values
  • once

    A subscriber can only respond to this survey once.

  • once_per_email

    A subscriber can respond to this survey once per email.

statusstring · enum

The lifecycle status of the survey (e.g. active, archived).

values
  • active

    Active.

  • inactive

    Inactive.

is_freeform_response_enabledboolean

If true, subscribers can provide a freeform text response in addition to (or instead of) picking from answers.

input_typestring · enum

The UI control used to collect responses (e.g. radio, checkbox).

values
  • radio

    Radio button input type. Subscribers can select one option from multiple choices.

  • checkbox

    Checkbox input type. Subscribers can select multiple options from the available choices.

  • text

    Text input type. Subscribers can provide freeform text responses.

randomize_answersboolean

If true, the order of answers is shuffled each time the survey is rendered.