Buttondown logo

Survey response

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

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.

answer

Type
string
Description

The answer given to the survey.

text

Type
string
Description

Optional text included by the subscriber with the response. Subscribers are only prompted to supply a text response if the is_freeform_response_enabled field is set to true on the survey.

survey_id

Type
string
Description

The ID of the survey this response was submitted to.

subscriber_id

Type
string
Description

The ID of the subscriber who submitted this response.

email_id

Type
string
Description

The ID of the email where this response was submitted, if any.

automation_id

Type
string
Description

The ID of the automation where this response was submitted, if any.

source

Type
string
Description

For responses not tied to an email or automation, the origin the survey was answered from (e.g. a transactional:* template). Null otherwise.

subscriber

Type
Subscriber

survey

Type
Survey

email

Type
Email

automation

Type
Automation