Function Call:

add_to_list

Purpose:

Returns in an array a list of all autoresponder list names to determine usage status .  Live, Disabled, Sending Paused or Prevent New Subscription

Parameters:

email_address
lists

JSON string with details of lists.  Each list can contain key / value pairs of:

“list” list name

Optional field values as below

format_preference

0 – Contact’s format preference
1 – Plain text
2 – HTML

next_message

– the number of next message to be sent if not the autoresponder default

status

– If status then

0
1
2
3
4
5

Status meaning

0 – Active
1 – Paused
2 – Cancelled
3 – Dropped
4 – Finished
5 – Failed

Return:

For each specified autoresponder / list:

name
status

Status – if error
eg.  Contact already subscribed to this list

Examples:

Add contact to list.

http://example.com/a.php/api/add_to_list?api_key=0c68398f&email_address=test@example.com&lists=[{"list":"Sales"}]

Add contact to one of more lists and defining the active status or the message to be sent or prefernce for mail type.

http://example.com/a.php/api/add_to_list?api_key=0c68398f&email_address=test@example.com&lists=[{"list":"News","status":0,"next_message":2},{"list":"Sales","format_preference":2}]

Add contact to list with paused status.  (If/when unpaused by another action, the first email they get is the 3rd message in the sequence)

http://example.com/a.php/api/add_to_list?api_key=0c68398f&email_address=test@example.com&lists=[{"list":"Sales","format_preference":2,"status":1,"next_message":3}]