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

Tools

ToolDescription
activetrail_campaigns_create_campaignCreate a new email campaign for specific groups
activetrail_campaigns_create_sms_campaignCreate a new SMS campaign
activetrail_campaigns_create_templateCreate a new email template
activetrail_campaigns_delete_campaignDelete a campaign
activetrail_campaigns_delete_templateDelete a template
activetrail_campaigns_get_campaignGet a campaign by ID
activetrail_campaigns_get_campaign_bouncesGet campaign bounce data and domain breakdown
activetrail_campaigns_get_campaign_click_detailsGet click report with link details for a campaign
activetrail_campaigns_get_campaign_opensGet contacts who opened a campaign
activetrail_campaigns_get_campaign_reportGet overview report for a specific campaign
activetrail_campaigns_get_campaign_schedulingGet campaign schedule settings
activetrail_campaigns_get_campaign_unsubscribedGet unsubscribed contacts from a campaign
activetrail_campaigns_get_sms_campaignGet an SMS campaign by ID
activetrail_campaigns_get_sms_campaign_reportGet a specific SMS campaign summary report
activetrail_campaigns_get_templateGet a specific template
activetrail_campaigns_list_campaign_reportsGet campaign reports with send, open, click, bounce data
activetrail_campaigns_list_campaignsGet account email campaigns
activetrail_campaigns_list_sent_campaignsGet list of sent campaigns
activetrail_campaigns_list_sms_campaign_reportsGet SMS campaign reports
activetrail_campaigns_list_sms_campaignsGet account SMS campaigns
activetrail_campaigns_list_templatesGet saved email templates
activetrail_campaigns_list_whats_app_templatesGet all approved WhatsApp templates
activetrail_campaigns_send_operational_emailSend an email operational message to individual emails (max 500)
activetrail_campaigns_send_operational_email_to_contactsSend an email operational message to contacts (max 500)
activetrail_campaigns_send_whats_app_campaignCreate and send a WhatsApp campaign
activetrail_campaigns_update_campaignUpdate a draft campaign
activetrail_campaigns_update_campaign_schedulingUpdate campaign schedule (draft only)
activetrail_campaigns_update_sms_campaignUpdate an SMS campaign
activetrail_campaigns_update_templateUpdate a template

activetrail_campaigns_create_campaign

Create a new email campaign for specific groups Parameters:
ParameterTypeRequiredDefaultDescription
contentobjectNoCampaign content
groupIdsany[]YesTarget group IDs
namestringYesCampaign name
subjectstringYesEmail subject line
typestringNoCampaign type

activetrail_campaigns_create_sms_campaign

Create a new SMS campaign Parameters:
ParameterTypeRequiredDefaultDescription
contentstringYesSMS message content
groupIdsany[]YesTarget group IDs
namestringYesCampaign name
sendDatestringNoScheduled send date

activetrail_campaigns_create_template

Create a new email template Parameters:
ParameterTypeRequiredDefaultDescription
categorystringNoTemplate category
contentstringYesTemplate HTML content
namestringYesTemplate name

activetrail_campaigns_delete_campaign

Delete a campaign Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesCampaign ID

activetrail_campaigns_delete_template

Delete a template Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesTemplate ID

activetrail_campaigns_get_campaign

Get a campaign by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesCampaign ID

activetrail_campaigns_get_campaign_bounces

Get campaign bounce data and domain breakdown Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesCampaign ID
FromDatestringNoStart date for filtering (inclusive)
ToDatestringNoEnd date for filtering (inclusive)
PageintegerNoPage number for pagination
LimitintegerNoMaximum number of results to return

activetrail_campaigns_get_campaign_click_details

Get click report with link details for a campaign Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesCampaign ID
FromDatestringNoStart date for filtering (inclusive)
ToDatestringNoEnd date for filtering (inclusive)
PageintegerNoPage number for pagination
LimitintegerNoMaximum number of results to return

activetrail_campaigns_get_campaign_opens

Get contacts who opened a campaign Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesCampaign ID
GroupidintegerNoFilter by group
FromDatestringNoStart date for filtering (inclusive)
ToDatestringNoEnd date for filtering (inclusive)
PageintegerNoPage number for pagination
LimitintegerNoMaximum number of results to return

