Schedule a Mailing

ScheduleMailing

Sends a template‐based mailing to a specific database or query.

Operation  <ScheduleMailing>     
Elements  TEMPLATE_ID  ID of template upon which to base the mailing.   
  LIST_ID  ID of database, query, or contact list to send the template‐based mailing.   
  MAILING_NAME  Name to assign to the generated mailing.   
  SEND_HTML  Optional  If this element is present, value is true. Leave blank if you do not want to include the HTML body. 
  SEND_AOL  Optional  If this element is present, value is true. Leave blank if you do not
want to include the AOL body. 
  SEND_TEXT  Optional  If this element is present, value is true. Leave blank if you do not
want to include the text body. 
  SUBJECT  Optional  If you do not include this element, Watson Campaign Automation uses the subject saved with the template. 
  FROM_NAME  Optional  If you do not include this element, Watson Campaign Automation uses the From Name saved with the template. 
  FROM_ADDRESS  Optional  If you do not include this element, Watson Campaign Automation uses the From Address saved with the template. 
  REPLY_TO  Optional  If you do not include this element, Watson Campaign Automation uses the Reply‐To Address saved with the template. 
  VISIBILITY 

Value indicating where to save the sent mailing. Values are:

0 – Private Folder
1 – Shared Folder 

 
  SCHEDULED 

Value specifying the date and time when the mailing should be scheduled to
send.

The format must be:
MM/DD/YYYY HH:MM:SS AMPM 

 
  INBOX_MONITOR  Optional  If True, Watson Campaign Automation activates Inbox Monitoring for the mailing. 
  SEND_TIME_OPTIMIZATION  Optional 

If specified, it is possible to send the mailing over a day or week.
Valid values are:

NONE – will not use Send Time Optimization.

SEND_24HRS – will send the mailing over a 24 hour period
based on each recipient’s optimal send time.

SEND_WEEK– will send the mailing over a 7 day period based on each recipient’s optimal send time. 

  WA_MAILINGLEVEL_CODE  Optional 

This element is used in conjunction with Site Analytics Append
String. If you have an append string that includes
%%WA_MAILINGLEVEL_CODE%%, use the element to specify
a mailing specific parameter to be passed via your links to your
Site Analytics package.

Note: This element is equivalent to the Mailing Specific Parameter box on the Send Mailing screen in Watson Campaign Automation when using Site Analytics. 

  SUPPRESSION_LISTS  Optional  XML node containing one or more SUPPRESSION_LIST_ID child elements. 
Optional Child
Elements 
SUPPRESSION_LIST_ID  If any suppression lists are specified, they will be utilized as the suppression
lists when the mailing is sent. 
 
  SUBSTITUTIONS  Optional  XML node containing child element SUBSTITUTION 
Optional Child
Elements 
SUBSTITUTION 

XML nodes defining the substitution name and value. This feature allows
template‐level substitutions separate from the normal contact‐level
substitutions performed by personalization. They are not contact specific. They are also not related to HTML_GENERAL_DISCLAIMER or the TEXT_GENERAL_DISCLAIMER.

Note: If used, each node must have a NAME tag and a VALUE tag. 

 
  Optional Child Element  NAME  The substitution tag used in the mailing template. This
substitution name is case‐sensitive. For example, if you include
%%Sub_Value_1%% in the mailing template, the value for this
child element is Sub_Value_1. 
    VALUE  The value you would like to substitute into the mailing for the
tag with the name given above. 
Example  <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:ses=”SilverpopApi:EngageService.SessionHeader”
xmlns:user=”SilverpopApi:EngageService.MailManagement.UserActions”>
<soapenv:Header>
<ses:sessionHeader>
<ses:sessionid>87F620244DBE91A49EAAEC81687C84AD</ses:sessionid>
</ses:sessionHeader>
</soapenv:Header>
<soapenv:Body>
<user:ScheduleMailing>
<user:TEMPLATE_ID>1866986</user:TEMPLATE_ID>
<user:LIST_ID>24872</user:LIST_ID>
<user:MAILING_NAME>Scheduled Mailing2</user:MAILING_NAME>
<user:SEND_HTML/>
<user:SUBJECT>Scheduled Mailing</user:SUBJECT>
<user:FROM_NAME>Scott hamilton</user:FROM_NAME>
<user:FROM_ADDRESS>shamilton@silverpop.com</user:FROM_ADDRESS>
<user:REPLY_TO>shamilton@silverpop.com</user:REPLY_TO>
<user:VISIBILITY>1</user:VISIBILITY>
<user:SCHEDULED>06/07/2009 12:00:00 PM</user:SCHEDULED>
<user:SUPPRESSION_LISTS>
<user:SUPPRESSION_LIST_ID>37782</user:SUPPRESSION_LIST_ID>
<user:SUPPRESSION_LIST_ID>37744</user:SUPPRESSION_LIST_ID>
</user:SUPPRESSION_LISTS>
<user:SUBSTITUTIONS>
<user:SUBSTITUTION>
<user:NAME>Sub_Value_1</user:NAME>
<user:VALUE>The value I would like to put in my mailing.</user:VALUE> 
   
Response  <RESULT>     
Elements  SUCCESS  True if successful.   
  MAILING_ID  If the request was successful, this element contains the ID for the sent mailing.   
Example
Success 
<envelope:Envelope xmlns=”SilverpopApi:EngageService.MailManagement.UserActions”
xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
<envelope:Header/>
<envelope:Body>
<RESULT>
<SUCCESS>TRUE</SUCCESS>
<MAILING_ID>2615568</MAILING_ID>
</RESULT>
</envelope:Body>
</envelope:Envelope> 
   
Error Codes  100  You did not provide a required field.   
  108  The list ID does not exist.   
  145  User session is invalid or has expired.   
  181  Mailing ID provided does not exist.   
  182  Mailing name already exists.   
  183  Errors found when validating the mailing to send.   
  350  Permission denied for the provided list ID.   
  506  Permission denied for the provided template ID.   

Preview a Mailing Before Sending

PreviewMailing

This interface returns a preview of a mailing template. If a contact email address is provided in the request, the preview will include personalization for the specified contact.

Operation  <PreviewMailing>       
Elements  MailingId  Numeric identifier for the mailing template to be exported.     
  RecipientEmail Optional  Email address of the contact that will be used to display
