CreateMailing

This document creates a new outbound email in Informz. A mailing can have n stories within it. When the mailing is published each story can be associated with a particular target group to facilitate dynamic content for subscribers. Once the mailing has been created, it can be published to email recipients using the ScheduleMailing action.

The example below illustrates a mailing comprised of three different stories. There can be an HTML version and a Text version of each story. Include all relevant HTML for the HTML version including external links to URLs and images.

Request

<ActionRequest xmlns="http://partner.informz.net/aapi/2009/08/">
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Password></Password>
 <Actions>
  <CreateMailing>
   <Name>New Fall Course Offerings</Name>
   <FriendlyFrom>Office of the Registrar</FriendlyFrom>
   <EmailFrom>registrar@test.edu</EmailFrom>
   <ReplyTo>registrar@test.edu</ReplyTo>
   <Subject>Exciting new fall courses</Subject>
   <TemplateID>1</TemplateID>
   <FolderName>FolderName1</FolderName>
   <Stories>
    <Story>
     <StoryID>1</StoryID>
     <Title>Title1</Title>
     <Rank>1</Rank>
     <HtmlContent>HtmlContent1</HtmlContent>
     <TextOnlyContent>TextOnlyContent1</TextOnlyContent>
    </Story>
    <Story>
     <StoryID>2</StoryID>
     <Title>Title2</Title>
     <Rank>2</Rank>
     <HtmlContent>HtmlContent2</HtmlContent>
     <TextOnlyContent>TextOnlyContent2</TextOnlyContent>
    </Story>
    <Story>
     <StoryID>3</StoryID>
     <Title>Title3</Title>
     <Rank>3</Rank>
     <HtmlContent>HtmlContent3</HtmlContent>
     <TextOnlyContent>TextOnlyContent3</TextOnlyContent>
    </Story>
   </Stories>
  </CreateMailing>
 </Actions>
</ActionRequest>

Details

Node Type Req'd? Unique? Description
<EmailFrom> String False False The sender’s email address
<FolderName> String False False The folder in which the mailing will be created.
<FriendlyFrom> String False False The display name associated with the sender’s email address
<HTMLContent> String True False The mailing content to be sent to the recipients.
<Name> String True False Descriptive name for the mailing
<Rank> Int False True The order of the stories within the collection. This is the order in which they will display within the mailing.
<ReplyTo> String False False The email address to send replies to
StoryID Int True True The Id of the Story
<Subject> String True False Mailing’s subject line seen by the recipient
<TemplateID> Int False False The template to use for this mailing.
<TextOnlyContent> String False False The text version of the mailing content. If this is not provided, Informz will generate its own text version from the supplied HTML content.
<Title> String True False A single story’s title

Notes

  1. A CreateMailing document will yield a Mailing type of mailing in the Informz UI
  2. HTML formatting characters (like '<') have to be replaced with XML encoded equivalents (like '&lt;')
  3. Personalization (aka "mail merge") field names can be embedded in <HTMLContent> and <TextContent>. These fields must have '%%' on either side of the name. These personalization field names will subsequently be used in the Headers section of the SubscriberData portion of the corresponding PublishMailing ActionRequest document. The matching data for each subscriber also appears in SubscriberData. (See below for an example.)
  4. Any hyperlinks must be validated by the user.
  5. Any images must be validated by the user. (Images are not hosted by Informz.)
  6. If no <FolderName> is supplied, the mailing will be created in the main folder for the brand.
  7. If the supplied <FolderName> has been deleted, an exception will be raised.
  8. If no <TemplateID> is supplied, the mailing will use the default template for the brand.
  9. If one of <EmailFrom>, <FriendlyFrom> and <ReplyTo> is supplied, they all must be supplied. If they are omitted, that envelope information will be taken from the template associated with the mailing.
  10. If the template used is an advanced template, for each <Story>, you must supply the name of a Location in a <Location> tag

Response

<?xml version="1.0" encoding="utf-16"?>

<ActionResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://partner.informz.net/aapi/2009/08/">
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Responses>
  <CreateMailing>
   <ActionStatus>
    <Status>success</Status>
    <Message xsi:type="xsd:string">Mailing created.</Message>
   </ActionStatus>
   <MailingID>134322</MailingID>
  </CreateMailing>
 </Responses>
</ActionResponse>

Node Type Description
<MailingID> Int The unique mailing ID in Informz. Use this to retrieve the mailing for editing, for deleting, and for scheduling the mailing for publishing.
<Message> String Further Description
<Status> Enumerated String Type Describes what occurred in Informz for the requested action (Possible Values:success, failure).