Skip to main content
Server path: /activetrail-contacts | Type: Application | PCID required: Yes

Tools

ToolDescription
activetrail_contacts_add_group_memberAdd a contact to a group
activetrail_contacts_add_mailing_list_memberAdd a member to a mailing list
activetrail_contacts_create_contactCreate a new contact
activetrail_contacts_create_groupCreate a new group
activetrail_contacts_create_mailing_listCreate a new mailing list
activetrail_contacts_delete_contactRemove a contact from account
activetrail_contacts_delete_groupDelete a group
activetrail_contacts_delete_mailing_listDelete a mailing list
activetrail_contacts_get_contactGet individual contact details
activetrail_contacts_get_contact_activityGet contact activity on emails sent to them
activetrail_contacts_get_contact_groupsGet groups membership for a contact
activetrail_contacts_get_contact_mailing_listsGet contact mailing list memberships
activetrail_contacts_get_groupGet a specific group by ID
activetrail_contacts_get_mailing_listGet a mailing list by ID
activetrail_contacts_import_contactsImport contacts to a group (max 1000 per call)
activetrail_contacts_list_contact_subscriptionsGet contact subscription status and source
activetrail_contacts_list_contactsGet account contacts list with filtering
activetrail_contacts_list_group_membersGet all group member contacts
activetrail_contacts_list_groupsGet all account groups
activetrail_contacts_list_mailing_list_membersGet all mailing list members
activetrail_contacts_list_mailing_listsGet account mailing lists
activetrail_contacts_list_subscribersGet subscribed contacts with status source
activetrail_contacts_list_unsubscribersGet unsubscribed contacts with status source
activetrail_contacts_remove_group_memberRemove a contact from a group
activetrail_contacts_remove_mailing_list_memberRemove a member from a mailing list
activetrail_contacts_update_contactUpdate an existing contact
activetrail_contacts_update_groupUpdate a group

activetrail_contacts_add_group_member

Add a contact to a group Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesGroup ID
contactIdstringYesContact ID to add
statusstringNoSubscription status

activetrail_contacts_add_mailing_list_member

Add a member to a mailing list Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesMailing list ID
contactIdstringYesContact ID to add
statusstringNoSubscription status

activetrail_contacts_create_contact

Create a new contact Parameters:
ParameterTypeRequiredDefaultDescription
customFieldsobjectNoCustom field values
emailstringNoContact email address
firstNamestringNoContact first name
lastNamestringNoContact last name
phonestringNoContact phone number

activetrail_contacts_create_group

Create a new group Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNoGroup description
namestringYesGroup name

activetrail_contacts_create_mailing_list

Create a new mailing list Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNoMailing list description
namestringYesMailing list name

activetrail_contacts_delete_contact

Remove a contact from account Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesContact ID

activetrail_contacts_delete_group

Delete a group Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesGroup ID

activetrail_contacts_delete_mailing_list

Delete a mailing list Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesMailing list ID

activetrail_contacts_get_contact

Get individual contact details Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesContact ID

activetrail_contacts_get_contact_activity

Get contact activity on emails sent to them Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesContact ID

activetrail_contacts_get_contact_groups

Get groups membership for a contact Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesContact ID

activetrail_contacts_get_contact_mailing_lists

Get contact mailing list memberships Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesContact ID

activetrail_contacts_get_group

Get a specific group by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesGroup ID

activetrail_contacts_get_mailing_list

Get a mailing list by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesMailing list ID

activetrail_contacts_import_contacts

Import contacts to a group (max 1000 per call) Parameters:
ParameterTypeRequiredDefaultDescription
contactsany[]YesContact objects to import
groupIdintegerYesTarget group ID
statusstringNoSubscription status for imported contacts

activetrail_contacts_list_contact_subscriptions

Get contact subscription status and source Parameters:
ParameterTypeRequiredDefaultDescription
FromDatestringNoStart date
ToDatestringNoEnd date
PageintegerNoPage number for pagination
LimitintegerNoMaximum number of results to return

activetrail_contacts_list_contacts

Get account contacts list with filtering Parameters:
ParameterTypeRequiredDefaultDescription
CustomerStatesstringNoFilter by status: active, unsubscribed, bounced
SearchTermstringNoSearch criteria
FromDatestringNoDate range start
ToDatestringNoDate range end
PageintegerNoPagination page number
LimitintegerNoResults per page

activetrail_contacts_list_group_members

Get all group member contacts Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesGroup ID
CustomerStatesstringNoCustomer States
SearchTermstringNoSearch term to filter results
FromDatestringNoStart date for filtering (inclusive)
ToDatestringNoEnd date for filtering (inclusive)
PageintegerNoPage number for pagination
LimitintegerNoMaximum number of results to return

activetrail_contacts_list_groups

Get all account groups Parameters:
ParameterTypeRequiredDefaultDescription
SearchTermstringNoGroup name filter
PageintegerNoPage number for pagination
LimitintegerNoMaximum number of results to return

activetrail_contacts_list_mailing_list_members

Get all mailing list members Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesMailing list ID
CustomerStatesstringNoCustomer States
FromDatestringNoStart date for filtering (inclusive)
ToDatestringNoEnd date for filtering (inclusive)
PageintegerNoPage number for pagination
LimitintegerNoMaximum number of results to return

activetrail_contacts_list_mailing_lists

Get account mailing lists

activetrail_contacts_list_subscribers

Get subscribed contacts with status source Parameters:
ParameterTypeRequiredDefaultDescription
FromDatestringNoStart date for filtering (inclusive)
ToDatestringNoEnd date for filtering (inclusive)
PageintegerNoPage number for pagination
LimitintegerNoMaximum number of results to return

activetrail_contacts_list_unsubscribers

Get unsubscribed contacts with status source Parameters:
ParameterTypeRequiredDefaultDescription
FromDatestringNoStart date for filtering (inclusive)
ToDatestringNoEnd date for filtering (inclusive)
PageintegerNoPage number for pagination
LimitintegerNoMaximum number of results to return

activetrail_contacts_remove_group_member

Remove a contact from a group Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesGroup ID
memberIdstringYesContact ID to remove

activetrail_contacts_remove_mailing_list_member

Remove a member from a mailing list Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesMailing list ID
memberIdstringYesContact ID to remove

activetrail_contacts_update_contact

Update an existing contact Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesContact ID
customFieldsobjectNoCustom Fields
emailstringNoThe email value
firstNamestringNoFirst Name
lastNamestringNoLast Name
phonestringNoThe phone value

activetrail_contacts_update_group

Update a group Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesGroup ID
descriptionstringNoThe description value
namestringNoThe name value