personalization 
 
Example  <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:sil=”SilverpopApi:EngageService.SessionHeader”
xmlns:sil1=”SilverpopApi:EngageService.MailManagement.UserActions”>
<soapenv:Header>
<sil:sessionHeader>
<sil:sessionid>BDBA0A445AB983709A924AB64706D3A4</sil:sessionid>
</sil:sessionHeader>
</soapenv:Header>
<soapenv:Body>
<sil1:PreviewMailing>
<sil1:MailingId>2977691</sil1:MailingId>
</sil1:PreviewMailing>
</soapenv:Body>
</soapenv:Envelope> 
     
Response  <RESULT>       
Elements  SUCCESS  TRUE if successful     
  HTMLBody  Returns the contents of the HTML body with personalization substituted.     
  AOLBody  Returns the contents of the AOL body with personalization substituted.     
  TextBody  Returns the contents of the Text body with personalization substituted.     
  SPAMScore  Returns the SPAM score based on the contents of the mailing template.     
Example <envelope:Envelope xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
<envelope:Header/>
<envelope:Body xmlns=”SilverpopApi:EngageService.MailManagement.UserActions”>
<RESULT>
<SUCCESS>true</SUCCESS>
<HTMLBody><![CDATA[<html><head> </head><body><CENTER><FONT SIZE=”1″
COLOR=”#000000″ FACE=”ARIAL”>If you are unable to see the message below, <A
href=”http://recp.spqa1.com/ui/modules/display/previewClickToView.jsp”>click here to
view</A>.</FONT><font face=”ARIAL” color=”#808080″
size=”2″><br></font></CENTER><p>%%FIRST_NAME%%</p><p>Here is some personalization within
personalization done by referencing a list field within another list
field:</p><p>%%IGNORE_1%%</p><p></p><p>Here is some personalization within personalization done
by referencing a list field within API
Substitution:</p><p>%%SUB_VALUE_1%%</p></body></html>]]></HTMLBody>
<AOLBody/>
<TextBody/>
<SpamScore>Score is: 2.3/5.0
‐‐‐‐ ‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐ ‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐
0.0 MIME_HTML_MOSTLY BODY: Multipart message mostly text/html MIME
0.0 HTML_MESSAGE BODY: HTML included in message
1.1 MPART_ALT_DIFF BODY: HTML and text parts are different
0.1 RDNS_NONE Delivered to trusted network by a host with no rDNS
1.0 AWL AWL: From: address is in the auto white‐list</SpamScore>
</RESULT>
</envelope:Body>
</envelope:Envelope>
     

Add a Dynamic Content Ruleset

AddDCRuleset

This interface creates a Ruleset including its content areas, rules, and content. If user does not specify a MAILING_ID, Watson Campaign Automation will create a new Ruleset in the user’s Private folder of the Asset Library.

Note: A ruleset may contain no more than 1,000 rules.

Operation  <AddDCRuleset>           
Elements  LIST_ID  The ID of the associated database.         
  RULESET_NAME  The name of the DC Ruleset.         
  MAILING_ID  Optional  Associates a Ruleset directly to a mailing. This will NOT place a copy of the Ruleset in the asset library.       
Child Element  CONTENT_AREAS  The content area defines default content used when a user falls outside of all existing rule criteria as well as additional content areas in the mailing body.         
  Child Element  CONTENT_AREA  Optional Included if content being defined. It is possible to create a
Ruleset and associated rules in the asset library without
related content areas. 
   
    Attribute  name  The Name of the Content Area being defined.     
      type 

The type of Content Area. The following values are valid:

‘BodyHTML’
‘Body‐Text’
‘Body‐AOL’
‘Subject’
‘From’
‘From‐Name’ 

   
    Child Element  DEFAULT_CONTENT  This is the content that will show if there is no matching
rule. For HTML content, this must be CDATA. 
   
      Attribute  name  The name of the default Content Block.   
Child
Element 
RULES           
  Child Element  RULE         
    Child Element  RULE_NAME  The Name of the Dynamic Content Rule.     
      PRIORITY  The priority of this rule vs. other rules. Number must be
unique. Priority is determined in ascending order with ‘1’ being the highest. 
   
      CRITERIA       
      Child Element  EXPRESSION     
        Child Element  AND_OR  Used to denote ‘AND’ or ‘OR’ when defining relationships
between expressions. 
          LEFT_PARENS  Used to denote a left
parenthesis character when defining relationships between
expressions. 
          TYPE

The type of expression. Valid
values are:

‘NE’-Numeric
‘DE’-Date/Time
‘TE’ – Text 

          COLUMN_NAME  The name of the database
field being evaluated. 
          OPERATORS 

The operator used for
comparison. Valid values are:

‘!=’
‘<‘
‘>’
‘=’
‘IS NOT null’
‘IS null’
‘LIKE’
‘NOT like’
‘IN’
‘NOT in’
‘BETWEEN’
 

          VALUES 

The value being compared to
the Watson Campaign Automation database field. Could be text, numeric, or
date value OR a list of values or the name of a Column.

If specifying a Column, surround
with square brackets. For
example, [My Text Column]. If
specifying a list of values, use |
(pipe character) to separate values in the list. 

          RIGHT_PARENS  Used to denote a right
parenthesis character when
defining relationships between
expressions. 
      CONTENTS       
      Child Element  CONTENT  Optional  This is the content that will show for contacts
matching the criteria of
this rule. For HTML content, this must be
CDATA. 
        Attribute  content_area  The previously defined
Content Area where the
content will be placed in
the mailing body. 
          name  The name of the Content
