Add one or more subscribers to a preexisting mailing list. Set subscriber details email address, confirmation status and optional custom fields. You can specify whether to add that subscriber to autoresponders, whether they will receive HTML or text-based mailings, or if they should be tagged.
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>AddSubscribersToList</requestmethod>
<details>
<list>123456</list> <!-- a global or contact specific list-id is required for each contact -->
<tag>456</tag>
<add_to_autoresponders>yes</add_to_autoresponders>
<send_confirmation>1</send_confirmation>
<update_if_exists>true</update_if_exists>
<contact> <!-- at least one required -->
<email>[email protected]</email> <!-- required -->
<tag>789</tag>
<tag>135</tag>
<confirmed>1</confirmed>
<customfield>
<fieldid>2</fieldid>
<value>John</value>
</customfield>
<customfield>
<fieldid>3</fieldid>
<value>Doe</value>
</customfield>
</contact>
<contact>
<email>[email protected]</email> <!-- required -->
<format>text</format>
<confirmed>no</confirmed>
<customfield>
<fieldid>2</fieldid>
<value>Jane</value>
</customfield>
<customfield>
<fieldid>3</fieldid>
<value>Smith</value>
</customfield>
</contact>
<return_data>1</return_data>
<include_membership>1</include_membership>
</details>
</xmlrequest>Null
<xmlrequest> element
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Subscribers |
| requestmethod | AddSubscribersToList |
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
Note: this section is to apply element values globally to all contacts for the API call. Corresponding element values entered as part of a contact-specific entry as described below will override these global values.
| Field Name | Description |
| list (Required globally or per contact) | Add all contacts to this global database mailing list with this ID number who do NOT have a contact-specific list-ID assign to them. See "list" description below under <contacts> section. |
| tag (optional global tag assignment) | Use one or more elements to assign global tag_id(s) to all subscribers who do NOT have a contact-specific tag_id assigned to them. Values can be the tag's numeric ID or the tag name. See "tag" description below under <contacts> section. |
| add_to_autoresponders (optional global tag assignment) | Globally adds all contacts to autoresponders, if they exist using true, 1 or yes. If you do not wish to add contacts to autoresponders, enter a value of false, 0 or no. false is default. Individual contacts may also be added to autoresponders. See "add_to_autoresponders" description below under <contacts> section. |
| send_confirmation (optional global tag assignment) | Globally directs system to send a confirming email. Use true, 1 or yes to automatically send confirmation email to contact if <confirmed> tag set to false, 0 or no. Set <send_confirmation> to false, 0 or no if you do NOT want to send a confirmation email. |
| update_if_exists (optional global tag assignment) | Set as true, 1 or yes to globally update all contacts' custom fields and tags. Default is false. If you attempt to update an existing contact field value without setting this to true, 1 or yes, system will throw an error. false is default. See "update_if_exists" description below under <contacts> section. |
<details>
<contact> element
| Field Name | Description |
| email address of contact to be added | |
| list (Required globally or per contact) | The list-ID of the database mailing list this specific contact should be added to. NOTE: contact-specific list-IDs will take precedence over the global list-ID specified under the global <details> section noted above. |
| tag | Use one or more elements to assign tag_id(s) to this specific contact. Values can be the tag's numeric ID or the tag name. NOTE: contact-specific tag_ids or tag_names will take precedence over the global tag_id or tag_name specified under the global <details> section noted above. |
| add_to_autoresponders | Adds this specific contact to autoresponders, if they exist using true, 1 or yes If you do not wish to add contact to autoresponders, enter a value of false, 0 or no. false is default. NOTE: This contact-specific value will take precedence over the global value if set above. |
| send_confirmation | Use true, 1 or yes to automatically send confirmation email to contact if <confirmed> tag set to false, 0 or no. Set <send_confirmation> to false, 0 or no if you do NOT want to send a confirmation email. |
| format | Use html to send user HTML emails or text for plain-text. html is the default. |
| ipaddress | Can add optional IP address. |
| confirmed | Use true, 1 or yes to mark user as confirmed or false, 0 or no for unconfirmed. true is default |
<customfield> OPTIONAL
<item> element - add values for a specific subscriber's custom fields. Use one item element pair per custom field.
NOTE: you may insert more than one pair of <customfield> tags to update multiple custom fields per subscriber added.
| Field Name | Description |
| fieldid | ID of custom field to be added. |
| value | Value of this custom field |
| Please note: If no custom field data is to be sent, please delete the <customfield> tags and all inner tags to avoid a submission error. |
"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 contact(s) was / were successfully added |
| data | Contact ID number |
Unsuccessful Response:
<response> element
| Field Name | Description |
| status | Will return FAILED if unsuccessful |
| errormessage | Text explaining why request failed |