The following API calls are currently available for the ContactList object:
GET LIST - Get a list of all of your contact lists.
https://api.alchemer.com/v4/contactlist
| Parameters | Example | Required |
|---|---|---|
| Authentication Credentials | api_token=abcd12345&api_token_secret=abcd12345 | True |
| page | page=3 | False |
| resultsperpage | resultsperpage=100 | False |
Response Example (.debug format):
Array
(
[result_ok] => 1
[0] => Array
(
[iGroupID] => 1
[sGroupName] => New Customers
[dDateModifed] => 2012-10-23 10:46:09
[iUserIDCreated] => 183830
[iUserIDLastModified] => 0
[dCreated] => 2012-10-23 10:01:00
)
[1] => Array
(
[iGroupID] => 3
[sGroupName] => My New List
[dDateModifed] => 2012-10-23 14:50:13
[iUserIDCreated] => 183830
[iUserIDLastModified] => 0
[dCreated] => 2012-10-23 14:01:00
)
[2] => Array
(
[iGroupID] => 7
[sGroupName] => Existing Customers
[dDateModifed] => 2013-02-07 17:58:31
[iUserIDCreated] => 183830
[iUserIDLastModified] => 0
[dCreated] => 2013-02-07 17:58:31
)
[3] => Array
(
[iGroupID] => 13
[sGroupName] => Petes Pet Sitting Customers
[dDateModifed] => 2013-02-18 12:19:27
[iUserIDCreated] => 183830
[iUserIDLastModified] => 183830
[dCreated] => 2013-02-18 12:00:00
)
)
GET CONTACTLIST - Get a list of all of your contacts in a contact list.
https://api.alchemer.com/v4/contactlist/16
| Parameters | Example | Required |
|---|---|---|
| Authentication Credentials | api_token=abcd12345&api_token_secret=abcd12345 | True |
| page | page=3 | False |
| resultsperpage | resultsperpage=100 | False |
Response Example (.debug format):
Array
(
[result_ok] => 1
[0] => Array
(
[iCustomerContactID] => 100139484
[iCustomerID] => 160589
[sEmailAddress] => petlover1@email.com
[eStatus] => Active
[sFirstName] =>
[sLastName] =>
[sOrganization] =>
[sDivision] =>
[sDepartment] =>
[sGroup] =>
[sRole] =>
[sTeam] =>
[sHomePhone] =>
[sFaxPhone] =>
[sBusinessPhone] =>
[sMailingAddress] =>
[sMailingAddress2] =>
[sMailingAddressCity] =>
[sMailingAddressState] =>
[sMailingAddressPostal] =>
[sMailingAddressCountry] =>
[eSource] => Import
[dDateCreated] => 0000-00-00 00:00:00
[sTitle] =>
[sURL] =>
[dDeleted] => 0000-00-00 00:00:00
[dModified] => 0000-00-00 00:00:00
[iUserIDCreated] => 0
[iUserIDLastModified] => 0
[iUserIDDeleted] => 0
[dCreated] => 0000-00-00 00:00:00
[iMergedTo] => 0
[dDateMerged] => 0000-00-00 00:00:00
[iContactGroupLinkID] => 52095
[iContactID] => 100139484
[iGroupID] => 13
[iGroupSegmentID] =>
[eAddedBy] => Import
[dDateUnsub] =>
[dDateAdded] => 2013-02-18 12:19:28
)
[1] => Array
(
[iCustomerContactID] => 100139485
[iCustomerID] => 160589
[sEmailAddress] => petlover2@email.com
[eStatus] => Active
[sFirstName] =>
[sLastName] =>
[sOrganization] =>
[sDivision] =>
[sDepartment] =>
[sGroup] =>
[sRole] =>
[sTeam] =>
[sHomePhone] =>
[sFaxPhone] =>
[sBusinessPhone] =>
[sMailingAddress] =>
[sMailingAddress2] =>
[sMailingAddressCity] =>
[sMailingAddressState] =>
[sMailingAddressPostal] =>
[sMailingAddressCountry] =>
[eSource] => Import
[dDateCreated] => 0000-00-00 00:00:00
[sTitle] =>
[sURL] =>
[dDeleted] => 0000-00-00 00:00:00
[dModified] => 0000-00-00 00:00:00
[iUserIDCreated] => 0
[iUserIDLastModified] => 0
[iUserIDDeleted] => 0
[dCreated] => 0000-00-00 00:00:00
[iMergedTo] => 0
[dDateMerged] => 0000-00-00 00:00:00
[iContactGroupLinkID] => 52096
[iContactID] => 100139485
[iGroupID] => 13
[iGroupSegmentID] =>
[eAddedBy] => Import
[dDateUnsub] =>
[dDateAdded] => 2013-02-18 12:19:28
)
)
CREATE CONTACTLIST - Create a new contact list.
https://api.alchemer.com/v4/contactlist?_method=PUT&listname=New Contact List
| Parameters | Example | Required |
|---|---|---|
| Authentication Credentials | api_token=abcd12345&api_token_secret=abcd12345 | True |
| listname | New Contact List | True |
Response Example (.debug format):
Array
(
[result_ok] => 1
[0] => Array
(
[iGroupID] => 1
[sGroupName] => New Customers
[dDateModifed] => 2012-10-23 10:46:09
[iUserIDCreated] => 183830
[iUserIDLastModified] => 0
[dCreated] => 2012-10-23 10:01:00
)
[1] => Array
(
[iGroupID] => 3
[sGroupName] => My New List
[dDateModifed] => 2012-10-23 14:50:13
[iUserIDCreated] => 183830
[iUserIDLastModified] => 0
[dCreated] => 2012-10-23 14:01:00
)
[2] => Array
(
[iGroupID] => 7
[sGroupName] => Existing Customers
[dDateModifed] => 2013-02-07 17:58:31
[iUserIDCreated] => 183830
[iUserIDLastModified] => 0
[dCreated] => 2013-02-07 17:58:31
)
[3] => Array
(
[iGroupID] => 13
[sGroupName] => Petes Pet Sitting Customers
[dDateModifed] => 2013-02-18 12:19:27
[iUserIDCreated] => 183830
[iUserIDLastModified] => 183830
[dCreated] => 2013-02-18 12:00:00
)
[4] => Array
(
[iGroupID] => 17
[sGroupName] => New Contact List
[dDateModifed] => 2013-08-22 13:33:55
[iUserIDCreated] => 183830
[iUserIDLastModified] => 0
[dCreated] => 2013-08-22 13:33:55
)
)
CHANGE/UPDATE/ADD TO CONTACTLIST - Change, Update and Add contacts to your contact list.
https://api.alchemer.com/v4/contactlist/16?_method=POST&semailaddress=email@email.com
| Parameters | Example | Required |
|---|---|---|
| Authentication Credentials | api_token=abcd12345&api_token_secret=abcd12345 | True |
| semailaddress | email@email.com | True |
| sfirstname | John | False |
| slastname | Doe | False |
| sorganization | Alchemer | False |
| sdivision | Division Name | False |
| sdepartment | Department Name | False |
| sgroup | Group Name | False |
| srole | Role Name | False |
| steam | Team Name | False |
| shomephone | 999-999-9998 | False |
| sfaxphone | 999-999-9997 | False |
| sbusinessphone | 999-999-9996 | False |
| smailingaddress | 123 Main St | False |
| smailingaddress2 | Suite 101 | False |
| smailingaddresscity | Anycity | False |
| smailingadressstate | CO | False |
| smailingaddresscountry | US | False |
| smailingaddresspostal | 99997 | False |
| stitle | Title | False |
| surl | www.alchemer.com | False |
| custom[custom field name] | Custom Field Value | False |
Response Example (.debug format):
Array
(
[result_ok] => 1
[0] => Array
(
[iCustomerContactID] => 100271266
[iCustomerID] => 160589
[sEmailAddress] => bri@sgizmo.com
[eStatus] => Active
[sFirstName] =>
[sLastName] =>
[sOrganization] =>
[sDivision] =>
[sDepartment] =>
[sGroup] =>
[sRole] =>
[sTeam] =>
[sHomePhone] =>
[sFaxPhone] =>
[sBusinessPhone] =>
[sMailingAddress] =>
[sMailingAddress2] =>
[sMailingAddressCity] =>
[sMailingAddressState] =>
[sMailingAddressPostal] =>
[sMailingAddressCountry] =>
[eSource] => Import
[dDateCreated] =>
[sTitle] =>
[sURL] =>
[dDeleted] =>
[dModified] =>
[iUserIDCreated] => 0
[iUserIDLastModified] => 0
[iUserIDDeleted] => 0
[dCreated] =>
[iMergedTo] =>
[dDateMerged] =>
[iContactGroupLinkID] => 104116
[iContactID] => 100271266
[iGroupID] => 17
[iGroupSegmentID] =>
[eAddedBy] => Api
[dDateUnsub] =>
[dDateAdded] => 2013-08-22 13:45:29
)
[1] => Array
(
[iCustomerContactID] => 100312080
[iCustomerID] => 160589
[sEmailAddress] => newemail@email.com
[eStatus] => Active
[sFirstName] =>
[sLastName] =>
[sOrganization] =>
[sDivision] =>
[sDepartment] =>
[sGroup] =>
[sRole] =>
[sTeam] =>
[sHomePhone] =>
[sFaxPhone] =>
[sBusinessPhone] =>
[sMailingAddress] =>
[sMailingAddress2] =>
[sMailingAddressCity] =>
[sMailingAddressState] =>
[sMailingAddressPostal] =>
[sMailingAddressCountry] =>
[eSource] => Import
[dDateCreated] =>
[sTitle] =>
[sURL] =>
[dDeleted] =>
[dModified] =>
[iUserIDCreated] => 0
[iUserIDLastModified] => 0
[iUserIDDeleted] => 0
[dCreated] =>
[iMergedTo] =>
[dDateMerged] =>
[iContactGroupLinkID] => 144930
[iContactID] => 100312080
[iGroupID] => 17
[iGroupSegmentID] =>
[eAddedBy] => Api
[dDateUnsub] =>
[dDateAdded] => 2013-08-22 14:39:00
)
)