Block being defined. 
Example  <soapenv:Envelope xmlns:ses=”SilverpopApi:EngageService.SessionHeader”
xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:user=”SilverpopApi:EngageService.MailManagement.UserActions”>
<soapenv:Header>
<ses:sessionHeader>
<ses:sessionid>06395F3FA6D07365CBA5D01AF14F3F56</ses:sessionid>
</ses:sessionHeader>
</soapenv:Header>
<soapenv:Body>
<user:AddDCRuleset>
<user:LIST_ID>24872</user:LIST_ID>
<user:MAILING_ID>1866986</user:MAILING_ID>
<user:RULESET_NAME>Locale Body Ruleset V3</user:RULESET_NAME>
<user:CONTENT_AREAS>
<user:CONTENT_AREA type=”Body‐HTML” name=”MAILING BODY”>
<user:DEFAULT_CONTENT name=”Default.MAILING
BODY”>&lt;p>This is the content for people whose Locale is unknown….&lt;/p>&lt;p>&lt;img
src=”http://domain.com/images/question_mark.jpg” name=”question.jpg” spname=”question.jpg” alt=””
width=”97″ border=”0″ height=”145″>&lt;/p></user:DEFAULT_CONTENT>
</user:CONTENT_AREA>
</user:CONTENT_AREAS>
<user:RULES>
<user:RULE>
<user:RULE_NAME>US ENGLISH</user:RULE_NAME>
<user:PRIORITY>1</user:PRIORITY>
<user:CRITERIA>
<user:EXPRESSION>
<user:AND_OR/>
<user:LEFT_PARENS/>
<user:TYPE>TE</user:TYPE>
<user:COLUMN_NAME>Locale</user:COLUMN_NAME>
<user:OPERATORS>=</user:OPERATORS>
<user:VALUES>US ENGLISH</user:VALUES>
<user:RIGHT_PARENS/>
</user:EXPRESSION>
</user:CRITERIA>
<user:CONTENTS>
<user:CONTENT content_area=”MAILING BODY”
name=”US_ENGLISH.MAILING BODY”>&lt;p>This is the US English Newsletter.&lt;/p>&lt;p>&lt;img
style=”border: 1px solid ;” src=”http://domain.com/images/us_flag.jpg” name=”usa.jpg” spname=”usa.jpg”
alt=”” width=”127″ height=”90″>&lt;/p></user:CONTENT>
</user:CONTENTS>
</user:RULE>
<user:RULE>
<user:RULE_NAME>UK_ENGLISH</user:RULE_NAME>
<user:PRIORITY>2</user:PRIORITY>
<user:CRITERIA>
<user:EXPRESSION>
<user:AND_OR/>
<user:LEFT_PARENS/>
<user:TYPE>TE</user:TYPE>
<user:COLUMN_NAME>Locale</user:COLUMN_NAME>
<user:OPERATORS>=</user:OPERATORS>
<user:VALUES>UK ENGLISH</user:VALUES>
<user:RIGHT_PARENS/>
</user:EXPRESSION>
</user:CRITERIA>
<user:CONTENTS>
<user:CONTENT content_area=”MAILING BODY”
name=”UK_ENGLISH.MAILING BODY”>&lt;p>This is the UK English Content.&lt;/p>&lt;p>&lt;img
src=”http://domain.com/images/uk_flag.jpg” spname=”ukflag.jpg” alt=”” width=”143″ border=”0″
height=”107″>&lt;/p></user:CONTENT>
</user:CONTENTS>
</user:RULE>
<user:RULE>
<user:RULE_NAME>CAN_FRENCH</user:RULE_NAME>
<user:PRIORITY>3</user:PRIORITY>
<user:CRITERIA>
<user:EXPRESSION>
<user:AND_OR/>
<user:LEFT_PARENS/>
<user:TYPE>TE</user:TYPE>
<user:COLUMN_NAME>Locale</user:COLUMN_NAME>
<user:OPERATORS>=</user:OPERATORS>
<user:VALUES>CAN FRENCH</user:VALUES>
<user:RIGHT_PARENS/>
</user:EXPRESSION>
</user:CRITERIA>
<user:CONTENTS>
<user:CONTENT content_area=”MAILING BODY”
name=”CAN_FRENCH.MAILING BODY”><![CDATA[
<p>This is the French Canadian content.</p><p><img style=”border: 1px solid ;”
src=”http://domain.com/images/can_french.jpg” name=”can.jpg” spname=”can.jpg” alt=”” width=”141″
height=”106″></a></p>
]]></user:CONTENT>
</user:CONTENTS>
</user:RULE>
</user:RULES>
</user:AddDCRuleset>
</soapenv:Body>
</soapenv:Envelope> 
         
Response  <RESULT>           
Elements  SUCCESS  “True” indicates the rule creation was successful.
“False” indicates an error occurred in which the error code displays with a message reporting the issue. 
       
  RULESET_ID  Contains the new Ruleset ID.         
Example <envelope:Envelope xmlns=”SilverpopApi:EngageService.MailManagement.UserActions”
xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
<envelope:Header/>
<envelope:Body>
<RESULT>
<SUCCESS>TRUE</SUCCESS>
<RULESET_ID>576602</RULESET_ID>
</RESULT>
</envelope:Body>
</envelope:Envelope>
         

Import a Dynamic Content Ruleset

ImportDCRuleset

This interface imports a .zip containing the XML file defining a Dynamic Content Ruleset and any associated HTML or images. Imported files are loaded from the user’s FTP upload directory.

If the user does not specify a MAILING_ID or RULESET_ID, Engage creates a new Ruleset in the user’s Private folder of the Asset Library. If the user does specify a RULESET_ID, Engage replaces the Ruleset.

Note: A ruleset may contain no more than 1,000 rules.

Operation  <ImportDCRuleset>     
Elements FILE_NAME  The name of the .zip file located in the user’s FTP upload directory.   
  LIST_ID  The ID of the associated database.  
  MAILING_ID  Optional  Associates a Ruleset directly to a mailing. This will NOT place a copy of the Ruleset in the Asset Library. 
  RULESET_ID  Optional  Specifies an existing Ruleset to use in place of imported content. 
Example  <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:ses=”SilverpopApi:EngageService.SessionHeader”
xmlns:user=”SilverpopApi:EngageService.MailManagement.UserActions”>
<soapenv:Header>
<ses:sessionHeader>
<ses:sessionid>06395F3FA6D07365CBA5D01AF14F3F56</ses:sessionid>
</ses:sessionHeader>
</soapenv:Header>
<soapenv:Body>
<user:ImportDCRuleset>
<user:FILE_NAME>Import_Ruleset.zip</user:FILE_NAME>
<user:MAILING_ID>1866986</user:MAILING_ID>
<user:LIST_ID>24872</user:LIST_ID>
</user:ImportDCRuleset>
</soapenv:Body>
</soapenv:Envelope> 
   
Response  <RESULT>     
Elements  SUCCESS 

