/activetrail-campaigns | Type: Application | PCID required: Yes
Tools
activetrail_campaigns_create_campaign
Create a new email campaign for specific groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
content | object | No | — | Campaign content |
groupIds | any[] | Yes | — | Target group IDs |
name | string | Yes | — | Campaign name |
subject | string | Yes | — | Email subject line |
type | string | No | — | Campaign type |
activetrail_campaigns_create_sms_campaign
Create a new SMS campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
content | string | Yes | — | SMS message content |
groupIds | any[] | Yes | — | Target group IDs |
name | string | Yes | — | Campaign name |
sendDate | string | No | — | Scheduled send date |
activetrail_campaigns_create_template
Create a new email template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
category | string | No | — | Template category |
content | string | Yes | — | Template HTML content |
name | string | Yes | — | Template name |
activetrail_campaigns_delete_campaign
Delete a campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Campaign ID |
activetrail_campaigns_delete_template
Delete a template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Template ID |
activetrail_campaigns_get_campaign
Get a campaign by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Campaign ID |
activetrail_campaigns_get_campaign_bounces
Get campaign bounce data and domain breakdown Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Campaign ID |
FromDate | string | No | — | FromDate |
ToDate | string | No | — | ToDate |
Page | integer | No | — | Page |
Limit | integer | No | — | Limit |
activetrail_campaigns_get_campaign_click_details
Get click report with link details for a campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Campaign ID |
FromDate | string | No | — | FromDate |
ToDate | string | No | — | ToDate |
Page | integer | No | — | Page |
Limit | integer | No | — | Limit |
activetrail_campaigns_get_campaign_opens
Get contacts who opened a campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Campaign ID |
Groupid | integer | No | — | Filter by group |
FromDate | string | No | — | FromDate |
ToDate | string | No | — | ToDate |
Page | integer | No | — | Page |
Limit | integer | No | — | Limit |
activetrail_campaigns_get_campaign_report
Get overview report for a specific campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Campaign ID |
FromDate | string | No | — | FromDate |
ToDate | string | No | — | ToDate |
Page | integer | No | — | Page |
Limit | integer | No | — | Limit |
activetrail_campaigns_get_campaign_scheduling
Get campaign schedule settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Campaign ID |
activetrail_campaigns_get_campaign_unsubscribed
Get unsubscribed contacts from a campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Campaign ID |
FromDate | string | No | — | FromDate |
ToDate | string | No | — | ToDate |
Page | integer | No | — | Page |
Limit | integer | No | — | Limit |
activetrail_campaigns_get_sms_campaign
Get an SMS campaign by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | SMS campaign ID |
activetrail_campaigns_get_sms_campaign_report
Get a specific SMS campaign summary report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | SMS campaign ID |
activetrail_campaigns_get_template
Get a specific template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Template ID |
activetrail_campaigns_list_campaign_reports
Get campaign reports with send, open, click, bounce data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
FromDate | string | No | — | FromDate |
ToDate | string | No | — | ToDate |
Page | integer | No | — | Page |
Limit | integer | No | — | Limit |
activetrail_campaigns_list_campaigns
Get account email campaigns Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
MailingListId | integer | No | — | Filter by mailing list |
ContentCategoryId | integer | No | — | Filter by content category |
SearchTerm | string | No | — | SearchTerm |
SendType | string | No | — | SendType |
FromDate | string | No | — | FromDate |
ToDate | string | No | — | ToDate |
Page | integer | No | — | Page |
Limit | integer | No | — | Limit |
activetrail_campaigns_list_sent_campaigns
Get list of sent campaignsactivetrail_campaigns_list_sms_campaign_reports
Get SMS campaign reports Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
SendType | string | No | — | SendType |
SearchTerm | string | No | — | SearchTerm |
FromDate | string | No | — | FromDate |
ToDate | string | No | — | ToDate |
Page | integer | No | — | Page |
Limit | integer | No | — | Limit |
activetrail_campaigns_list_sms_campaigns
Get account SMS campaigns Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
IsIncludeNotSent | boolean | No | — | Include unsent campaigns |
FromDate | string | No | — | FromDate |
ToDate | string | No | — | ToDate |
SearchTerm | string | No | — | SearchTerm |
FilterType | string | No | — | FilterType |
Page | integer | No | — | Page |
Limit | integer | No | — | Limit |
activetrail_campaigns_list_templates
Get saved email templatesactivetrail_campaigns_list_whats_app_templates
Get all approved WhatsApp templatesactivetrail_campaigns_send_operational_email
Send an email operational message to individual emails (max 500) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
content | string | Yes | — | Email HTML content |
email | string | Yes | — | Recipient email address |
subject | string | Yes | — | Email subject |
activetrail_campaigns_send_operational_email_to_contacts
Send an email operational message to contacts (max 500) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | Contact ID |
content | string | Yes | — | Email HTML content |
subject | string | Yes | — | Email subject |
activetrail_campaigns_send_whats_app_campaign
Create and send a WhatsApp campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
attachment | object | No | — | File attachment |
contacts | any[] | Yes | — | Target contacts |
content | string | No | — | Message content |
templateSid | string | Yes | — | Approved WhatsApp template SID |
activetrail_campaigns_update_campaign
Update a draft campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Campaign ID |
content | object | No | — | content |
groupIds | any[] | No | — | groupIds |
name | string | No | — | name |
subject | string | No | — | subject |
activetrail_campaigns_update_campaign_scheduling
Update campaign schedule (draft only) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Campaign ID |
recurring | boolean | No | — | Whether campaign is recurring |
sendDate | string | No | — | Scheduled send date |
activetrail_campaigns_update_sms_campaign
Update an SMS campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | SMS campaign ID |
content | string | No | — | content |
groupIds | any[] | No | — | groupIds |
name | string | No | — | name |
sendDate | string | No | — | sendDate |
activetrail_campaigns_update_template
Update a template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Template ID |
category | string | No | — | category |
content | string | No | — | content |
name | string | No | — | name |

