You are here: Communications Cloud API v1 > Resources > Subscribers > Subscriber Question Responses

Subscriber Question Responses

You can use the Subscriber resource to add, update, or delete a subscriber's answers to any questions your organization might include in your subscription process, although the questions themselves are managed with the Subscriber Questions resource.

Methods
ClosedClick to view
Method Description Require Permissions
List All Responses

You can return a list of all responses provided by a subscriber to any questions that your organization has included in your subscription workflow (these questions appear on a page that appears during subscription). This allows you to display this information somewhere, like a custom subscriber profile page, or include this information in a database that can be searched. 
  • List Responses
Change All Responses

Use this call to completely change all question responses for a subscriber. This is a bulk operation, which will completely replace the subscriber's entire list of question responses. If you simply want to add or change a response to a particular question, consider using the Change Responses for One Question method. 
  • Update Responses
Return Responses for One Question

To see a particular subscriber's responses for one question, you will need that question ID, run through Base64 conversion. Using this method, you can display this information as part of a subscriber profile or send that information somewhere else, like a database that contains constituent information.

  • List Responses
Change Responses for One Question

Use this call to completely change all responses for a particular question for a particular subscriber. Note that a subscriber may have multiple responses to the same question. When you use this method, you are replacing all existing responses with whatever responses you include in your input.

  • Update Responses
Elements
ClosedClick to view
<responses>

This field must include the type="array" attribute. All other elements are nested within this one. Enter a list of responses. The list of responses you include will completely replace the existing list of responses currently saved for the subscriber. To delete all responses, include an empty responses array.

You will enter any responses you want to include in each nested <response> field.
<response> You can include multiple <response> fields in your input; one for each question to be answered for this subscriber.
<question-answer-text>

This field contains the text for the subscriber's answer, if this question requires a free-text response. If the question is multiple-choice, then only the <answer-id> element is required. The <question-answer-text> element is ignored. Because this field can be left empty, the nil="true" attribute is also required.
<question-id> This field contains the Base64-encoded ID for the question you want to include. This ID is specific to the subscriber. Use the List All Responses method to find question IDs (returned in the<to param> element).
<answer-id>

This field contains the Base64-encoded ID for the answer you want to include. Use the List All Responses method to find IDs for this element (returned in the <to param> element).

  • If a subscriber has not yet seen a question, there should be no answer IDs for that question.
  • If a subscriber has seen a question, but chose not to respond, there should be an answer ID with the nil="true" attribute.
Related Topics IconRelated Topics

 

Was this page helpful? Can't find what you need? Let us know

Open topic with navigation