Upload a new campaign, specified by its name, subject, HTML body, text body, and format.


XML Request Example:             

<?xml version="1.0" encoding="UTF-8"?>
<xmlrequest>
   <username>admin</username>
   <usertoken>abc123abc123abc123abc123abc123abc123abc123abc123</usertoken>
   <requesttype>newsletters</requesttype>
   <requestmethod>UploadCampaign</requestmethod>
   <details>
      <name>My New Email Campaign</name>
      <subject>10 Reasons to Read This Email</subject>
      <htmlbody>&lt;body&gt;Hello&lt;/body&gt;</htmlbody>
      <textbody>Hello</textbody>
      <format>b</format>
      <active>1</active>
      <archive>0</archive>
   </details>
   <listid>69</listid>
</xmlrequest>

 <xmlrequest> element


Field Name Description
username Username used to login to Pinpointe
usertoken Unique token assigned to Pinpointe account
requesttype Name of API set to be used
requestmethod Function being called


<details> element


Field Name Description
name ID of campaign to send
subject ID of list that will receive campaign
htmlbody Email body in HTML format. Ensure data is HTML-encoded so XML request will parse correctly
textbody Email body in text format. Ensure data is HTML-encoded  so XML request will parse correctly
format Specify which format(s) to send. Use h for HTML, t for text, or b for both
active Use 1 to mark the campaign active and 0 for inactive
archive Use 1 to archive the campaign and 0 to not


Successful Response:


<response> element


Field Name Description
status Will return SUCCESS if user was successfully added
data ID number of new campaign
version Version number of API used


Successful Response Example:

 

<response>
   <status>SUCCESS</status>
   <data>18493</data>
   <version>3.0</version>
</response>

 

Unsuccessful Response:


<response> element


Field Name Description
status Will return ERROR if unsuccessful
errormessage Text explaining why request failed