Campaign section

The <campaign> section is where you define the generic campaign type, such as Email, SMS, or Push. It is also the container for all campaign-related sections and elements.

The <campaign> section is:

  • A child of the Contactlab section and is mandatory
  • Positioned:
    • After the Auth section as the first entry of all campaign-related sections and elements (<campaign>)
    • After the last tag of all campaign-related sections and elements (</campaign>)
    • Before the last (</contactlab>) tag in the XML instructions file

The <campaign> section includes the following children:

Child Type Description Use
email element Email generic campaign type. See the Email message section. Choose <email>, <sms> or <push>
sms element SMS generic campaign type. See the SMS message section. Choose <email>, <sms> or <push>
fax element No longer supported. Avoid for new campaigns
push element Push generic campaign type. See the Push message section. Choose <email>, <sms> or <push>

Use

The appropriate generic campaign type, such as <email>, <sms> or <push>, is the container for all further campaign-related sections and elements. It is positioned:

  • As the first tag (for example, <email>) within the <campaign> section
  • As the last tag (for example, </email>) of all campaign-related sections and elements, but before the </campaign> tag

IMPORTANT:

Only one generic campaign type should be included in an XML instruction file.

Example:

    <contactlab>
        <auth>
            ...
        </auth>
        <campaign>
            <!-- EMAIL DELIVERY -->
            <email>
            See the common section and Email message section topics.
            </email>
 
            <!-- or SMS DELIVERY -->
            <sms>
            See the common section and SMS message section topics.
            </sms>
 
            <!-- or FAX DELIVERY -->
            <fax>
            No longer supported.
            </fax>
 
            <!-- or PUSH DELIVERY -->
            <push>
            See the common section and Push message section topics.
            </push>
        </campaign>
    </contactlab>

See Building a campaign with XMLDelivery and Working examples for more about the structure of a complete XML instructions file.

Next page:

Common sections and elements


Also see: