Buttondown logo

Creating a survey response

Sample requests

These sample requests are autogenerated by the OpenAPI spec.

import requests

url = "https://api.buttondown.com/v1/survey_responses"
headers = {
  "Authorization": "Token $BUTTONDOWN_API_KEY"
}
data = {
  "subscriber_id": [
    "sub_01jv2m9q8r7s6t5w4x3y2z1abc"
  ],
  "survey_id": [
    "srv_01jv2m9q8r7s6t5w4x3y2z1abc"
  ],
  "email_id": "em_01jv2m9q8r7s6t5w4x3y2z1abc",
  "answer": 1
}

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": "resp_0k28edc3fw896bp4mrhc535z5k",
    "creation_date": "2020-09-29T00:00:00+00:00",
    "answer": "Red",
    "text": "",
    "survey_id": "srv_0k28edc3fw896bp4mrhc535z5k",
    "subscriber_id": "sub_0k28edc3fw896bp4mrhc535z5k",
    "email_id": null,
    "automation_id": null,
    "source": null,
    "subscriber": null,
    "survey": null,
    "email": null,
    "automation": null
}

Body parameters

All parameters are optional unless explicitly specified.

subscriber_id

Type
string · required
Description

The subscriber who submitted the response.

Example
[ "sub_01jv2m9q8r7s6t5w4x3y2z1abc" ]

survey_id

Type
string · required
Description

The survey being answered.

Example
[ "srv_01jv2m9q8r7s6t5w4x3y2z1abc" ]

email_id

Type
string · required
Description

The email ID, automation ID, or arbitrary source string where the survey was answered.

Example
"em_01jv2m9q8r7s6t5w4x3y2z1abc"

answer

Type
integer · required
Description

The 1-based index of the selected answer in the survey's answers list.

Example
1