This call allows the user to upload a Transient Suppression List.
JSON Request Example
/**
* Newsletters::UploadTransientList
*/
{
"username": "matbt@pinpointe.com",
"usertoken": "5eb8449c1a788fc27c955f8966dd495f519bd72f",
"requesttype": "Newsletters",
"requestmethod": "UploadSuppressionTransientList",
"details": {
"name": "{*transient_list_name*}",
"contacts": [
"{*email_address OR md5_hash_of_email_address*}",
"{*email_address OR md5_hash_of_email_address*}"
],
"ttl": "{*int_time_to_live*}"
}
}"json_request" element
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Newsletters |
| requestmethod | UploadSuppressionTransientList |
"details" element
| Field Name | Description |
| name (Required) | Name of the Transient Suppression List |
| contacts (required) | Emails address that populate the Transient Suppression List; (email address, md5 hash of email address) |
| ttl (required) | Time to Live is the number of days until the list expires from when it's created; default is 30. |
Please note: ALL OPTIONAL elements that are not used should be deleted from submitted call.
Successful Response:
"response" element
| Field Name | Description |
| status | Will return SUCCESS if the journey has been successfully created |
| data | Listid, count, failures, duplicates, and total of the uploaded Suppression Transient List. |
Unsuccessful Response:
"response" element
| Field Name | Description |
| status | Will return FAILED if unsuccessful |
| errormessage | Text explaining why request failed |