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.
Note: This API call can also be found under the requesttype of "Lists".
XML Request Example:
<?xml version="1.0" encoding="UTF-8"?>
<xmlrequest>
<username>JohnDoe</username>
<usertoken>abc123abc123abc123abc123</usertoken>
<requesttype>Subscribers</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 Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token for this Pinpointe account |
| requesttype | Subscribers |
| requestmethod | UpdateSubscriber |
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 Name | Description |
| 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 true, 1 or yes to mark an unconfirmed contact as "confirmed". Setting the value to false, 0 or no, or simply deleting the tag before submitting the call will not change an unconfirmed status. User may NOT change a confirmed contact to unconfirmed status. |
<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 Name | Description |
| fieldid | ID of custom field to be added or updated |
| value | Value of this custom field |
"return_data" and "include_membership" elements
| return_data | Setting this element's value to true, 1 or yes results in the API call returning an expanded body of subscriber data required by some applications. |
| include_membership | PieSync requirement: Setting this element's value to true, 1 or yes results in the API call adding a list of all tags that a subscriber is in as part of the returned information for that subscriber. |
Successful Response:
<response> element
| Field Name | Description |
| status | Will return SUCCESS if user was successfully updated |
| data | Contact ID number |
Unsuccessful Response:
<response> element
| Field Name | Description |
| status | Will return FAILED if unsuccessful |
| errormessage | Text explaining why request failed |