Buttondown logo

Creating a survey

Sample requests

These sample requests are autogenerated by the OpenAPI spec.

import requests

url = "https://api.buttondown.com/v1/surveys"
headers = {
  "Authorization": "Token $BUTTONDOWN_API_KEY"
}
data = {
  "identifier": "color",
  "question": "What's your favorite color?",
  "answers": [
    "Red",
    "Green",
    "Blue"
  ],
  "response_cadence": "once",
  "input_type": "radio"
}

response = requests.request("POST", 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.

identifier

Type
string · required
Description

A newsletter-scoped slug used to reference this survey when embedding it in emails.

Example
"color"

question

Type
string · required
Description

The survey question shown to subscribers.

Example
"What's your favorite color?"

answers

Type
array · required
Description

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

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

notes

Type
string
Description

Internal notes about the survey. Not shown to subscribers.

response_cadence

Type
SurveyResponseCadence
Description

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

Example
"once"

is_freeform_response_enabled

Type
boolean
Description

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

input_type

Type
SurveyInputType
Description

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

Example
"radio"

randomize_answers

Type
boolean
Description

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