Parameters - EnrolmentBatchXML

[+] More Parameters

EnrolmentBatchXML

Type:XML String

This parameter is used to enrol one or more numbers into an existing TextSurvey.

Using this parameter, you can supply a different reference for each number, as well as a reference for the batch. These references will be stored along with your enrolled numbers, and will appear in TextSurvey's reports.

For Surveys that use placeholders, this method also allows you to supply placeholder values for each number.

Example XML


<?xml version="1.0" encoding="utf-8"?>
<EnrolmentBatch xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Enrolments>
    <Enrolment>
      <Number>+440000000001</Number>
      <PlaceholderValues>
        <string>placeholder 1</string>
        <string>placeholder 2</string>
        <string>placeholder 3</string>
      </PlaceholderValues>
      <ClientReference>Customer number 1</ClientReference>
    </Enrolment>
    <Enrolment>
      <Number>+440000000002</Number>
      <PlaceholderValues>
        <string>placeholder one</string>
        <string>placeholder two</string>
        <string>placeholder three</string>
      </PlaceholderValues>
      <ClientReference>Customer number 2</ClientReference>
    </Enrolment>
  </Enrolments>
  <ClientReference>Customer batch 1</ClientReference>
  <SurveyId>1</SurveyId>
</EnrolmentBatch>

The schema for this XML is available here.