Adds notes to a subscribers.
JSON Request Example:
/** * Lists::AddSubscriberNotes * * Add notes to a subscriber. * * email [email, required]: subscriber email * list [int, required]: subscriber list id * note [array of objects, required] * noteid [int, optional]: note id, if given, that note is updated * content [string, required]: note content */ { "username": "Bob", "usertoken": "X", "requesttype": "Lists", "requestmethod": "AddSubscriberNotes", "details": { "email": "{*email_address*}", /* required */ "list": "{*list_id*}", /* required */ "note": [ { /* required: at least one */ "noteid": "{*note_id*}", "content": "{*note_content_text*}" /* required */ }, { "noteid": "{*note_id*}", "content": "{*note_content_text*}" /* required */ } ] } }
"json_request" element
Field Name | Description |
username | Username used to login to Pinpointe |
usertoken | Unique token assigned to Pinpointe account |
requesttype | Lists |
requestmethod | AddSubscriberNotes |
Please note: ALL OPTIONAL elements that are not used should be deleted from submitted call. For example, if "list" element is used, "name": "{*list_name*}" should be deleted.
"details" element
Field Name | Description |
email (required) | Email address of the subscriber |
list (Required) | Database mailing list with this ID number. |
note (at least one required) | noteid: add a note id to the subscriber content: add the content (the text of the note) to the subscriber |
Successful Response:
"response" element
Field Name | Description |
status | Will return SUCCESS if list was successfully found |
data | Quantity and content of notes added |
Unsuccessful Response:
"response" element
Field Name | Description |
status | Will return ERROR when unsuccessful |
errormessage | Text explaining why request failed |