“True” indicates successful Data Job submission.

“False” indicates an error occurred in which the error code displayed with a
message reporting the issue. 

 
  JOB_ID Contains the Data Job ID for the import.   
Example  <envelope:Envelope xmlns=”SilverpopApi:EngageService.MailManagement.UserActions”
xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
<envelope:Header/>
<envelope:Body>
<RESULT>
<SUCCESS>TRUE</SUCCESS>
<JOB_ID>503632</JOB_ID>
</RESULT>
</envelope:Body>
</envelope:Envelope> 
   

The following table describes the .zip file format.

RULESET             
Child Element  RULESET_NAME  Optional  The name of the DC Ruleset if creating a new Ruleset using Import.       
  CONTENT_AREAS  The content area defines default content used when a user falls outside of all
existing rule criteria. 
       
  Child Element  CONTENT_AREA  Optional  Included if content being defined. It is possible to create a Ruleset and associated rules in the Asset Library without
related content areas. 
   
    Attribute  name  The name of the Content Area being defined.     
      type 

The type of Content Area. The following values are valid:

‘Body‐HTML’
‘Body‐Text’
‘Body‐AOL’
‘Subject’
‘From’
‘From‐Name’ 

   
    Child Element  DEFAULT_CONTENT  Content that displays if there is no matching rule. Must be set to CDATA for HTML content.     
      Attribute  name  The name of the Content Block being
defined. 
 
Child Element  RULES          
  Child Element RULE         
    Child Element  RULE_NAME  The name of the Dynamic Content Rule.     
      PRIORITY  The priority of the rule vs. other rules. Number must be unique. Priority is determined in ascending order with ‘1’ being the highest.     
      CRITERIA       
      Child Element  EXPRESSION    
        Child Element  AND_OR  Used to denote ‘AND’
or ‘OR’ when defining
relationships between
expressions. 
          LEFT_PARENS  Used to denote a left
parenthesis character
when defining
relationships between
expressions. 
          TYPE  The type of
expression. Valid
values are:
‘NE’ -Numeric
‘DE’ – Date/Time
‘TE’ – Text 
          COLUMN_NAME  The name of the database field being
evaluated. 
          OPERATORS 

The operator used for
comparison. Valid
values are:

‘!=’
‘<‘
‘>’
‘=’
‘IS NOT null’
‘IS null’
‘LIKE’
‘NOT like’
‘IN’
‘NOT in’
‘BETWEEN’ 

          VALUES  The value being
compared to the
Watson Campaign Automation database
field. Can be text, numeric, or date value
OR a list of values or
the name of a Column. If specifying
a Column, surround
with square brackets,
for example, [My Text
Column]. If specifying
a list of values, use |
(pipe character) to
separate values in the
list. 
          RIGHT_PARENS  Used to denote a right
parenthesis character
when defining
relationships between
expressions. 
      CONTENTS       
      Child Element  CONTENT Optional  This is the content that
will show for contacts
matching the criteria of
this rule. For HTML content, this must be
CDATA. 
        Attribute  content_area  The previously defined
Content Area where the
content will be placed in
the mailing body. 
          name  The name of the Content Block being
defined. 
Example  <RULESET>
<RULESET_NAME>Promo By Gender</RULESET_NAME>
<CONTENT_AREAS>
<CONTENT_AREA name=”dc_mailing_subject” type=”Subject”>
<DEFAULT_CONTENT name=”Default.dc_mailing_subject”><![CDATA[All
clothing on sale this week.]]></DEFAULT_CONTENT>
</CONTENT_AREA>
<CONTENT_AREA name=”dc_promo” type=”Body‐HTML”>
<DEFAULT_CONTENT name=”Default.dc_promo”><![CDATA[10% Off
Everything]]></DEFAULT_CONTENT>
</CONTENT_AREA>
</CONTENT_AREAS>
<RULES>
<RULE>
<RULE_NAME>MalePromotion</RULE_NAME>
<PRIORITY>1</PRIORITY>
<CRITERIA>
<EXPRESSION>
<AND_OR/>
<LEFT_PARENS>(</LEFT_PARENS>
<TYPE>TE</TYPE>
<COLUMN_NAME>Gender</COLUMN_NAME>
<OPERATORS><![CDATA[=]]></OPERATORS>
<VALUES><![CDATA[M]]></VALUES>
<RIGHT_PARENS>)</RIGHT_PARENS>
</EXPRESSION>
<EXPRESSION>
<AND_OR>AND</AND_OR>
<LEFT_PARENS>(</LEFT_PARENS>
<TYPE>NE</TYPE>
<COLUMN_NAME>Salary</COLUMN_NAME>
<OPERATORS><![CDATA[>]]></OPERATORS>
<VALUES><![CDATA[90000]]></VALUES>
<RIGHT_PARENS>)</RIGHT_PARENS>
</EXPRESSION>
</CRITERIA>
<CONTENTS>
<CONTENT name=”male_subject”
content_area=”dc_mailing_subject”><![CDATA[Men’s clothing on sale this week.]]></CONTENT>
<CONTENT name=”male_promo”
content_area=”dc_promo”><![CDATA[20% Off All Men’s Clothing]]></CONTENT>
</CONTENTS>
</RULE>
<RULE>
<RULE_NAME>Female Promotion</RULE_NAME>
<PRIORITY>2</PRIORITY>
<CRITERIA>
<EXPRESSION>
<AND_OR/>
<LEFT_PARENS>(</LEFT_PARENS>
<TYPE>TE</TYPE>
<COLUMN_NAME>Gender</COLUMN_NAME>
<OPERATORS><![CDATA[=]]></OPERATORS>
<VALUES><![CDATA[F]]></VALUES>
<RIGHT_PARENS>)</RIGHT_PARENS>
</EXPRESSION>
<EXPRESSION>
<AND_OR>AND</AND_OR>
<LEFT_PARENS>(</LEFT_PARENS>
<TYPE>NE</TYPE>
<COLUMN_NAME>Salary</COLUMN_NAME>
<OPERATORS><![CDATA[>]]></OPERATORS>
<VALUES><![CDATA[90000]]></VALUES>
<RIGHT_PARENS>)</RIGHT_PARENS>
</EXPRESSION>
</CRITERIA>
<CONTENTS>
<CONTENT name=”female_promo”
content_area=”dc_promo”><![CDATA[20% Off All Women’s Clothing]]></CONTENT>
<CONTENT name=”female_subject”
content_area=”dc_mailing_subject”><![CDATA[Women’s clothing on sale this week.]]></CONTENT>
</CONTENTS>
</RULE>
</RULES>
</RULESET> 
         

