Add one subscriber to a pre-existing mailing list. Set subscriber details email address, confirmation status and optional custom fields. You can specify whether to add that subscriber to autoresponders and whether they will receive HTML or text-based mailings.


XML Request Example:    

<?xml version="1.0" encoding="UTF-8"?>
<xmlrequest>
  <username>username@yourcompany.com</username>
  <usertoken>get-token-from-support</usertoken>
  <requesttype>Lists</requesttype>
  <requestmethod>AddSubscriberToList</requestmethod>
  <details>
      <email>{email_address}</email> <!-- required -->
      <list>{list_id}</list> <!-- required -->
      <add_to_autoresponders>{add_to_autoresponders_boolean}</add_to_autoresponders> <!-- required -->
      <option_update_if_exists>{update_if_exists_boolean}</option_update_if_exists> <!-- required -->
      <format>{email_format}</format>
      <ipaddress>{ip_address}</ipaddress>
      <confirmed>{confirmed_boolean}</confirmed>
      <send_confirmation>{send_confirmation_boolean}</send_confirmation> <!-- required -->
      <tag>{tag_id}</tag>
      <tag>{tag_id}</tag>
      <customfield>
           <fieldid>{custom_field_id}</fieldid>
           <value>{custom_field_value}</value>
      </customfield>
      <customfield>
           <fieldid>{custom_field_id}</fieldid>
           <value>{custom_field_value}</value>
      </customfield>
  </details>
</xmlrequest>

 <xmlrequest> element


Field NameDescription
usernameUsername used to login to Pinpointe
usertokenUnique token assigned to Pinpointe account
requesttypeName of API set to be used
requestmethodFunction being called


<details> element


Field NameDescription
emailaddressAddress of contact to be added
option_update_if_exists (Required)Set as yes to update contact custom fields and tags, instead of generating an error when an email address already appears in list.
add_to_autoresponders (Required)Adds contact to autoresponders, if they exist.   If you do not wish to add contact to autoresponders, enter a value of false.
mailinglistidAdd contact to the mailing list with this ID number
confirmed (Required)Use <confirmed>yes</confirmed> to mark user as confirmed. Do not include this XML element to leave user unconfirmed.
format

Use html to send user HTML emails or text for plain-text

tag (optional)Use one or more elements to assign tags to this subscriber. Values can be the tag's numeric ID or the tag name.
send_confirmation (Required)
Use  <send_confirmation>no</send_confirmation> if <confirmed>yes</confirmed>.  


<customfields>

<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
valueValue of this custom field


Successful Response:


<response> element


Field NameDescription
statusWill return SUCCESS if user was successfully added
dataContact ID number