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

JSON Request Example:     

{
  "username": "JohnDoe",
  "usertoken": "abc123abc123abc123abc123",
  "requesttype": "Subscribers",
  "requestmethod": "UpdateSubscriber",
  "details": {
    "email": "{*email_address*}", /* required */
    "list": "{*list_id*}", /* required */
    "newemail": "{*new_email_address*}",
    "tag": ["{*tag_id or tag_name*}", "{*tag_id or tag_name*}"],
    "format": "{*email_format*}",
    "ipaddress": "{*ip_address*}",
    "confirmed": "{*confirmed_boolean*}",
    "customfield":
    [
      {
        "fieldid": "{*custom_field_id*}",
        "value": "{*custom_field_value*}"
      },
      {
        "fieldid": "{*custom_field_id*}",
        "value": "{*custom_field_value*}"
      }
    ],
    "return_data": "{*return_data_boolean*}",
    "include_membership": "{*include_membership_boolean*}"
  }
}
Null

 

"json_request" element


Field NameDescription
usernameUsername used to login to Pinpointe
usertokenUnique token for this Pinpointe account
requesttypeSubscribers
requestmethodUpdateSubscriber


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

"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


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