Export a Dynamic Content Ruleset

ExportDCRuleset

This interface exports the specified Ruleset and all associated content (including images), from the Asset Library as a .zip file. Engage places the file in the FTP or Stored Files directory based on the user’s choice (Stored Files is the default directory if user does not select a specific location).

Operation  <ExportDCRuleset>     
Elements  RULESET_ID  Specifies the Ruleset to export.   
  MOVE_TO_FTP  Optional 

Use the MOVE_TO_FTP parameter to retrieve the output file programmatically. If specified, Watson Campaign Automation will move the files to the download directory of the user’s FTP space.

Omitting the MOVE_TO_FTP parameter will move exported files to the user’s Export Files directory in Watson Campaign Automation. 

Example  <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:ses=”SilverpopApi:EngageService.SessionHeader”
xmlns:user=”SilverpopApi:EngageService.MailManagement.UserActions”>
<soapenv:Header>
<ses:sessionHeader>
<ses:sessionid>06395F3FA6D07365CBA5D01AF14F3F56</ses:sessionid>
</ses:sessionHeader>
</soapenv:Header>
<soapenv:Body>
<user:ExportDCRuleset>
<user:RULESET_ID>548403</user:RULESET_ID>
<user:MOVE_TO_FTP/>
</user:ExportDCRuleset>
</soapenv:Body>
</soapenv:Envelope>
   
Response  <RESULT>     
Elements  SUCCESS 

“True” indicates successful Data Job submission.

“False” indicates an error occurred in which the error code displayed with a
message reporting the issue. 

 
  Job ID  Contains the Data Job ID for the export.   
  File name  Name of the resulting file containing the exported Ruleset.   
Example  <envelope:Envelope xmlns=”SilverpopApi:EngageService.MailManagement.UserActions”
xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
<envelope:Header/>
<envelope:Body>
<RESULT>
<SUCCESS>TRUE</SUCCESS>
<JOB_ID>503633</JOB_ID>
</RESULT>
</envelope:Body>
</envelope:Envelope> 
   

List Dynamic Content Rulesets for a Mailing

ListDCRulesetsForMailing

This interface returns a list of available DC Rulesets for the specified mailing.

Operation  <ListDCRulesetsForMailing>     
Elements  MAILING_ID  The ID of the mailing whose Rulesets are being retrieved. This may be the ID of a mailing template or a sent mailing, in addition to an Autoresponder or Automated Message.   
Example  <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:ses=”SilverpopApi:EngageService.SessionHeader”
xmlns:user=”SilverpopApi:EngageService.MailManagement.UserActions”>
<soapenv:Header>
<ses:sessionHeader>
<ses:sessionid>06395F3FA6D07365CBA5D01AF14F3F56</ses:sessionid>
</ses:sessionHeader>
</soapenv:Header>\<soapenv:Body>
<user:ListDCRulesetsForMailing>
<user:MAILING_ID>1866986</user:MAILING_ID>
</user:ListDCRulesetsForMailing>
</soapenv:Body>
</soapenv:Envelope> 
   
Response  <RESULT>     
Elements SUCCESS 

“True” indicates successful listing call.

“False” indicates an error occurred in which the error code displays with a message reporting the issue. 

 
Child Element   RULESET    
  Child Element  RULESET_ID  The ID of the associated Ruleset. 
    LIST_ID  The ID of the associated Database. 
    RULESET_NAME  The name of the associated Ruleset. 
Example  <envelope:Envelope xmlns=”SilverpopApi:EngageService.MailManagement.UserActions”
xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
<envelope:Header/>
<envelope:Body>
<RESULT>
<SUCCESS>TRUE</SUCCESS>
<RULESET>
<RULESET_ID>548605</RULESET_ID>
<LIST_ID>24872</LIST_ID>
<RULESET_NAME>Locale Body Ruleset</RULESET_NAME>
</RULESET>
<RULESET>
<RULESET_ID>550802</RULESET_ID>
<LIST_ID>24872</LIST_ID>
<RULESET_NAME>Locale Body Ruleset ‐ Import</RULESET_NAME>
</RULESET>
<RULESET>
<RULESET_ID>551402</RULESET_ID>
<LIST_ID>24872</LIST_ID>
<RULESET_NAME>Locale Body Ruleset new</RULESET_NAME>
</RULESET>
<RULESET>
<RULESET_ID>552402</RULESET_ID>
<LIST_ID>24872</LIST_ID>
<RULESET_NAME>Locale Body Ruleset new 2</RULESET_NAME>
</RULESET>
</RESULT>
</envelope:Body>
</envelope:Envelope>
   

Get Dynamic Content Ruleset Details

GetDCRuleset

This interface returns the specified Ruleset in XML format. It does not support returning content images. To retrieve a complete Ruleset and its associated content, use the ExportDCRuleset operation.

Operation  <GetDCRuleset>     
Elements  RULESET_ID  The ID of the Ruleset to retrieve.   
Example  <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:ses=”SilverpopApi:EngageService.SessionHeader”
xmlns:user=”SilverpopApi:EngageService.MailManagement.UserActions”>
<soapenv:Header>
<ses:sessionHeader>
<ses:sessionid>06395F3FA6D07365CBA5D01AF14F3F56</ses:sessionid>
</ses:sessionHeader>
</soapenv:Header>
<soapenv:Body>
<user:GetDCRuleset>
<user:RULESET_ID>550802</user:RULESET_ID>
</user:GetDCRuleset>
</soapenv:Body>
</soapenv:Envelope> 
   
Response  <RESULT>     
Elements  SUCCESS 

“True” indicates a successful “Get Ruleset” call.

“False” indicates an error occurred in which the error code displays with a
message reporting the issue. 

 
  RULESET     
  Child Elements  RULESET_ID  The ID of the requested Ruleset. 
    RULESET_NAME  The name of the Ruleset. 
    CONTENT_AREAS  See AddDCRuleset for details. 
    RULES  See AddDCRuleset for details. 
