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".


XML Request Example:

<?xml version="1.0" encoding="UTF-8"?>
    <email>{*email_address*}</email> <!-- required -->
    <list>{*list_id*}</list> <!-- required -->
    <note> <!-- required: at least one -->
      <content>{*note_content_text*}</content> <!-- required -->
      <content>{*note_content_text*}</content> <!-- required -->

<xmlrequest> element

Field NameDescription
usernameUsername used to login to Pinpointe
usertokenUnique token assigned to Pinpointe account

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 NameDescription
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.


<note> element

Field NameDescription
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 NameDescription
statusWill return SUCCESS if note(s) was / were successfully added and / or updated.
Will return quantity of successfully added / updated notes and the quantity of any failed adds / updates.

Unsuccessful Response:

<response> element

Field NameDescription
statusWill return FAILED if unsuccessful
errormessageText explaining why request failed