Add or update notes for a subscriber which can be viewed in the application's GUI in the CONTACT DETAILS section.
Note: This API call can also be found under the requesttype of "Lists".
JSON request example:
{
"username": "JohnDoe",
"usertoken": "abc123abc123abc123abc123",
"requesttype": "Subscribers",
"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 */
}
]
}
}"jsonrequest" element
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Subscribers |
| requestmethod | AddSubscriberNotes |
Please note: ALL OPTIONAL elements that are not used should be deleted from submitted call. For example, if user is adding a NEW note so that <noteid> element not required, it should be deleted. Likewise, if only one note is to be added or updated, user should deleted the second option <note> element and its "child" element contents.
"details" element
| Field Name | Description |
| email (Required) | Email address of the subscriber to whom the note is being added or updated. |
| list (Required) | The ID of the list the subscriber is in. |
"details"
"note" element
| Field Name | Description |
| noteid | If an existing note is to be edited, the user must supply that note's ID. All note IDs for a subscriber can be retrieved by using the GetSubscriberNotes API call. |
| content (required) | The contents of the new note or the to-be-updated note. |
Successful Response:
"response" element
| Field Name | Description |
| status | Will return SUCCESS if note(s) was / were successfully added and / or updated. |
| data | Will return quantity of successfully added / updated notes and the quantity of any failed adds / updates. |
Unsuccessful Response:
"response> element
| Field Name | Description |
| status | Will return FAILED if unsuccessful |
| errormessage | Text explaining why request failed |