Update one subscriber who is already a member of a mailing list. Set their email address, confirmation status and optional custom fields. You can also specify whether they will receive HTML or text-based mailings.


PLEASE NOTE: THIS METHOD CAN BE USED TO UPDATE AN EXISTING CONTACT'S EMAIL ADDRESS BUT WILL NOT MODIFY THE SUBSCRIBER ID.


XML Request Example: 


<?xml version="1.0" encoding="UTF-8"?>
<xmlrequest>
  <username>DRB-Test</username>
  <usertoken>a1de7f1e68e24201ad22a0cb166eee90c969237e</usertoken>
  <requesttype>Lists</requesttype>
  <requestmethod>UpdateSubscriber</requestmethod>
  <details>
    <email>{*email_address*}</email> <!-- required -->
    <list>{*list_id*}</list> <!-- required -->
    <newemail>{*new_email_address*}</newemail>
    <tag>{*tag_id or tag_name*}</tag>
    <tag>{*tag_id or tag_name*}</tag>
    <format>{*email_format*}</format>
    <ipaddress>{*ip_address*}</ipaddress>
    <confirmed>{*confirmed_boolean*}</confirmed>
    <customfield>
      <fieldid>{*custom_field_id*}</fieldid>
      <value>{*custom_field_value*}</value>
    </customfield>
    <customfield>
      <fieldid>{*custom_field_id*}</fieldid>
      <value>{*custom_field_value*}</value>
    </customfield>
    <return_data>{*return_data_boolean*}</return_data>
    <include_membership>{*include_membership_boolean*}</include_membership>
  </details>
</xmlrequest>

  <xmlrequest> element


Field NameDescription
usernameUsername used to login to Pinpointe
usertokenUnique token for this Pinpointe account
requesttypeName of API set to be used
requestmethodFunction being called


Please note: ALL OPTIONAL tags that are not used should be deleted from submitted call. For example, if no IP address will be supplied as part of the call, <ipaddress></ipaddress> should be deleted. 


<details> element


Field NameDescription
email
(Required)
Email address of contact to be updated
list
(Required)
List id of list contact belongs to.
newemail
(Optional)
New email to use for subscriber
tag
(Optional)
tag is or tag name subscriber is to be added to. Can specify more than one.
format
(Optional)
Use html to send user HTML emails or text for plain-text
ipaddress
(Optional)
new IP address of subscriber
confirmed (Optional)Use yes, 1 or true to mark user as confirmed. Do not include this XML element to set as unconfirmed.


<customfield> Note: Can use more than one set of <customfield></customfield> tags.

<item> element - add values for a subscriber's custom fields. Use one item element per field.


Field NameDescription
fieldidID of custom field to be added or updated
valueValue of this custom field


Successful Response:


<response> element


Field NameDescription
statusWill return SUCCESS if user was successfully updated
dataContact ID number



Unsuccessful Response:


<response> element


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