activetrail_campaigns_get_campaign_report

Get overview report for a specific campaign Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesCampaign ID
FromDatestringNoStart date for filtering (inclusive)
ToDatestringNoEnd date for filtering (inclusive)
PageintegerNoPage number for pagination
LimitintegerNoMaximum number of results to return

activetrail_campaigns_get_campaign_scheduling

Get campaign schedule settings Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesCampaign ID

activetrail_campaigns_get_campaign_unsubscribed

Get unsubscribed contacts from a campaign Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesCampaign ID
FromDatestringNoStart date for filtering (inclusive)
ToDatestringNoEnd date for filtering (inclusive)
PageintegerNoPage number for pagination
LimitintegerNoMaximum number of results to return

activetrail_campaigns_get_sms_campaign

Get an SMS campaign by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesSMS campaign ID

activetrail_campaigns_get_sms_campaign_report

Get a specific SMS campaign summary report Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesSMS campaign ID

activetrail_campaigns_get_template

Get a specific template Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesTemplate ID

activetrail_campaigns_list_campaign_reports

Get campaign reports with send, open, click, bounce data Parameters:
ParameterTypeRequiredDefaultDescription
FromDatestringNoStart date for filtering (inclusive)
ToDatestringNoEnd date for filtering (inclusive)
PageintegerNoPage number for pagination
LimitintegerNoMaximum number of results to return

activetrail_campaigns_list_campaigns

Get account email campaigns Parameters:
ParameterTypeRequiredDefaultDescription
MailingListIdintegerNoFilter by mailing list
ContentCategoryIdintegerNoFilter by content category
SearchTermstringNoSearch term to filter results
SendTypestringNoSend Type
FromDatestringNoStart date for filtering (inclusive)
ToDatestringNoEnd date for filtering (inclusive)
PageintegerNoPage number for pagination
LimitintegerNoMaximum number of results to return

activetrail_campaigns_list_sent_campaigns

Get list of sent campaigns

activetrail_campaigns_list_sms_campaign_reports

Get SMS campaign reports Parameters:
ParameterTypeRequiredDefaultDescription
SendTypestringNoSend Type
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_campaigns_list_sms_campaigns

Get account SMS campaigns Parameters:
ParameterTypeRequiredDefaultDescription
IsIncludeNotSentbooleanNoInclude unsent campaigns
FromDatestringNoStart date for filtering (inclusive)
ToDatestringNoEnd date for filtering (inclusive)
SearchTermstringNoSearch term to filter results
FilterTypestringNoFilter Type
PageintegerNoPage number for pagination
LimitintegerNoMaximum number of results to return

activetrail_campaigns_list_templates

Get saved email templates

activetrail_campaigns_list_whats_app_templates

Get all approved WhatsApp templates

activetrail_campaigns_send_operational_email

Send an email operational message to individual emails (max 500) Parameters:
ParameterTypeRequiredDefaultDescription
contentstringYesEmail HTML content
emailstringYesRecipient email address
subjectstringYesEmail subject

activetrail_campaigns_send_operational_email_to_contacts

Send an email operational message to contacts (max 500) Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesContact ID
contentstringYesEmail HTML content
subjectstringYesEmail subject

activetrail_campaigns_send_whats_app_campaign

Create and send a WhatsApp campaign Parameters:
ParameterTypeRequiredDefaultDescription
attachmentobjectNoFile attachment
contactsany[]YesTarget contacts
contentstringNoMessage content
templateSidstringYesApproved WhatsApp template SID

activetrail_campaigns_update_campaign

Update a draft campaign Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesCampaign ID
contentobjectNoThe content value
groupIdsany[]NoGroup Ids
namestringNoThe name value
subjectstringNoThe subject value

activetrail_campaigns_update_campaign_scheduling

Update campaign schedule (draft only) Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesCampaign ID
recurringbooleanNoWhether campaign is recurring
sendDatestringNoScheduled send date

activetrail_campaigns_update_sms_campaign

Update an SMS campaign Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesSMS campaign ID
contentstringNoThe content value
groupIdsany[]NoGroup Ids
namestringNoThe name value
sendDatestringNoSend Date

activetrail_campaigns_update_template

Update a template Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesTemplate ID
categorystringNoThe category value
contentstringNoThe content value
namestringNoThe name value