Validates Newsletter details.
JSON Request Example:
* Newsletters::ValidateNewsletter
*
* Validate the given newsletter details.
*
* newsletterid [required* - int] -- selected newsletter
* newslettername [required* - string] -- selected newsletter
* *Exactly one of either newsletterid or newslettername is required
*
* sendfromemail [optional - string] -- send-from email to be used when sent
* sendmultipart [optional - string] -- send as multipart, default true
*/
{
"username": "bob",
"usertoken": "abc",
"requesttype": "Newsletters",
"requestmethod": "ValidateNewsletter",
"details": {
"newsletterid": "{*newsletter_id*}", /* required if no newslettername */
"newslettername": "{*newsletter_name*}", /* required if no newsletterid */
"sendfromemail": "{*send_from_email*}",
"sendmultipart": "{*bool*}"
}
}json_request element
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Newsletters |
| requestmethod | ValidateNewsletter |
details element
| Field Name | Description |
| newsletterid (required if no newsletter name) | Newsletter id |
| newslettername (required if no newsletterid) | Name of Newsletter |
| sendfromemail (optional) | Send-from email address |
| sendmultipart (optional) | Was the newsletter sent as a mutli-part? (True or False; default True) |
Successful Response
response element
| Field Name | Description |
| status | Returns SUCCESS when successful |
Unsuccessful Response
response element
| Field Name | Description |
| status | Returns FAILED when unsuccessful |
| errormessage | Text explaining that the link is invalid |