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><body>HTML Content</body></htmlbody>*
      <textbody>Hello</textbody>*
      <format>b</format>
      <active>1</active>
      <archive>0</archive>
      <approved>1</approved>
   </details>
</xmlrequest>



 <xmlrequest> element


Field NameDescription
usernameUsername used to login to Pinpointe
usertokenUnique token assigned to Pinpointe account
requesttypeName of API set to be used
requestmethodFunction being called


<details> element


Field NameDescription
nameName of the Campaign being created
subjectEmail Subject of the Campaign being created
htmlbodyEmail body in HTML format. Ensure data is HTML-encoded so XML request will parse correctly* The code will go between the [CDATA[  and  ]] characters.
textbodyEmail body in text format. Ensure data is HTML-encoded  so XML request will parse correctly* The code will go between the [CDATA[  and  ]] characters.
formatSpecify which format(s) to send. Use h for HTML, t for text, or b for both
approved
Enter 1, yes or true for affirmative; 0, no, or false for negative
activeEnter 1, yes or true for affirmative; 0, no, or false for negative
archiveEnter 1, yes or true for affirmative; 0, no, or false for negative


Successful Response:


<response> element


Field NameDescription
statusWill return SUCCESS if template code was successfully added
dataID number of new campaign
versionVersion number of API used


Successful Response Example:

 

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


Null

 

Unsuccessful Response:


<response> element


Field NameDescription
statusWill return ERROR if unsuccessful
errormessageText explaining why request failed