Example  <envelope:Envelope xmlns=”SilverpopApi:EngageService.MailManagement.UserActions”
xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
<envelope:Header/>
<envelope:Body>
<RESULT>
<SUCCESS>TRUE</SUCCESS>
<RULESET>
<RULESET_ID>550802</RULESET_ID>
<RULESET_NAME>Locale Body Ruleset ‐ Import</RULESET_NAME>
<CONTENT_AREAS>
<CONTENT_AREA name=”MAILING BODY” type=”Body‐
HTML”>
<DEFAULT_CONTENT name=”Default.MAILING
BODY”>&lt;p>This is the content for people whose Locale is unknown….&lt;/p>&lt;p>&lt;img
src=”http://domain.com/images/question_mark.jpg” name=”question.jpg” spname=”question.jpg” alt=””
width=”97″ border=”0″ height=”145″>&lt;/p></DEFAULT_CONTENT>
</CONTENT_AREA>
</CONTENT_AREAS>
<RULES>
<RULE>
<RULE_NAME>US ENGLISH</RULE_NAME>
<PRIORITY>1</PRIORITY>
<CRITERIA>
<EXPRESSION>
<TYPE>TE</TYPE>
<COLUMN_NAME>Locale</COLUMN_NAME>
<OPERATORS>=</OPERATORS>
<VALUES>US ENGLISH</VALUES>
<AND_OR/>
<LEFT_PARENS/>
<RIGHT_PARENS/>
</EXPRESSION>
</CRITERIA>
<CONTENTS>
<CONTENT name=”US_ENGLISH.MAILING
BODY” content_area=”MAILING BODY”>&lt;p>This is the US English Newsletter.&lt;/p>&lt;p>&lt;img
style=”border: 1px solid ;” src=”http://domain.com/images/us_flag.jpg” name=”usa.jpg” spname=”usa.jpg”
alt=”” width=”127″ height=”90″>&lt;/p></CONTENT>
</CONTENTS>
</RULE>
<RULE>
<RULE_NAME>UK_ENGLISH</RULE_NAME>
<PRIORITY>2</PRIORITY>
<CRITERIA>
<EXPRESSION>
<TYPE>TE</TYPE>
<COLUMN_NAME>Locale</COLUMN_NAME>
<OPERATORS>=</OPERATORS>
<VALUES>UK ENGLISH</VALUES>
<AND_OR/>
<LEFT_PARENS/>
<RIGHT_PARENS/>
</EXPRESSION>
</CRITERIA>
<CONTENTS>
<CONTENT name=”UK_ENGLISH.MAILING
BODY” content_area=”MAILING BODY”>&lt;p>This is the UK English Content.&lt;/p>&lt;p>&lt;img
src=”http://domain.com/images/uk_flag.jpg” spname=”ukflag.jpg” alt=”” width=”143″ border=”0″
height=”107″>&lt;/p></CONTENT>
</CONTENTS>
</RULE>
<RULE>
<RULE_NAME>CAN_FRENCH</RULE_NAME>
<PRIORITY>3</PRIORITY>
<CRITERIA>
<EXPRESSION>
<TYPE>TE</TYPE>
<COLUMN_NAME>Locale</COLUMN_NAME>
<OPERATORS>=</OPERATORS>
<VALUES>CAN FRENCH</VALUES>
<AND_OR/>
<LEFT_PARENS/>
<RIGHT_PARENS/>
</EXPRESSION>
</CRITERIA>
<CONTENTS>
<CONTENT name=”CAN_FRENCH.MAILING
BODY” content_area=”MAILING BODY”><![CDATA[<p>This is the French Canadian content.</p><p><img
style=”border: 1px solid ;” src=”http://domain.com/images/can_french.jpg” name=”can.jpg”
spname=”can.jpg” alt=”” width=”141″ height=”106″></a></p>]]></CONTENT>
</CONTENTS>
</RULE>
</RULES>
</RULESET>
</RESULT>
</envelope:Body>
</envelope:Envelope> 
   

Replace a Dynamic Content Ruleset

ReplaceDCRuleset

This interface replaces an existing Ruleset with newly specified parameters.

Note: A ruleset cannot contain more than 1,000 rules.

Operation  <ReplaceDCRuleset>   
Elements  RULESET_ID  The ID of the Ruleset to replace. 
  CONTENT_AREAS  See AddDCRuleset for details. 
  RULES  See AddDCRuleset for details. 
