Upload a new campaign, specified by its name, subject, HTML body, text body, and format.
JSON Request Example:
PLEASE NOTE: JSON requires a stricter code format than XML. Please ensure that your template code conforms to the JSON requirements. Thank you.
"json_request" 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 | Name of the Campaign being created |
subject | Email Subject of the Campaign being created |
htmlbody | Email body in HTML format. Ensure data is HTML-encoded so XML request will parse correctly* The code will go between the [CDATA[ and ]] characters. |
textbody | Email body in text format. Ensure data is HTML-encoded so XML request will parse correctly* The code will go between the [CDATA[ and ]] characters. |
format | Specify 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 |
active | Enter 1, yes or true for affirmative; 0, no, or false for negative |
archive | Enter 1, yes or true for affirmative; 0, no, or false for negative |
Successful Response:
"response" element
Field Name | Description |
status | Will return SUCCESS if template code was successfully added |
data | ID number of new campaign |
version | Version number of API used |
Successful Response Example:
Unsuccessful Response:
"response" element
Field Name | Description |
status | Will return ERROR if unsuccessful |
errormessage | Text explaining why request failed |