MPZ API > Add Campaign

Use the API to add a new campaign.

Request

Submit an XML Request with the following details:
Post URL: https://mpzmail.com/api/v3.0/campaigns/addCampaign/
Fields to Post
apiKey String REQUIRED The APIKey of the requesting user.
groupID Int REQUIRED The ID of the group you would like to send to.
segmentID Int OPTIONAL The ID of a segment in the group you would like to send to.
subscriberID Int OPTIONAL The ID of a subscriber in the group you would like to send to. This will send the campaign to just one subscriber regardless of segment.
newsletterID Int REQUIRED The ID of the newsletter you would like to send.
campaignName String REQUIRED A friendly name for the Campaign
senderName String REQUIRED The name of the sender which will be shown on the email.
senderEmail String REQUIRED The email address the email should be sent from.
fromEmail String OPTIONAL Sets the RETURN-PATH email header.
subject String REQUIRED The email subject that will be sent.
startDate Date Time REQUIRED The start time of the campaign. yyyy-mm-dd hh:mm
includeFooter Int OPTIONAL Whether to include the default footer (Unsubscribe,Send to Friend, Report as Junk) at the bottom of your email template. Set to 1 to include, set to 0 to not include.

Response

Data Sent Back
error Int Indicates wether an error has occured. 0 for no error. 1 for error.
status String If there's been an error, a text description of the error that occured will be here.
campaignID Int If the campaign has been added succesfully, the ID of the new campaign.
totalSubscribers Int The total number of subscribers sent to.

Sample request XML

<xml>
     <apiKey>44-121312131223</apiKey>
     <groupID>432</groupID>
     <newsletterID>313</newsletterID>
     <campaignName>Sample Campaign</campaignName>
     <senderName>My Name</senderName>
     <senderEmail>myemail@address.com</senderEmail>
     <subject>Welcome to my newsletter</subject>
     <startDate>2014-06-01 12:00</startDate>
</xml>

Sample response XML

<xml>
     <error>0</error>
     <status>success</status>
     <campaignID>1213</campaignID>
     <totalSubscribers>4213</totalSubscribers>
</xml>

Comments