The following API calls are currently available for the ContactListContact object:
GET LIST - Get a list of all contacts in a specified contact list.
https://api.alchemer.com/v5/contactlist/31/contactlistcontact
| 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
[page] => 1
[results_per_page] => 50
[data] => Array
(
[0] => Array
(
[id] => 100039752
[email_address] => jon.doe@sgizmo.com
[status] => Active
[first_name] => jon
[last_name] => doe
[organization] =>
[division] =>
[department] =>
[group] =>
[role] =>
[is_manager] => False
[team] =>
[home_phone] =>
[fax_phone] =>
[business_phone] =>
[mailing_address] =>
[mailing_address2] =>
[mailing_address_city] =>
[mailing_address_state] =>
[mailing_address_postal] =>
[mailing_address_country] =>
[title] =>
[url] =>
)
[1] => Array
(
[id] => 100039747
[email_address] => jane.doe@sgizmo.com
[status] => Active
[first_name] => jane
[last_name] => doe
[organization] =>
[division] =>
[department] =>
[group] =>
[role] =>
[is_manager] =>
[team] =>
[home_phone] =>
[fax_phone] =>
[business_phone] =>
[mailing_address] =>
[mailing_address2] =>
[mailing_address_city] =>
[mailing_address_state] =>
[mailing_address_postal] =>
[mailing_address_country] =>
[title] =>
[url] =>
)
)
GET CONTACTLISTCONTACT - Get information about a specific contact within a specific list.
https://api.alchemer.com/v5/contactlist/31/contactlistcontact/100039752
| 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
[data] => Array
(
[id] => 100039752
[email_address] => jon.doe@sgizmo.com
[status] => Active
[first_name] => jon
[last_name] => doe
[organization] =>
[division] =>
[department] =>
[group] =>
[role] =>
[is_manager] => False
[team] =>
[home_phone] =>
[fax_phone] =>
[business_phone] =>
[mailing_address] =>
[mailing_address2] =>
[mailing_address_city] =>
[mailing_address_state] =>
[mailing_address_postal] =>
[mailing_address_country] =>
[title] =>
[url] =>
)
)
CREATE CONTACTLISTCONTACT - Create a new contact inside of a specific contact list.
https://api.alchemer.com/v5/contactlist/31/contactlistcontact?_method=PUT
| Parameters | Example | Required |
|---|---|---|
| Authentication Credentials | api_token=abcd12345&api_token_secret=abcd12345 | True |
| email_address | jon.doe@sgizmo.com | True |
| status | Active, Inactive | False |
| first_name | Jon | False |
| last_name | Doe | False |
| organization | Alchemer | False |
| division | North America | False |
| department | Sales | False |
| group | Inside Sales | False |
| role | Team Lead | False |
| is_manager | False | False |
| team | Green Team | False |
| home_phone | 123-456-7890 | False |
| fax_phone | 123-456-7890 | False |
| business_phone | 123-456-7890 | False |
| mailing_address | 123 Main St | False |
| mailing_address2 | Suite 100 | False |
| mailing_address_city | Anycity | False |
| mailing_address_state | CO | False |
| mailing_address_postal | 12345 | False |
| mailing_address_country | US | False |
| title | Title | False |
| url | www.webiste.com | False |
| custom[ID]† | custom[15]=value | False |
†These are the custom fields that are available as part of the account email lists. Learn how to get the ID number for custom fields.
Response Example (.debug format):
Array
(
[result_ok] => 1
[data] => Array
(
[id] => 100012345
[email_address] => jon.doe@sgizmo.com
[status] => Active
[first_name] => Jon
[last_name] => Doe
[organization] =>
[division] =>
[department] =>
[group] =>
[role] =>
[is_manager] => False
[team] =>
[home_phone] =>
[fax_phone] =>
[business_phone] =>
[mailing_address] =>
[mailing_address2] =>
[mailing_address_city] =>
[mailing_address_state] =>
[mailing_address_postal] =>
[mailing_address_country] =>
[title] =>
[url] =>
)
)
CHANGE/UPDATE CONTACTLISTCONTACT - Update a contact within a specific contact list.
https://api.alchemer.com/v5/contactlist/31/contactlistcontact?_method=POST&email_address=email
| Parameters | Example | Required |
|---|---|---|
| Authentication Credentials | api_token=abcd12345&api_token_secret=abcd12345 | True |
| email_address | jon.doe@sgizmo.com | True |
| status | Active, Inactive | False |
| first_name | Jon | False |
| last_name | Doe | False |
| organization | Alchemer | False |
| division | North America | False |
| department | Sales | False |
| group | Inside Sales | False |
| role | Team Lead | False |
| is_manager | False | False |
| team | Green Team | False |
| home_phone | 123-456-7890 | False |
| fax_phone | 123-456-7890 | False |
| business_phone | 123-456-7890 | False |
| mailing_address | 123 Main St | False |
| mailing_address2 | Suite 100 | False |
| mailing_address_city | Anycity | False |
| mailing_address_state | CO | False |
| mailing_address_postal | 12345 | False |
| mailing_address_country | US | False |
| title | Title | False |
| url | www.webiste.com | False |
| custom[ID]† | custom[15]=value | False |
†These are the custom fields that are available as part of the account email lists. Learn how to get the ID number for custom fields.
Response Example (.debug format):
Array
(
[result_ok] => 1
[data] => Array
(
[id] => 100039767
[email_address] => jon.doe@sgizmo.com
[status] => Active
[first_name] => Jon
[last_name] =>
[organization] =>
[division] =>
[department] =>
[group] =>
[role] =>
[is_manager] => False
[team] =>
[home_phone] =>
[fax_phone] =>
[business_phone] =>
[mailing_address] =>
[mailing_address2] =>
[mailing_address_city] =>
[mailing_address_state] =>
[mailing_address_postal] =>
[mailing_address_country] =>
[title] =>
[url] =>
)
)
DELETE CONTACTLISTCONTACT - Delete a specific contact from a contact list.
https://api.alchemer.com/v5/contactlist/31/contactlistcontact/100012345?_method=DELETE
| Parameters | Example | Required |
|---|---|---|
| Authentication Credentials | api_token=abcd12345&api_token_secret=abcd12345 | True |
Response Example (.debug format):
Array
(
[result_ok] => 1
)