/activetrail-contacts | Type: Application | PCID required: Yes
Tools
activetrail_contacts_add_group_member
Add a contact to a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Group ID |
contactId | string | Yes | — | Contact ID to add |
status | string | No | — | Subscription status |
activetrail_contacts_add_mailing_list_member
Add a member to a mailing list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Mailing list ID |
contactId | string | Yes | — | Contact ID to add |
status | string | No | — | Subscription status |
activetrail_contacts_create_contact
Create a new contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customFields | object | No | — | Custom field values |
email | string | No | — | Contact email address |
firstName | string | No | — | Contact first name |
lastName | string | No | — | Contact last name |
phone | string | No | — | Contact phone number |
activetrail_contacts_create_group
Create a new group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | Group description |
name | string | Yes | — | Group name |
activetrail_contacts_create_mailing_list
Create a new mailing list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | Mailing list description |
name | string | Yes | — | Mailing list name |
activetrail_contacts_delete_contact
Remove a contact from account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Contact ID |
activetrail_contacts_delete_group
Delete a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Group ID |
activetrail_contacts_delete_mailing_list
Delete a mailing list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Mailing list ID |
activetrail_contacts_get_contact
Get individual contact details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Contact ID |
activetrail_contacts_get_contact_activity
Get contact activity on emails sent to them Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Contact ID |
activetrail_contacts_get_contact_groups
Get groups membership for a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Contact ID |
activetrail_contacts_get_contact_mailing_lists
Get contact mailing list memberships Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Contact ID |
activetrail_contacts_get_group
Get a specific group by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Group ID |
activetrail_contacts_get_mailing_list
Get a mailing list by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Mailing list ID |
activetrail_contacts_import_contacts
Import contacts to a group (max 1000 per call) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contacts | any[] | Yes | — | Contact objects to import |
groupId | integer | Yes | — | Target group ID |
status | string | No | — | Subscription status for imported contacts |
activetrail_contacts_list_contact_subscriptions
Get contact subscription status and source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
FromDate | string | No | — | Start date |
ToDate | string | No | — | End date |
Page | integer | No | — | Page |
Limit | integer | No | — | Limit |
activetrail_contacts_list_contacts
Get account contacts list with filtering Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
CustomerStates | string | No | — | Filter by status: active, unsubscribed, bounced |
SearchTerm | string | No | — | Search criteria |
FromDate | string | No | — | Date range start |
ToDate | string | No | — | Date range end |
Page | integer | No | — | Pagination page number |
Limit | integer | No | — | Results per page |
activetrail_contacts_list_group_members
Get all group member contacts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Group ID |
CustomerStates | string | No | — | CustomerStates |
SearchTerm | string | No | — | SearchTerm |
FromDate | string | No | — | FromDate |
ToDate | string | No | — | ToDate |
Page | integer | No | — | Page |
Limit | integer | No | — | Limit |
activetrail_contacts_list_groups
Get all account groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
SearchTerm | string | No | — | Group name filter |
Page | integer | No | — | Page |
Limit | integer | No | — | Limit |
activetrail_contacts_list_mailing_list_members
Get all mailing list members Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Mailing list ID |
CustomerStates | string | No | — | CustomerStates |
FromDate | string | No | — | FromDate |
ToDate | string | No | — | ToDate |
Page | integer | No | — | Page |
Limit | integer | No | — | Limit |
activetrail_contacts_list_mailing_lists
Get account mailing listsactivetrail_contacts_list_subscribers
Get subscribed contacts with status source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
FromDate | string | No | — | FromDate |
ToDate | string | No | — | ToDate |
Page | integer | No | — | Page |
Limit | integer | No | — | Limit |
activetrail_contacts_list_unsubscribers
Get unsubscribed contacts with status source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
FromDate | string | No | — | FromDate |
ToDate | string | No | — | ToDate |
Page | integer | No | — | Page |
Limit | integer | No | — | Limit |
activetrail_contacts_remove_group_member
Remove a contact from a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Group ID |
memberId | string | Yes | — | Contact ID to remove |
activetrail_contacts_remove_mailing_list_member
Remove a member from a mailing list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Mailing list ID |
memberId | string | Yes | — | Contact ID to remove |
activetrail_contacts_update_contact
Update an existing contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Contact ID |
customFields | object | No | — | customFields |
email | string | No | — | |
firstName | string | No | — | firstName |
lastName | string | No | — | lastName |
phone | string | No | — | phone |
activetrail_contacts_update_group
Update a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Group ID |
description | string | No | — | description |
name | string | No | — | name |