Example  <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:ses=”SilverpopApi:EngageService.SessionHeader”
xmlns:user=”SilverpopApi:EngageService.MailManagement.UserActions”>
<soapenv:Header>
<ses:sessionHeader>
<ses:sessionid>06395F3FA6D07365CBA5D01AF14F3F56</ses:sessionid>
</ses:sessionHeader>
</soapenv:Header>
<soapenv:Body>
<user:ReplaceDCRuleset>
<user:RULESET_ID>548403</user:RULESET_ID>
<user:CONTENT_AREAS>
<user:CONTENT_AREA type=”Body‐HTML” name=”MAILING BODY”>
<user:DEFAULT_CONTENT name=”Default.MAILING
BODY”><![CDATA[<p>This is the REVISED content for people whose Locale is unknown….</p><p><img
src=”http://domain.com/images/question_mark.jpg” name=”question.jpg” spname=”question.jpg” alt=””
width=”97″ border=”0″ height=”145″></p>]]></user:DEFAULT_CONTENT>
</user:CONTENT_AREA>
</user:CONTENT_AREAS>
<user:RULES>
<user:RULE>
<user:RULE_NAME>US ENGLISH</user:RULE_NAME>
<user:PRIORITY>1</user:PRIORITY>
<user:CRITERIA>
<user:EXPRESSION>
<user:AND_OR/>
<user:LEFT_PARENS/>
<user:TYPE>TE</user:TYPE>
<user:COLUMN_NAME>Locale</user:COLUMN_NAME>
<user:OPERATORS><![CDATA[=]]></user:OPERATORS>
<user:VALUES><![CDATA[US
ENGLISH]]></user:VALUES>
<user:RIGHT_PARENS/>
</user:EXPRESSION>
</user:CRITERIA>
<user:CONTENTS>
<user:CONTENT content_area=”MAILING BODY”
name=”US_ENGLISH.MAILING BODY”><![CDATA[<p>This is the REVISED US English
Newsletter.</p><p><img style=”border: 1px solid ;” src=”http://domain.com/images/us_flag.jpg”
name=”usa.jpg” spname=”usa.jpg” alt=”” width=”127″ height=”90″></p>]]></user:CONTENT>
</user:CONTENTS>
</user:RULE>
<user:RULE>
<user:RULE_NAME>UK_ENGLISH</user:RULE_NAME>
<user:PRIORITY>2</user:PRIORITY>
<user:CRITERIA>
<user:EXPRESSION>
<user:AND_OR/>
<user:LEFT_PARENS/>
<user:TYPE>TE</user:TYPE>
<user:COLUMN_NAME>Locale</user:COLUMN_NAME>
<user:OPERATORS><![CDATA[=]]></user:OPERATORS>
<user:VALUES><![CDATA[UK
ENGLISH]]></user:VALUES>
<user:RIGHT_PARENS/>
</user:EXPRESSION>
</user:CRITERIA>
<user:CONTENTS>
<user:CONTENT content_area=”MAILING BODY”
name=”UK_ENGLISH.MAILING BODY”><![CDATA[<p>This is the REVISED UK English
Content.</p><p><img src=”http://domain.com/images/uk_flag.jpg” spname=”ukflag.jpg” alt=”” width=”143″
border=”0″ height=”107″></p>]]></user:CONTENT>
</user:CONTENTS>
</user:RULE>
<user:RULE>
<user:RULE_NAME>CAN_FRENCH</user:RULE_NAME>
<user:PRIORITY>3</user:PRIORITY>
<user:CRITERIA>
<user:EXPRESSION>
<user:AND_OR/>
<user:LEFT_PARENS/>
<user:TYPE>TE</user:TYPE>
<user:COLUMN_NAME>Locale</user:COLUMN_NAME>
<user:OPERATORS><![CDATA[=]]></user:OPERATORS>
<user:VALUES><![CDATA[CAN
FRENCH]]></user:VALUES>
<user:RIGHT_PARENS/>
</user:EXPRESSION>
</user:CRITERIA>
<user:CONTENTS>
<user:CONTENT content_area=”MAILING BODY”name=”CAN_FRENCH.MAILING BODY”><![CDATA[<p>This is the REVISED French Canadian
content.</p><p><img style=”border: 1px solid ;” src=”http://domain.com/images/can_french.jpg”
name=”can.jpg” spname=”can.jpg” alt=”” width=”141″ height=”106″></a></p>]]></user:CONTENT>
</user:CONTENTS>
</user:RULE>
</user:RULES>
</user:ReplaceDCRuleset>
</soapenv:Body>
</soapenv:Envelope> 
 
Response  <RESULT>   
Elements  SUCCESS 

“True” indicates successful rule creation.

“False” indicates an error occurred and the error code displays with a message
reporting the issue. 

  RULESET_ID  Contains the new Ruleset ID. 
Example  <envelope:Envelope xmlns=”SilverpopApi:EngageService.MailManagement.UserActions”
xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
<envelope:Header/>
<envelope:Body>
<RESULT>
<SUCCESS>TRUE</SUCCESS>
<RULESET_ID>548403</RULESET_ID>
</RESULT>
</envelope:Body>
</envelope:Envelope> 
 

Validate a Dynamic Content Ruleset

ValidateDCRuleset

This interface performs a validation check against all Dynamic Content Rulesets (including nested Rulesets) associated with the specified mailing. The validation check ensures that all placeholders and criteria matchthe specified mailing and its Rulesets.

Operation  <ValidateDCRuleset>   
Elements  MAILING_ID  Mailing ID for a mailing with one or more associated Rulesets. 
Example  <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:ses=”SilverpopApi:EngageService.SessionHeader”
xmlns:user=”SilverpopApi:EngageService.MailManagement.UserActions”>
<soapenv:Header>
<ses:sessionHeader>
<ses:sessionid>06395F3FA6D07365CBA5D01AF14F3F56</ses:sessionid>
</ses:sessionHeader>
</soapenv:Header>
<soapenv:Body>
<user:ValidateDCRuleset>
<user:MAILING_ID>1866986</user:MAILING_ID>
</user:ValidateDCRuleset>
</soapenv:Body>
</soapenv:Envelope> 
 
Response <RESULT>   
Elements  SUCCESS 

“True” indicates the mailing and all related Dynamic Content is valid.

“False” indicates that Engage will display a collection of errors. 

  MAILING_ID  Represents the mailing against which Watson campaign Automation performed a validation. 
  ERRORS 

Displayed when the SUCCESS parameter is set to “False.”

Represents the collection of errors resulting from the validation. 

Example  <envelope:Envelope xmlns=”SilverpopApi:EngageService.MailManagement.UserActions”
xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
<envelope:Header/>
<envelope:Body>
<RESULT>
<SUCCESS>TRUE</SUCCESS>
</RESULT>
</envelope:Body>
</envelope:Envelope> 
 

Delete a Dynamic Content Ruleset

DeleteDCRuleset

This interface deletes the specified Ruleset from the Asset Library. You can only delete Rulesets that are not associated with a mailing. If you attempt to delete a mailing’s Ruleset, you will receive an error indicating the reason for failure (the Ruleset is currently associated with a mailing). If the desired result is to delete the Ruleset in order to update its content, utilize the ReplaceDCRuleset operation.

Operation  <DeleteDCRuleset>   
Elements  RULESET_ID  The ID of the Ruleset to delete. 
Example  <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:ses=”SilverpopApi:EngageService.SessionHeader”
xmlns:user=”SilverpopApi:EngageService.MailManagement.UserActions”>
<soapenv:Header>
<ses:sessionHeader>
<ses:sessionid>06395F3FA6D07365CBA5D01AF14F3F56</ses:sessionid>
</ses:sessionHeader>
</soapenv:Header>
<soapenv:Body>
<user:DeleteDCRuleset>
<user:RULESET_ID>9923621</user:RULESET_ID>
</user:DeleteDCRuleset>
</soapenv:Body>
</soapenv:Envelope> 
 
Response  <RESULT>   
Elements  SUCCESS 

“True” indicates successful Ruleset deletion.

“False” indicates an error occurred and the error code displays with a message
reporting the issue. 

