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

Tools

ToolDescription
activetrail_management_create_content_categoryCreate a new content category
activetrail_management_create_webhookCreate a new webhook
activetrail_management_delete_content_categoryDelete a content category by ID
activetrail_management_delete_webhookDelete a webhook
activetrail_management_get_account_balanceGet email and SMS credit balance
activetrail_management_get_automationGet automation details by ID
activetrail_management_get_automation_activationGet automation activation status
activetrail_management_get_automation_contacts_endedGet contacts that finished an automation
activetrail_management_get_automation_contacts_startedGet contacts that started an automation
activetrail_management_get_automation_designGet complete automation design
activetrail_management_get_automation_overview_reportGet summary report for an automation
activetrail_management_get_automation_trigger_infoGet automation trigger information
activetrail_management_get_contact_fieldsGet account contact fields filtered by type
activetrail_management_get_contact_growth_reportGet daily contact growth metrics (active/inactive)
activetrail_management_get_content_categoryGet a specific content category by ID
activetrail_management_get_executive_reportGet executive-level account reports
activetrail_management_get_sending_profilesGet email sending profiles configured for account
activetrail_management_get_sms_sending_profilesGet SMS sending profiles for account
activetrail_management_get_webhookGet a specific webhook by ID
activetrail_management_list_automationsGet account automations
activetrail_management_list_content_categoriesGet all account content categories
activetrail_management_list_webhooksGet account webhooks
activetrail_management_update_automation_activationActivate or deactivate an automation
activetrail_management_update_content_categoryUpdate a content category
activetrail_management_update_webhookUpdate a webhook

activetrail_management_create_content_category

Create a new content category Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNoCategory description
namestringYesCategory name

activetrail_management_create_webhook

Create a new webhook Parameters:
ParameterTypeRequiredDefaultDescription
eventTypestringYesEvent type to listen for
statestringNoWebhook state
urlstringYesWebhook callback URL

activetrail_management_delete_content_category

Delete a content category by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesCategory ID

activetrail_management_delete_webhook

Delete a webhook Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesWebhook ID

activetrail_management_get_account_balance

Get email and SMS credit balance

activetrail_management_get_automation

Get automation details by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesAutomation ID

activetrail_management_get_automation_activation

Get automation activation status Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesAutomation ID

activetrail_management_get_automation_contacts_ended

Get contacts that finished an automation Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesAutomation ID
FromDatestringNoFromDate
ToDatestringNoToDate
FilterstringNoFilter
PageintegerNoPage
LimitintegerNoLimit

activetrail_management_get_automation_contacts_started

Get contacts that started an automation Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesAutomation ID
FromDatestringNoFromDate
ToDatestringNoToDate
FilterstringNoFilter
PageintegerNoPage
LimitintegerNoLimit

activetrail_management_get_automation_design

Get complete automation design Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesAutomation ID

activetrail_management_get_automation_overview_report

Get summary report for an automation Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesAutomation ID

activetrail_management_get_automation_trigger_info

Get automation trigger information Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesAutomation ID

activetrail_management_get_contact_fields

Get account contact fields filtered by type Parameters:
ParameterTypeRequiredDefaultDescription
FieldsTypestringNoType of fields to filter

activetrail_management_get_contact_growth_report

Get daily contact growth metrics (active/inactive) Parameters:
ParameterTypeRequiredDefaultDescription
FromDatestringNoStart date
ToDatestringNoEnd date (default 3 months back)

activetrail_management_get_content_category

Get a specific content category by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesCategory ID

activetrail_management_get_executive_report

Get executive-level account reports

activetrail_management_get_sending_profiles

Get email sending profiles configured for account

activetrail_management_get_sms_sending_profiles

Get SMS sending profiles for account

activetrail_management_get_webhook

Get a specific webhook by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesWebhook ID

activetrail_management_list_automations

Get account automations Parameters:
ParameterTypeRequiredDefaultDescription
StateTypestringNoFilter by state
PageintegerNoPage
LimitintegerNoLimit

activetrail_management_list_content_categories

Get all account content categories

activetrail_management_list_webhooks

Get account webhooks Parameters:
ParameterTypeRequiredDefaultDescription
EventTypestringNoEventType
StateTypestringNoStateType
TargetTypestringNoTargetType

activetrail_management_update_automation_activation

Activate or deactivate an automation Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesAutomation ID
activebooleanYesWhether the automation should be active

activetrail_management_update_content_category

Update a content category Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesCategory ID
descriptionstringNodescription
namestringNoname

activetrail_management_update_webhook

Update a webhook Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesWebhook ID
eventTypestringNoeventType
statestringNostate
urlstringNourl