Retrieve the data from one user's custom fields.
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>GetSubscriberCustomFields</requestmethod>
<details>
<subscriberid>113100</subscriberid> <!-- required -->
<list>123456</list> <!-- required -->
<customfield>8,64</customfield>
</details>
</xmlrequest><xmlrequest> element
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Subscribers |
| requestmethod | GetSubscriberCustomFields |
Please note: ALL OPTIONAL tags that are not used should be deleted from submitted call. For example, if no <customfield> value is inserted, the <customfield> tags should be deleted.
<details> element
| Field Name | Description |
| subscriberid* (Required) | ID of a subscriber in the list |
| list (Required) | ID of list contact is in |
| customfield | Comma-separated list of custom field IDs. NOTE: while technically not required for a successful API return response, user MUST specify the custom field ID they wish to retrieve data for. |
*To get subscriber id, go to Contacts => Manage Databases => View Contacts.
Hover cursor over one of the links to the right of the contact, such as 'View'.
Note the number at the end of the URL after the '=' at the bottom of the browser window.
That number is the 'subscriber ID'.
Successful Response:
<response> element
| Field Name | Description |
| status | Will return SUCCESS if subscriber and list successfully found |
<data>
<item> element
| Field Name | Description |
| fieldid | ID number of custom field |
| fieldname | Name of custom field |
| fieldtype | Data type of field |
| fieldsettings | Serialized version of the custom field's settings |
| subscriberid | ID of the subscriber |
| data | The value of the custom field for this subscriber |
Unsuccessful Response:
<response> element
| Field Name | Description |
| status | Will return FAILED if unsuccessful |
| errormessage | Text explaining why request failed |