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.
JSON Request Example:
"json_request" element
Field Name | Description |
username | Username used to login to Pinpointe |
usertoken | Unique token for this Pinpointe account |
requesttype | Name of API set to be used |
requestmethod | Function being called |
Please note: ALL OPTIONAL elements 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": "{*ip_address*}", 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 yes, 1 or true to mark user as confirmed. Do not include this JSON element to set as unconfirmed. |
"customfield" OPTIONAL
"fieldid", "value" elements - add values for a subscriber's custom fields. Use one "fieldid" and "value" pair per custom field.
NOTE: you may insert multiple "fieldid" and "value" pair elements to update multiple custom fields.
Field Name | Description |
fieldid | ID of custom field to be added or updated |
value | Value of this custom field |
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 |