Buttondown logo

Introduction

{
    "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"
}

Fields

id

Type
string
Description

A unique TypeID associated with the object.

creation_date

Type
string
Description

The date and time at which the object was first created.

identifier

Type
string
Description

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

question

Type
string
Description

The survey question shown to subscribers.

response_count

Type
integer
Description

The total number of responses this survey has received.

answers

Type
array
Description

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

notes

Type
string
Description

Internal notes about the survey. Not shown to subscribers.

randomize_answers

Type
boolean
Description

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

response_cadence

Type
SurveyResponseCadence
Description

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

status

Type
SurveyStatus
Description

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

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).