List Signups

Description

The List.php interface is used to add recipients to a contact list that already exists within the platform.
This is a two-way interface that allows for recipients to both OPT IN and OUT. Additionally there is an option to remove an individual from a list rather than opting the person out. This can be useful if for example you want to remove them from a particular set of campaigns against a single list in the profile whilst still permitting other communcations.

Resource Location .../interface/list.php
Base URL [https://response.pure360.com]
Custom Version https://{~customDomain~} (ONLY if you gone thorugh the process with Pure to set you up with a certificate on a domain which you have delegated to Pure's secure load balancer)
HTTP Method POST | GET (POST is preferable but both methods are supported)

Data Parameters : OPT Recipient In

WARNING: If you send an email address that has an opted out state via this request - it will opt them back into the profile. If using this for any bulk operations please be aware of this and consider Automated List Upload

All profiles have "recaptcha" enabled by default. This will block all serverside posts to this endpoint. recaptcha must be disabled on the profile to use this function server side. If recaptcha is disabled, you should not have any client side / browser facing signup HTML form posting into that profile because they will not be protected from bot signups.

key	value	usage
accName	`"TestProfile"`	Profile name to add recipient to
listName	`"Master+List"`	List name to add recipient to
doubleOptin	`"FALSE"`	It is recommend that you always include doubleOptin=FALSE. An interface user can still trigger a double optin email using a signup automation.
successUrl	`"http://yourdomain.com/register/success"`	URL to redirect to upon successful completion (OK) : Use NO-REDIRECT for test purposes
errorUrl	`"http://yourdomain.com/register/error"`	URL to redirect to upon error completion : Use NO-REDIRECT for test purposes
email	`"test@test.com"`	Email address of recipient being added to the contact list (optional if mobile provided)
mobile	`447875456578`	Mobile number of recipient being added to the contact list (optional if email provided)
firstName	`"bob"`	Custom field firstName to be populated by the value string for this record

Data Parameters : OPT Recipient Out

key	value	usage
accName	`"TestProfile"`	Profile name to add recipient to
mode	`"OPTOUT"`	Set the list builder mode to OPTOUT
email	`"test@test.com"`	Email address of recipient being added to the contact list (optional if mobile provided)
mobile	`447875456578`	Mobile number of recipient being added to the contact list (optional if email provided)

Data Parameters : Remove recipient from a List

key	value	usage
accName	`"TestProfile"`	Profile name to add recipient to
listName	`"Master+List"`	List name to remove recipient from
mode	`"REMOVE"`	Set the list builder mode to REMOVE
email	`"test@test.com"`	Email address of recipient being removed from the contact list (parameter may be a mobile number if dealing with SMS)
mobile	`447875456578`	Mobile number of recipient being added to the contact list (optional if email provided)

Response

Type	code	content : string
Success	200	OK
Error	200	Error : Error Message

Examples of Requests

Example - Curl - OPT Recipient In

curl --data "accName=profile&listName=list&doubleOptin=FALSE&successUrl=NO-REDIRECT&errorUrl=NO-REDIRECT&firstName=Test&email=test@test.com" 'http://response.pure360.com/interface/list.php'

This CURL request adds the address "[test@test.com](mailto:test@test.com)" to the list called "list" in the profile called "profile", it performs validation of the address, doesn't trigger a doubleOptin email, and assuming the list has the custom field "firstName" it adds the value "Test" for this record.

Example - Curl - OPT Recipient OUT

curl --data "accName=profile&email=test@test.com&mode=OPTOUT" 'http://response.pure360.com/interface/list.php';

This CURL request opts the recipient given by the email address parameter, out of the profile given by the accName parameter.

Example - Curl - remove Recipient from a List

curl --data "accName=profile&listName=list&email=test@test.com&mode=REMOVE" 'http://response.pure360.com/interface/list.php';

This CURL request removes the recipient given by the email address parameter from the list called "list" in the profile given by the accName parameter.