Change All Responses

You are here: Communications Cloud API v1 > Resources > Subscribers > Change All Responses

Change All Responses

PUT to /api/accounts/ACCOUNT_CODE/subscribers/ENCODED_SUBSCRIBER_ID/responses.xml

Your ACCOUNT_CODE can be found via the administrative interface.

The ENCODED_SUBSCRIBER_ID is the following information run through Base64 conversion:
- For email subscribers: email address.
- For wireless subscribers: a string consisting of country code, a plus (+) sign, and the (digit-only) phone number. Example: 1+5555555555
- The appropriately encoded ID will be returned in the <to-param> element of the output from the Create Subscriber method.

Example Input

<responses type="array">
 <!-- Subscriber saw this question and did not answer it -->
 <response>
   <question-answer-text nil="true"></question-answer-text>
   <question-id>####</question-id>
   <answer-id nil="true"></answer-id>
 </response>

 <!-- subscriber saw this question and answered with two responses -->
 <response>
   <question-answer-text>ENTER ANSWER TEXT</question-answer-text>
   <question-id>####</question-id>
   <answer-id>####</answer-id>
 </response>
 <response>
   <question-answer-text>ENTER ANSWER TEXT</question-answer-text>
   <question-id>####</question-id>
   <answer-id>####</answer-id>
 </response>
</responses>

Elements

Click 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 Read a Single Question 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.

Example Output

A successful operation will have a 200 OK response status and an empty response body.

Troubleshooting

Reference subscriber error codes

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

Open topic with navigation