Example  <envelope:Envelope xmlns=”SilverpopApi:EngageService.MailManagement.UserActions”
xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
<envelope:Header/>
<envelope:Body>
<RESULT>
<SUCCESS>TRUE</SUCCESS>
</RESULT>
</envelope:Body>
</envelope:Envelope> 
 

Get a List of Mailing Templates

GetMailingTemplates

This interface extracts a list of Shared or Private mailing templates for your Organization. The templates returned may be limited by the date they were last modified.

Operation  <GetMailingTemplates>     
Elements   VISIBILITY Defines the visibility of the mailing templates to return.
0 – Private
1 – Shared 
 
  LAST_MODIFIED_START_DATE  Optional  Start Date used to filter mailing templates by the date and time the mailing template was last modified. 
  LAST_MODIFIED_END_DATE  Optional  End Date used to filter mailing templates by the date and time the mailing template was last modified. 
Example  <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:ses=”SilverpopApi:EngageService.SessionHeader”
xmlns:user=”SilverpopApi:EngageService.MailManagement.UserActions”>
<soapenv:Header>
<ses:sessionHeader>
<ses:sessionid>06395F3FA6D07365CBA5D01AF14F3F56</ses:sessionid>
</ses:sessionHeader>
</soapenv:Header>
<soapenv:Body>
<user:GetMailingTemplates>
<user:VISIBILITY>0</user:VISIBILITY>
<user:LAST_MODIFIED_START_DATE>05/01/2009
13:00:00</user:LAST_MODIFIED_START_DATE>
<user:LAST_MODIFIED_END_DATE>07/31/2009
12:59:59</user:LAST_MODIFIED_END_DATE>
</user:GetMailingTemplates>
</soapenv:Body>
</soapenv:Envelope> 
   
Response  <RESULT>     
Elements  SUCCESS  True if successful.   
  MAILING_TEMPLATE  XML nodes defining the instances of each mailing template.   
  Child Element  MAILING_ID  Returns the ID of the mailing template. 
    MAILING_NAME  Returns the name of the mailing template. 
    SUBJECT  The subject line of the mailing template. 
    LAST_MODIFIED  Returns the date and time when the mailing template was last modified. 
    VISIBILITY  Returns the visibility of the mailing template (Shared or
Private). 
    USER_ID Returns the User ID for the mailing template owner. 
Example  <envelope:Envelope xmlns=”SilverpopApi:EngageService.MailManagement.UserActions”
xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
<envelope:Header/>
<envelope:Body>
<RESULT>
<SUCCESS>TRUE</SUCCESS>
<MAILING_TEMPLATE>
<MAILING_ID>939383</MAILING_ID>
<MAILING_NAME>DLL Mailing 2</MAILING_NAME>
<LAST_MODIFIED>05/12/09 08:15 AM</LAST_MODIFIED>
<VISIBILITY>Private</VISIBILITY>
<USER_ID>1efe4ac‐112532f31ca-f528764d624db129b32c21fbca0cb8d6</USER_ID>
<FLAGGED_FOR_BACKUP>false</FLAGGED_FOR_BACKUP>
</MAILING_TEMPLATE>
<MAILING_TEMPLATE>
<MAILING_ID>1866584</MAILING_ID>
<MAILING_NAME>test rt again</MAILING_NAME>
<LAST_MODIFIED>05/21/09 01:16 PM</LAST_MODIFIED>
<VISIBILITY>Private</VISIBILITY>
<USER_ID>1efe4ac‐112532f31caf528764d624db129b32c21fbca0cb8d6</
USER_ID>
<FLAGGED_FOR_BACKUP>false</FLAGGED_FOR_BACKUP>
</MAILING_TEMPLATE>
<MAILING_TEMPLATE>
<MAILING_ID>2605309</MAILING_ID>
<MAILING_NAME>Test Ampersand Issue</MAILING_NAME>
<LAST_MODIFIED>07/10/09 03:23 PM</LAST_MODIFIED>
<VISIBILITY>Private</VISIBILITY>
<USER_ID>1efe4ac‐112532f31caf528764d624db129b32c21fbca0cb8d6</
USER_ID>
<FLAGGED_FOR_BACKUP>false</FLAGGED_FOR_BACKUP>
</MAILING_TEMPLATE>
</RESULT>
</envelope:Body>
</envelope:Envelope> 
   

Export a Mailing Template

ExportMailingTemplate

This interface exports a mailing template. The results are an .stl file (a zip file containing XML with a Silverpop Template extension) which will be written to the FTP account associated with the current session. You can (optionally) copy the resulting file to Stored Files.

Operation  <ExportMailingTemplate>     
Elements TEMPLATE_ID  Numeric identifier for the mailing template to be exported.   
  ADD_TO_STORED_FILES  Optional 

Use the ADD_TO_STORED_FILES parameter to write the
output to the stored files folder within Watson Campaign Automation.

Omitting the ADD_TO_STORED_FILES parameter will cause
export files to be moved to the user’s FTP space, under the download directory. 

Example  <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:ses=”SilverpopApi:EngageService.SessionHeader”
xmlns:user=”SilverpopApi:EngageService.MailManagement.UserActions”>
<soapenv:Header>
<ses:sessionHeader>
<ses:sessionid>06395F3FA6D07365CBA5D01AF14F3F56</ses:sessionid>
</ses:sessionHeader>
</soapenv:Header>
<soapenv:Body>
<user:ExportMailingTemplate>
<user:TEMPLATE_ID>2605309</user:TEMPLATE_ID>
<user:ADD_TO_STORED_FILES/>
</user:ExportMailingTemplate>
</soapenv:Body>
</soapenv:Envelope> 
   
Response   <RESULT>    
Elements   SUCCESS TRUE if successful   
  FILE_PATH  Returns the file path and name of the export file.   
Example  <envelope:Envelope xmlns=”SilverpopApi:EngageService.MailManagement.UserActions”
xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
<envelope:Header/>
<envelope:Body>
<RESULT>
<SUCCESS>TRUE</SUCCESS>
<FILE_PATH>/download/My Mailing Template.stl</FILE_PATH>
</RESULT>
</envelope:Body>
</envelope:Envelope> 
   

Join The Discussion

Your email address will not be published. Required fields are marked *