ActiveTrail
active_trailActiveTrail is the world's friendliest email marketing platform, newsletter software and marketing automation software.
Acciones disponibles (162)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Add Group MemberACTIVE_TRAIL_ADD_GROUP_MEMBERAcciónTool to add a member to a group in ActiveTrail. Use when you need to add a contact to a specific group with their email and optional contact details.
ACTIVE_TRAIL_ADD_GROUP_MEMBERAcciónTool to add a member to a group in ActiveTrail. Use when you need to add a contact to a specific group with their email and optional contact details.
Parámetros de entrada
emailstringObligatorioContact's email address
statusstringContact's subscription status in the group. Note: cannot import a contact in status 'subscribe' if they are inactive on ActiveTrail
group_idintegerObligatorioThe unique identifier for the group to add the member to
last_namestringContact's last name
first_namestringContact's first name
sms_numberstringContact's SMS/phone number
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Contact GrowthACTIVE_TRAIL_CONTACT_GROWTHAcciónTool to retrieve executive report on contact growth showing daily active and inactive contact growth. Use when you need to measure the increase in amount of contacts over a date range.
ACTIVE_TRAIL_CONTACT_GROWTHAcciónTool to retrieve executive report on contact growth showing daily active and inactive contact growth. Use when you need to measure the increase in amount of contacts over a date range.
Parámetros de entrada
to_datestringdateEnd date for filtering contact growth data. If not provided, defaults to the current date
from_datestringdateStart date for filtering contact growth data. If not provided, defaults to three months prior to the current date
Parámetros de salida
dataobjectContact growth data containing active and inactive customer totals
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
successfullbooleanWhether the request was successful
Create or Update Group MemberACTIVE_TRAIL_CREATE_A_MEMBER_IN_A_GROUPAcciónTool to create or update a member in a group. Use when you need to add a new contact to a specific group or update an existing member's details. The API will not return errors if the address is already in the group.
ACTIVE_TRAIL_CREATE_A_MEMBER_IN_A_GROUPAcciónTool to create or update a member in a group. Use when you need to add a new contact to a specific group or update an existing member's details. The API will not return errors if the address is already in the group.
Parámetros de entrada
faxstringFax number
citystringCity name
ext1stringCustom extension field 1
ext2stringCustom extension field 2
ext3stringCustom extension field 3
ext4stringCustom extension field 4
ext5stringCustom extension field 5
ext6stringCustom extension field 6
emailstringContact's email address. At least email or one other identifier should be provided
phone1stringPrimary phone number
phone2stringSecondary phone number
streetstringStreet address
birthdaystringBirthday date in YYYY-MM-DD format
group_idintegerObligatorioThe unique identifier for the group to add the member to
zip_codestringPostal code
last_namestringContact's last name
first_namestringContact's first name
anniversarystringAnniversary date in YYYY-MM-DD format
campaign_idintegerCampaign identifier to associate with this member
encryptedext1stringEncrypted custom field 1
encryptedext2stringEncrypted custom field 2
encryptedext3stringEncrypted custom field 3
encryptedext4stringEncrypted custom field 4
is_do_not_mailbooleanFlag to mark contacts who should not receive mail communications (true/false)
is_trigger_eventsbooleanWhether to trigger events when adding the member (true/false)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create a New GroupACTIVE_TRAIL_CREATE_A_NEW_GROUPAcciónTool to create a new group in ActiveTrail. Use when you need to add a new group to organize and segment contacts.
ACTIVE_TRAIL_CREATE_A_NEW_GROUPAcciónTool to create a new group in ActiveTrail. Use when you need to add a new group to organize and segment contacts.
Parámetros de entrada
namestringObligatorioName of the group. This is the only required field.
counterintegerTotal contacts in the group
createdstringDate of creation of the group (ISO 8601 format: YYYY-MM-DDTHH:MM:SS)
active_counterintegerNumber of active contacts in the group
last_generatedstringDynamic group only - last generation timestamp (ISO 8601 format: YYYY-MM-DDTHH:MM:SS)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create ContactACTIVE_TRAIL_CREATE_CONTACTAcciónTool to create a new contact in ActiveTrail. Use when you need to add a new contact to the system. Note: Newly created contacts won't be linked to any group, making email/SMS delivery impossible until assigned to a group. Either email or sms must be provided.
ACTIVE_TRAIL_CREATE_CONTACTAcciónTool to create a new contact in ActiveTrail. Use when you need to add a new contact to the system. Note: Newly created contacts won't be linked to any group, making email/SMS delivery impossible until assigned to a group. Either email or sms must be provided.
Parámetros de entrada
faxstringFax number
smsstringContact's SMS phone number. Required if email is not provided
citystringCity name
ext1stringExtended custom field 1
ext2stringExtended custom field 2
ext3stringExtended custom field 3
ext4stringExtended custom field 4
ext5stringExtended custom field 5
ext6stringExtended custom field 6
ext7stringExtended custom field 7
ext8stringExtended custom field 8
ext9stringExtended custom field 9
num1integerCustom numeric field 1
num2integerCustom numeric field 2
num3integerCustom numeric field 3
num4integerCustom numeric field 4
num5integerCustom numeric field 5
date1stringdateCustom date field 1
date2stringdateCustom date field 2
date3stringdateCustom date field 3
date4stringdateCustom date field 4
date5stringdateCustom date field 5
emailstringContact's email address. Required if sms is not provided
ext10stringExtended custom field 10
ext11stringExtended custom field 11
ext12stringExtended custom field 12
ext13stringExtended custom field 13
ext14stringExtended custom field 14
ext15stringExtended custom field 15
ext16stringExtended custom field 16
ext17stringExtended custom field 17
ext18stringExtended custom field 18
ext19stringExtended custom field 19
ext20stringExtended custom field 20
ext21stringExtended custom field 21
ext22stringExtended custom field 22
ext23stringExtended custom field 23
ext24stringExtended custom field 24
ext25stringExtended custom field 25
phone1stringPrimary phone number
phone2stringSecondary phone number
streetstringStreet address
birthdaystringdateContact's birth date
zip_codestringZip or postal code
last_namestringContact's last name
first_namestringContact's first name
anniversarystringdateAnniversary date
subscribe_ipstringIP address at subscription time
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Content CategoryACTIVE_TRAIL_CREATE_CONTENT_CATEGORYAcciónTool to create a new content category in ActiveTrail account. Use when you need to add a new category for organizing campaigns and templates.
ACTIVE_TRAIL_CREATE_CONTENT_CATEGORYAcciónTool to create a new content category in ActiveTrail account. Use when you need to add a new category for organizing campaigns and templates.
Parámetros de entrada
namestringObligatorioName of the content category to create
is_defaultbooleanWhether this category should be set as the default category
display_orderintegerDisplay order for the category. Higher numbers appear later in the list
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create New Mailing ListACTIVE_TRAIL_CREATE_NEW_MAILING_LISTAcciónTool to create a new mailing list in ActiveTrail. Use when you need to add a new mailing list to organize and manage contacts.
ACTIVE_TRAIL_CREATE_NEW_MAILING_LISTAcciónTool to create a new mailing list in ActiveTrail. Use when you need to add a new mailing list to organize and manage contacts.
Parámetros de entrada
namestringObligatorioName of the mailing list. This is the only required field.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create OrderACTIVE_TRAIL_CREATE_ORDERAcciónTool to create new orders in ActiveTrail commerce system. Use when you need to add order records with customer information, products, and transaction details. Accepts an array of order objects for batch creation.
ACTIVE_TRAIL_CREATE_ORDERAcciónTool to create new orders in ActiveTrail commerce system. Use when you need to add order records with customer information, products, and transaction details. Accepts an array of order objects for batch creation.
Parámetros de entrada
ordersobject[]ObligatorioArray of order objects to create. At least one order is required.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Smart Code SiteACTIVE_TRAIL_CREATE_SMART_CODE_SITEAcciónTool to create a new Smart Code site in ActiveTrail. Use when you need to set up a new Smart Code site with a name and associated domain(s).
ACTIVE_TRAIL_CREATE_SMART_CODE_SITEAcciónTool to create a new Smart Code site in ActiveTrail. Use when you need to set up a new Smart Code site with a name and associated domain(s).
Parámetros de entrada
namestringObligatorioName of the Smart Code site to create
domainsstringObligatorioYour website domain(s). Comma-separated for multiple domains
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create WebhookACTIVE_TRAIL_CREATE_WEBHOOKAcciónTool to create a new webhook for event notifications in ActiveTrail. Use when you need to set up webhooks to receive real-time notifications for events like contact changes or campaign activities.
ACTIVE_TRAIL_CREATE_WEBHOOKAcciónTool to create a new webhook for event notifications in ActiveTrail. Use when you need to set up webhooks to receive real-time notifications for events like contact changes or campaign activities.
Parámetros de entrada
urlstringObligatorioThe URL that the webhook will call when triggered. This is a required field.
namestringObligatorioThe name of the webhook
formatstringWebhook format (e.g., 'json', 'xml')
stateidintegerWebhook state (deprecated - use is_active flag instead)
is_activebooleanWhether this webhook is active or not. Defaults to true if not specified.
event_typestringObligatorioEvent type that triggers the webhook. This is a required field. Common values: 'contact_change'
parametersobject[]Custom parameters array for the webhook (headers, query params, etc.)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete content categoryACTIVE_TRAIL_DELETE_ACCOUNT_CONTENT_CATEGORIESAcciónTool to delete a specific content category by ID. Use when you need to remove a category from your ActiveTrail account.
ACTIVE_TRAIL_DELETE_ACCOUNT_CONTENT_CATEGORIESAcciónTool to delete a specific content category by ID. Use when you need to remove a category from your ActiveTrail account.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the category to be deleted
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete group memberACTIVE_TRAIL_DELETE_A_MEMBER_IN_A_GROUPAcciónTool to delete a group member by ID. Use when you need to remove a contact from a specific group in ActiveTrail.
ACTIVE_TRAIL_DELETE_A_MEMBER_IN_A_GROUPAcciónTool to delete a group member by ID. Use when you need to remove a contact from a specific group in ActiveTrail.
Parámetros de entrada
group_idintegerObligatorioThe unique identifier for the group
contact_idintegerObligatorioThe unique identifier for the contact to remove from the group. Contacts can be identified by id or email (lowercase)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete AutomationsACTIVE_TRAIL_DELETE_AUTOMATIONSAcciónTool to delete one or more automations from Active Trail. Use when you need to remove automations by their IDs. Supports bulk deletion by providing comma-separated IDs.
ACTIVE_TRAIL_DELETE_AUTOMATIONSAcciónTool to delete one or more automations from Active Trail. Use when you need to remove automations by their IDs. Supports bulk deletion by providing comma-separated IDs.
Parámetros de entrada
idsstringObligatorioAutomation identifier(s). For single deletion, provide one ID. For bulk deletion, provide multiple IDs separated by commas (e.g., '1,2,3').
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete CampaignACTIVE_TRAIL_DELETE_CAMPAIGNAcciónTool to remove a campaign from ActiveTrail account. Use when you need to delete a campaign that is no longer needed.
ACTIVE_TRAIL_DELETE_CAMPAIGNAcciónTool to remove a campaign from ActiveTrail account. Use when you need to delete a campaign that is no longer needed.
Parámetros de entrada
idstringObligatorioThe unique identifier of the campaign to be deleted
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ContactACTIVE_TRAIL_DELETE_CONTACTAcciónTool to remove a contact from the ActiveTrail account. Use when you need to permanently delete a contact identified by their unique ID.
ACTIVE_TRAIL_DELETE_CONTACTAcciónTool to remove a contact from the ActiveTrail account. Use when you need to permanently delete a contact identified by their unique ID.
Parámetros de entrada
idstringObligatorioThe unique contact identifier to be deleted
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete group by IDACTIVE_TRAIL_DELETE_GROUP_BY_IDAcciónTool to delete a group by ID. Use when you need to permanently remove a group from ActiveTrail. This is a destructive operation that cannot be undone.
ACTIVE_TRAIL_DELETE_GROUP_BY_IDAcciónTool to delete a group by ID. Use when you need to permanently remove a group from ActiveTrail. This is a destructive operation that cannot be undone.
Parámetros de entrada
group_idintegerObligatorioThe unique identifier for the group to be deleted
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Group MemberACTIVE_TRAIL_DELETE_GROUPS_MEMBERSAcciónTool to remove a member from a group in ActiveTrail. Use when you need to delete a contact from a specified group.
ACTIVE_TRAIL_DELETE_GROUPS_MEMBERSAcciónTool to remove a member from a group in ActiveTrail. Use when you need to delete a contact from a specified group.
Parámetros de entrada
idstringObligatorioGroup identifier - the ID of the group from which to remove the member
memberIdstringObligatorioContact identifier - the ID of the contact/member to be removed from the group
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Mailing ListACTIVE_TRAIL_DELETE_MAILING_LISTAcciónTool to remove a mailing list from ActiveTrail account. Use when you need to permanently delete a mailing list. This is a destructive operation that cannot be undone.
ACTIVE_TRAIL_DELETE_MAILING_LISTAcciónTool to remove a mailing list from ActiveTrail account. Use when you need to permanently delete a mailing list. This is a destructive operation that cannot be undone.
Parámetros de entrada
idstringObligatorioThe unique identifier of the mailing list to be removed
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Mailing List MemberACTIVE_TRAIL_DELETE_MAILINGLIST_MEMBERSAcciónTool to remove a member from a mailing list in ActiveTrail. Use when you need to delete a contact from a specified mailing list.
ACTIVE_TRAIL_DELETE_MAILINGLIST_MEMBERSAcciónTool to remove a member from a mailing list in ActiveTrail. Use when you need to delete a contact from a specified mailing list.
Parámetros de entrada
idstringObligatorioMailing list identifier - the ID of the mailing list from which to remove the member
memberIdstringObligatorioContact identifier - the ID of the contact/member to be removed from the mailing list
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Smart Code SiteACTIVE_TRAIL_DELETE_SMART_CODE_SITEAcciónTool to remove a Smart Code site from ActiveTrail. Use when you need to permanently delete a Smart Code site identified by its unique ID.
ACTIVE_TRAIL_DELETE_SMART_CODE_SITEAcciónTool to remove a Smart Code site from ActiveTrail. Use when you need to permanently delete a Smart Code site identified by its unique ID.
Parámetros de entrada
idstringObligatorioThe unique identifier of the Smart Code site to be removed
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete TemplateACTIVE_TRAIL_DELETE_TEMPLATEAcciónTool to remove a template from ActiveTrail account. Use when you need to delete a template that is no longer needed.
ACTIVE_TRAIL_DELETE_TEMPLATEAcciónTool to remove a template from ActiveTrail account. Use when you need to delete a template that is no longer needed.
Parámetros de entrada
idstringObligatorioThe unique identifier of the template to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete template categoryACTIVE_TRAIL_DELETE_TEMPLATES_TEMPLATE_CATEGORYAcciónTool to delete a template category by ID. Use when you need to remove a template category. Warning: Deleting a category will cascade-delete all templates within that category.
ACTIVE_TRAIL_DELETE_TEMPLATES_TEMPLATE_CATEGORYAcciónTool to delete a template category by ID. Use when you need to remove a template category. Warning: Deleting a category will cascade-delete all templates within that category.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the template category to be deleted. Note: Deleting a category will also delete all templates within it.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete webhook parameterACTIVE_TRAIL_DELETE_WEBHOOKS_PARAMETERSAcciónTool to delete a given webhook parameter from your account's webhook configuration. Use when you need to remove a specific parameter associated with a webhook.
ACTIVE_TRAIL_DELETE_WEBHOOKS_PARAMETERSAcciónTool to delete a given webhook parameter from your account's webhook configuration. Use when you need to remove a specific parameter associated with a webhook.
Parámetros de entrada
webhook_idstringObligatorioThe webhook identifier
parameter_idstringObligatorioThe specific parameter identifier to be removed
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Account BalanceACTIVE_TRAIL_GET_ACCOUNT_BALANCEAcciónTool to retrieve email and SMS credit balance for the account. Use when you need to check available email and SMS credits.
ACTIVE_TRAIL_GET_ACCOUNT_BALANCEAcciónTool to retrieve email and SMS credit balance for the account. Use when you need to check available email and SMS credits.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get specific content categoryACTIVE_TRAIL_GET_ACCOUNT_CONTENT_CATEGORIES2AcciónTool to retrieve specific category details by ID. Use when you need to get information about a content category from your ActiveTrail account.
ACTIVE_TRAIL_GET_ACCOUNT_CONTENT_CATEGORIES2AcciónTool to retrieve specific category details by ID. Use when you need to get information about a content category from your ActiveTrail account.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the category to retrieve. Can be found using the endpoint to get the account's list of categories.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ActiveCommerce Integration DataACTIVE_TRAIL_GET_ACCOUNT_INTEGRATIONDATA_ACTIVECOMMERCEAcciónTool to retrieve the account's ActiveCommerce integration data. Use when you need to fetch ActiveCommerce integration configuration and settings.
ACTIVE_TRAIL_GET_ACCOUNT_INTEGRATIONDATA_ACTIVECOMMERCEAcciónTool to retrieve the account's ActiveCommerce integration data. Use when you need to fetch ActiveCommerce integration configuration and settings.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectIntegration data details.
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
successfullbooleanWhether the request was successful
Get Account Merge StatusACTIVE_TRAIL_GET_ACCOUNT_MERGEAcciónTool to check if the account has awaited merges. Use when you need to verify pending merge operations in the ActiveTrail account.
ACTIVE_TRAIL_GET_ACCOUNT_MERGEAcciónTool to check if the account has awaited merges. Use when you need to verify pending merge operations in the ActiveTrail account.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get List of All SMS Campaign ClickersACTIVE_TRAIL_GET_A_LIST_OF_ALL_CLICKSAcciónTool to retrieve all contacts who clicked on links in an SMS campaign. Use when you need information about which contacts engaged with links in your SMS campaigns. Note: Mobile numbers are only returned if the SMS was sent to a group; manually added numbers will only show click counts. The search defaults to the last 3 months for campaigns.
ACTIVE_TRAIL_GET_A_LIST_OF_ALL_CLICKSAcciónTool to retrieve all contacts who clicked on links in an SMS campaign. Use when you need information about which contacts engaged with links in your SMS campaigns. Note: Mobile numbers are only returned if the SMS was sent to a group; manually added numbers will only show click counts. The search defaults to the last 3 months for campaigns.
Parámetros de entrada
idstringObligatorioThe SMS campaign identifier for which to retrieve clicker contact information. Can be found using the endpoint 'Get account's SMS campaigns'.
pageintegerPage number for pagination. Use this to navigate through multiple pages of results.
limitintegerNumber of records to return per page. Controls the size of each page in paginated results.
link_idstringFilter results to contacts who clicked on a specific link within the campaign. If not provided, returns all clickers across all links.
to_datestringEnd date for filtering clicker data. Format: YYYY-MM-DD. The search defaults to the last 3 months if not provided.
from_datestringStart date for filtering clicker data. Format: YYYY-MM-DD. The search defaults to the last 3 months if not provided.
send_typestringFilter by send type (e.g., immediate, scheduled).
search_termstringSearch criteria for filtering clicker results.
rows_affectedintegerNumber of rows affected in the result set for pagination purposes.
previous_row_countintegerPrevious row count for pagination purposes.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get All Campaign ReportsACTIVE_TRAIL_GET_ALL_CAMPAIGN_REPORTSAcciónTool to retrieve a full overview of all campaign reports with comprehensive metrics. Use when you need to get reports for all campaigns including send date, opened emails, number of clicks, CTO, bounces, unsubscribers, complaints, unopened and sent emails. Default behavior: Returns campaigns filtered by last update date within the previous 3 months when date parameters are not specified. Default limit is 20 records per page, maximum is 100.
ACTIVE_TRAIL_GET_ALL_CAMPAIGN_REPORTSAcciónTool to retrieve a full overview of all campaign reports with comprehensive metrics. Use when you need to get reports for all campaigns including send date, opened emails, number of clicks, CTO, bounces, unsubscribers, complaints, unopened and sent emails. Default behavior: Returns campaigns filtered by last update date within the previous 3 months when date parameters are not specified. Default limit is 20 records per page, maximum is 100.
Parámetros de entrada
pageintegerPage number for pagination of results. Default: 1. Range: 1 to 2147483647
limitintegerNumber of results per page. Default: 20. Maximum: 100
to_datestringEnd date for filtering campaigns by last update date. Default: current date. Format: Date string
from_datestringStart date for filtering campaigns by last update date. Default: 3 months prior to current date. Format: Date string
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get All GroupsACTIVE_TRAIL_GET_ALL_GROUPSAcciónTool to retrieve the full list of account groups with pagination and filtering. Use when you need to get all groups or search for groups by name. Default limit is 20 groups per page.
ACTIVE_TRAIL_GET_ALL_GROUPSAcciónTool to retrieve the full list of account groups with pagination and filtering. Use when you need to get all groups or search for groups by name. Default limit is 20 groups per page.
Parámetros de entrada
pageintegerPage number for pagination. Range: 1-2147483647. Use this to navigate through multiple pages of results.
limitintegerMaximum number of groups to return per page. Range: 1-100. Default: 20.
search_termstringGroup name to search for. Used to filter groups by name.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get All Sent CampaignsACTIVE_TRAIL_GET_ALL_SENT_CAMPAIGNSAcciónTool to retrieve campaigns with optional filtering by date, mailing list, and search criteria. Use when you need to get campaigns filtered by date range (default is last 3 months), limited to a specific number (default is 100), or filtered by mailing list.
ACTIVE_TRAIL_GET_ALL_SENT_CAMPAIGNSAcciónTool to retrieve campaigns with optional filtering by date, mailing list, and search criteria. Use when you need to get campaigns filtered by date range (default is last 3 months), limited to a specific number (default is 100), or filtered by mailing list.
Parámetros de entrada
pageintegerPage number for pagination. Default is 0
limitintegerMaximum number of campaigns to return per page. Default is 100, maximum is 100
to_datestringEnd date for filtering campaigns in ISO format (YYYY-MM-DD). Default is current date if not specified
from_datestringStart date for filtering campaigns in ISO format (YYYY-MM-DD). Default is 3 months back from current date if not specified
send_typestringFilter campaigns by send type
search_termstringSearch campaigns by name or other search criteria
mailing_list_idstringFilter campaigns by specific mailing list ID
content_category_idstringFilter campaigns by content category ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SMS Campaign Delivered ListACTIVE_TRAIL_GET_A_SPECIFIC_SMS_CAMPAIGN_S_DELIVERED_LISTAcciónTool to get a specific SMS campaign's delivered list data. Use when you need to retrieve contacts who successfully received the SMS message. Note: If SMS was sent using manual number entry, only delivery count is returned.
ACTIVE_TRAIL_GET_A_SPECIFIC_SMS_CAMPAIGN_S_DELIVERED_LISTAcciónTool to get a specific SMS campaign's delivered list data. Use when you need to retrieve contacts who successfully received the SMS message. Note: If SMS was sent using manual number entry, only delivery count is returned.
Parámetros de entrada
pageintegerPage number for pagination. Use this to navigate through multiple pages of delivered contact results.
limitintegerNumber of delivered contact records to return per page. Controls the size of each page in paginated results.
to_datestringEnd date for filtering delivered SMS. Format: YYYY-MM-DD or datetime string. Default: current date.
from_datestringStart date for filtering delivered SMS. Format: YYYY-MM-DD or datetime string. Default: 3 months prior to current date.
send_typestringFilter by send type (e.g., immediate, scheduled). Use to narrow down results by how the campaign was sent.
search_termstringSearch term to filter contact results by name, phone number, or other searchable contact fields.
sms_campaign_idstringObligatorioThe unique identifier of the SMS campaign to retrieve delivered contacts for.
Parámetros de salida
dataobject[]List of contacts who successfully received the SMS. May be empty if campaign was sent using manual number entry.
pageintegerCurrent page number in the paginated results
errorstringError if any occurred during the execution of the action
limitintegerNumber of records per page
totalintegerTotal number of delivered SMS records across all pages. Note: If SMS was sent manually (not to a group), only the count is returned without mobile numbers.
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SMS Campaign Recipient DataACTIVE_TRAIL_GET_A_SPECIFIC_SMS_CAMPAIGN_S_RECIPIENT_S_DATAAcciónTool to get a specific SMS campaign's 'sent to' data as a list. Use when you need to retrieve detailed recipient information for an SMS campaign. The search defaults to the last 3 months; campaigns outside the date range return no information.
ACTIVE_TRAIL_GET_A_SPECIFIC_SMS_CAMPAIGN_S_RECIPIENT_S_DATAAcciónTool to get a specific SMS campaign's 'sent to' data as a list. Use when you need to retrieve detailed recipient information for an SMS campaign. The search defaults to the last 3 months; campaigns outside the date range return no information.
Parámetros de entrada
pageintegerPage number for pagination (range: 1-2,147,483,647). Use to navigate through multiple pages of results.
limitintegerResults per page (range: 1-100, default: 20). Controls the size of each page in paginated results.
to_datestringEnd date for filtering. Format: YYYY-MM-DD or datetime string. Default: current date.
from_datestringStart date for filtering. Format: YYYY-MM-DD or datetime string. Default: 3 months prior to current date.
send_typeintegerCampaign type filter: 0=All, 1=Regular, 2=Test, 3=Transactional. Use to filter by how the campaign was sent.
search_termstringFilter by campaign name or partial name. Use to search for specific recipients.
sms_campaign_idintegerObligatorioSMS campaign identifier. Can be obtained from 'Get account's SMS campaigns' endpoint or UI inspection.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SMS Campaign Unsubscribed ListACTIVE_TRAIL_GET_A_SPECIFIC_SMS_CAMPAIGN_S_UNSUBSCRIBED_LISTAcciónTool to get a specific SMS campaign's unsubscribed data as a list. Use when you need to retrieve contacts who opted out of receiving future SMS messages from a specific campaign. Note: If SMS was sent using manual number entry, only the unsubscribe count is returned without individual phone numbers. Default search range is last 3 months.
ACTIVE_TRAIL_GET_A_SPECIFIC_SMS_CAMPAIGN_S_UNSUBSCRIBED_LISTAcciónTool to get a specific SMS campaign's unsubscribed data as a list. Use when you need to retrieve contacts who opted out of receiving future SMS messages from a specific campaign. Note: If SMS was sent using manual number entry, only the unsubscribe count is returned without individual phone numbers. Default search range is last 3 months.
Parámetros de entrada
pageintegerPage number for pagination. Use this to navigate through multiple pages of unsubscribed contact results.
limitintegerNumber of unsubscribed contact records to return per page. Controls the size of each page in paginated results.
to_datestringEnd date for filtering unsubscribed SMS. Format: YYYY-MM-DD or datetime string. Default: current date.
from_datestringStart date for filtering unsubscribed SMS. Format: YYYY-MM-DD or datetime string. Default: 3 months prior to current date.
send_typestringFilter by send type (e.g., immediate, scheduled). Use to narrow down results by how the campaign was sent.
search_termstringSearch term to filter contact results by name, phone number, or other searchable contact fields.
rows_affectedintegerNumber of rows affected in the result set for pagination purposes.
sms_campaign_idstringObligatorioThe unique identifier of the SMS campaign to retrieve unsubscribed contacts for.
previous_row_countintegerPrevious row count for pagination purposes.
Parámetros de salida
dataobject[]List of contacts who unsubscribed from the SMS campaign. May be empty if campaign was sent using manual number entry.
pageintegerCurrent page number in the paginated results
countintegerCount of unsubscribes (used when phone numbers are not available for manually added numbers)
errorstringError if any occurred during the execution of the action
limitintegerNumber of records per page
totalintegerTotal number of unsubscribed SMS records across all pages. Note: If SMS was sent manually (not to a group), only the count is returned without mobile numbers.
page_sizeintegerNumber of records returned in the current page
successfulbooleanObligatorioWhether or not the action execution was successful or not
unsubscribesobject[]List of unsubscribed contacts (alternative field name)
Get Automation LogACTIVE_TRAIL_GET_AUTOMATION_LOGAcciónTool to track contacts through automation journey by retrieving detailed logs. Use when you need to see which contacts started a specific automation and their progress through each step of the workflow.
ACTIVE_TRAIL_GET_AUTOMATION_LOGAcciónTool to track contacts through automation journey by retrieving detailed logs. Use when you need to see which contacts started a specific automation and their progress through each step of the workflow.
Parámetros de entrada
idstringObligatorioThe automation ID for which to retrieve contact logs. This identifies the specific automation workflow whose contact journey logs you want to track.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Automation Queue LogsACTIVE_TRAIL_GET_AUTOMATION_REPORTS_LOG_AUTOMATION_QUEUEAcciónTool to retrieve contacts that did not finish a specific automation. Use when you need to get the list of contacts remaining in the automation queue for a given automation ID.
ACTIVE_TRAIL_GET_AUTOMATION_REPORTS_LOG_AUTOMATION_QUEUEAcciónTool to retrieve contacts that did not finish a specific automation. Use when you need to get the list of contacts remaining in the automation queue for a given automation ID.
Parámetros de entrada
idintegerObligatorioThe automation ID for which to retrieve queue logs. This identifies the specific automation workflow to query.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Automation SMS Campaign Summary ReportACTIVE_TRAIL_GET_AUTOMATION_REPORTS_SMS_CAMPAIGN_SUMMARY_REPORTAcciónTool to retrieve SMS campaigns' summary reports for a specific automation. Use when you need to analyze SMS campaign performance including sent, delivered, failed, credits consumed, unsubscribe, and click metrics within an automation.
ACTIVE_TRAIL_GET_AUTOMATION_REPORTS_SMS_CAMPAIGN_SUMMARY_REPORTAcciónTool to retrieve SMS campaigns' summary reports for a specific automation. Use when you need to analyze SMS campaign performance including sent, delivered, failed, credits consumed, unsubscribe, and click metrics within an automation.
Parámetros de entrada
idintegerObligatorioAutomation id. Can be found using the endpoint 'Get account's automations'
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get AutomationsACTIVE_TRAIL_GET_AUTOMATIONSAcciónTool to list account automations with filtering and pagination. Use when you need to retrieve automations from the ActiveTrail account. Supports filtering by state and pagination parameters.
ACTIVE_TRAIL_GET_AUTOMATIONSAcciónTool to list account automations with filtering and pagination. Use when you need to retrieve automations from the ActiveTrail account. Supports filtering by state and pagination parameters.
Parámetros de entrada
pageintegerPage number for pagination of results. Used to navigate through multiple pages of automations.
limitintegerMaximum number of automation records to return per page. Controls the number of results returned in each request.
state_typestringFilter automations by their operational status/state. Used to filter which automations to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Automation DetailsACTIVE_TRAIL_GET_AUTOMATIONS_DETAILSAcciónTool to retrieve detailed configuration of a specific automation excluding step-by-step execution details. Use when you need metadata about automation behavior, scheduling, reporting settings, and operational constraints.
ACTIVE_TRAIL_GET_AUTOMATIONS_DETAILSAcciónTool to retrieve detailed configuration of a specific automation excluding step-by-step execution details. Use when you need metadata about automation behavior, scheduling, reporting settings, and operational constraints.
Parámetros de entrada
idintegerObligatorioAutomation identifier. Can be found using the 'Get account's automations' endpoint or via the UI.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Automation Email Campaign StepsACTIVE_TRAIL_GET_AUTOMATIONS_EMAIL_CAMPAIGN_STEPSAcciónTool to retrieve all email campaign steps in an automation workflow. Use when you need to get details about all 'send email' steps configured within a specific automation, including email content, scheduling, and tracking settings.
ACTIVE_TRAIL_GET_AUTOMATIONS_EMAIL_CAMPAIGN_STEPSAcciónTool to retrieve all email campaign steps in an automation workflow. Use when you need to get details about all 'send email' steps configured within a specific automation, including email content, scheduling, and tracking settings.
Parámetros de entrada
idintegerObligatorioAutomation ID. Can be found using the 'Get Automations' endpoint or in the UI. This identifies the specific automation workflow whose email sending steps you want to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Automation SMS Campaign StepsACTIVE_TRAIL_GET_AUTOMATIONS_SMS_CAMPAIGN_STEPSAcciónTool to retrieve all SMS campaign steps in an automation workflow. Use when you need to get details about all 'send SMS' steps configured within a specific automation, including SMS content, scheduling, and tracking settings.
ACTIVE_TRAIL_GET_AUTOMATIONS_SMS_CAMPAIGN_STEPSAcciónTool to retrieve all SMS campaign steps in an automation workflow. Use when you need to get details about all 'send SMS' steps configured within a specific automation, including SMS content, scheduling, and tracking settings.
Parámetros de entrada
idintegerObligatorioAutomation ID. Can be found using the 'Get Automations' endpoint or in the UI. This identifies the specific automation workflow whose SMS sending steps you want to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Automation Trigger TypesACTIVE_TRAIL_GET_AUTOMATION_TRIGGER_TYPESAcciónTool to retrieve all available start trigger options for automations. Use when you need to get the list of trigger types that can initiate automation workflows in ActiveTrail.
ACTIVE_TRAIL_GET_AUTOMATION_TRIGGER_TYPESAcciónTool to retrieve all available start trigger options for automations. Use when you need to get the list of trigger types that can initiate automation workflows in ActiveTrail.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Campaign BouncesACTIVE_TRAIL_GET_CAMPAIGN_BOUNCESAcciónTool to retrieve bounce details by domain for a specific campaign. Use when you need to analyze campaign bounce rates and identify problematic email domains. Defaults to campaigns updated in the last 3 months.
ACTIVE_TRAIL_GET_CAMPAIGN_BOUNCESAcciónTool to retrieve bounce details by domain for a specific campaign. Use when you need to analyze campaign bounce rates and identify problematic email domains. Defaults to campaigns updated in the last 3 months.
Parámetros de entrada
idstringObligatorioCampaign identifier. Can be found using the 'Get account's email campaigns' endpoint or in the UI.
pageintegerPage number for pagination. Use this to navigate through multiple pages of bounce results.
limitintegerNumber of bounce records to return per page. Controls the size of each page in paginated results.
to_datestringdateEnd date for filtering bounce results. Format: YYYY-MM-DD. If not provided, defaults to current date.
from_datestringdateStart date for filtering bounce results. Format: YYYY-MM-DD. If not provided, defaults to three months prior to current date.
Parámetros de salida
dataobject[]List of bounce data organized by domain
pageintegerCurrent page number in paginated results
errorstringError if any occurred during the execution of the action
limitintegerNumber of records per page
totalintegerTotal number of bounce records across all pages
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Campaign Click-Through DataACTIVE_TRAIL_GET_CAMPAIGN_CLICKSAcciónTool to access click-through data for a specific campaign. Use when you need to retrieve detailed information about link clicks, including contact details, timestamps, and device information. By default, the search covers campaigns updated in the last 3 months; if the campaign wasn't sent in the specified date range, an error will be returned.
ACTIVE_TRAIL_GET_CAMPAIGN_CLICKSAcciónTool to access click-through data for a specific campaign. Use when you need to retrieve detailed information about link clicks, including contact details, timestamps, and device information. By default, the search covers campaigns updated in the last 3 months; if the campaign wasn't sent in the specified date range, an error will be returned.
Parámetros de entrada
idstringObligatorioThe campaign identifier for which to retrieve click-through data.
pageintegerPage number for pagination. Use this to navigate through multiple pages of results.
limitintegerNumber of records to return per page. Controls the size of each page in paginated results.
link_idstringSpecific link identifier to filter click details by a particular link.
to_datestringEnd date for filtering click data. Format: YYYY-MM-DD.
from_datestringStart date for filtering click data. Format: YYYY-MM-DD. Default is last 3 months if not specified. Note: if the campaign wasn't sent in the given dates, you'll get an error.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Campaign ComplaintsACTIVE_TRAIL_GET_CAMPAIGN_COMPLAINTSAcciónTool to retrieve contacts who reported a specific campaign as spam. Use when you need to identify which contacts flagged your campaign as unwanted. Supports filtering by Group ID and date range with pagination.
ACTIVE_TRAIL_GET_CAMPAIGN_COMPLAINTSAcciónTool to retrieve contacts who reported a specific campaign as spam. Use when you need to identify which contacts flagged your campaign as unwanted. Supports filtering by Group ID and date range with pagination.
Parámetros de entrada
pageintegerPage number for pagination. Use this to navigate through multiple pages of results.
limitintegerNumber of records to return per page. Controls the size of each page in paginated results.
groupidstringOptional filter to get complaints from a specific group only.
to_datestringEnd date for filtering complaints. Default: current date. Format: Date string (YYYY-MM-DD).
from_datestringStart date for filtering complaints. Default: 3 months prior to current date. Format: Date string (YYYY-MM-DD).
campaign_idstringObligatorioThe campaign identifier for which to retrieve spam complaint details.
Parámetros de salida
dataobject[]List of contacts who reported the campaign as spam. Returns empty list if no results match the search criteria.
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Campaign DesignACTIVE_TRAIL_GET_CAMPAIGN_DESIGNAcciónTool to retrieve campaign design configuration including visual layout and HTML content. Use when you need to get the design details of a specific email campaign.
ACTIVE_TRAIL_GET_CAMPAIGN_DESIGNAcciónTool to retrieve campaign design configuration including visual layout and HTML content. Use when you need to get the design details of a specific email campaign.
Parámetros de entrada
idstringObligatorioThe unique identifier of the campaign. Can be found using 'Get account's email campaigns' endpoint or in the UI.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Campaign Domains ReportACTIVE_TRAIL_GET_CAMPAIGN_DOMAINS_REPORTAcciónTool to retrieve a report by domain for a specific campaign. Use when you need to analyze campaign performance grouped by recipient email domains, including sends, opens, clicks, bounces, and engagement metrics per domain. Defaults to campaigns updated in the last 3 months.
ACTIVE_TRAIL_GET_CAMPAIGN_DOMAINS_REPORTAcciónTool to retrieve a report by domain for a specific campaign. Use when you need to analyze campaign performance grouped by recipient email domains, including sends, opens, clicks, bounces, and engagement metrics per domain. Defaults to campaigns updated in the last 3 months.
Parámetros de entrada
pageintegerSpecific results page number for pagination. Range: 1-2147483647
limitintegerNumber of results per page. Range: 1-100. Default: 20
to_datestringCampaign last-update end date. Filters campaigns updated until this date. Format: Date string
from_datestringCampaign last-update start date. Filters campaigns updated from this date. Format: Date string
campaign_idstringObligatorioCampaign identifier. Can be found using the 'Get account's email campaigns' endpoint or in the UI by navigating to Emails->Emails Lists->clicking on the campaign's preview (id will be in the URL).
Parámetros de salida
dataobject[]List of domain statistics with performance metrics for the campaign
pageintegerCurrent page number in paginated results
errorstringError if any occurred during the execution of the action
limitintegerNumber of records per page
totalintegerTotal number of domains in the report across all pages
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Campaign OpensACTIVE_TRAIL_GET_CAMPAIGN_OPENSAcciónTool to retrieve contacts who opened a specific campaign. Use when you need to identify which recipients opened your campaign email. By default, searches for campaigns updated in the last 3 months. Can filter by contact group and date range.
ACTIVE_TRAIL_GET_CAMPAIGN_OPENSAcciónTool to retrieve contacts who opened a specific campaign. Use when you need to identify which recipients opened your campaign email. By default, searches for campaigns updated in the last 3 months. Can filter by contact group and date range.
Parámetros de entrada
idstringObligatorioCampaign identifier. Can be found using the 'Get account's email campaigns' endpoint or in the UI.
pageintegerSpecific results page number for pagination. Valid range: 1-2147483647.
limitintegerLimit the number of items in the results. Valid range: 1-100. Defaults to 20 if not provided.
groupidintegerOptional contact group identifier to filter openers from a specific group only.
to_datestringCampaign update end date for filtering. Format: YYYY-MM-DD. If not provided, defaults to current date.
from_datestringCampaign update start date for filtering. Format: YYYY-MM-DD. If not provided, defaults to three months prior to current date.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Campaign ReportACTIVE_TRAIL_GET_CAMPAIGN_REPORTAcciónTool to retrieve an overview report for a specific campaign. Use when you need to get campaign performance metrics including sends, opens, clicks, and engagement statistics. Note: If the campaign wasn't sent within the specified date range, an error will be returned.
ACTIVE_TRAIL_GET_CAMPAIGN_REPORTAcciónTool to retrieve an overview report for a specific campaign. Use when you need to get campaign performance metrics including sends, opens, clicks, and engagement statistics. Note: If the campaign wasn't sent within the specified date range, an error will be returned.
Parámetros de entrada
idstringObligatorioCampaign identifier to retrieve the report for
pageintegerPagination page number for results
limitintegerMaximum number of results per page
to_datestringEnd date for report filtering. Default: current date. Format: Date string
from_datestringStart date for report filtering. Default: 3 months prior to current date. Format: Date string
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Campaign Bounced Emails by TypeACTIVE_TRAIL_GET_CAMPAIGN_REPORTS_BOUNCEDAcciónTool to retrieve bounced email details filtered by bounce type for a specific campaign. Use when you need detailed information about which contacts' emails bounced and why, with the ability to filter by hard or soft bounces.
ACTIVE_TRAIL_GET_CAMPAIGN_REPORTS_BOUNCEDAcciónTool to retrieve bounced email details filtered by bounce type for a specific campaign. Use when you need detailed information about which contacts' emails bounced and why, with the ability to filter by hard or soft bounces.
Parámetros de entrada
idstringObligatorioThe campaign identifier for which to retrieve bounced email details.
pageintegerPage number for pagination. Use this to navigate through multiple pages of results.
limitintegerNumber of records to return per page. Controls the size of each page in paginated results.
bounce_typestringenumType of bounce to filter results. 'hard' for permanent delivery failures, 'soft' for temporary failures. If not provided, returns all bounce types.
hardsoft
Parámetros de salida
dataobject[]List of bounced contact records for the campaign
pageintegerCurrent page number in the paginated results
errorstringError if any occurred during the execution of the action
limitintegerNumber of records per page
totalintegerTotal number of bounced email records across all pages
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Campaign Click Details ReportACTIVE_TRAIL_GET_CAMPAIGN_REPORTS_CLICK_DETAILSAcciónTool to retrieve click details report for a specific campaign. Use when you need to get detailed information about clicks on links in a campaign, including contact information, click timestamps, and device details. By default, the search covers campaigns updated in the last 3 months; if the campaign wasn't sent in the specified date range, an error will be returned.
ACTIVE_TRAIL_GET_CAMPAIGN_REPORTS_CLICK_DETAILSAcciónTool to retrieve click details report for a specific campaign. Use when you need to get detailed information about clicks on links in a campaign, including contact information, click timestamps, and device details. By default, the search covers campaigns updated in the last 3 months; if the campaign wasn't sent in the specified date range, an error will be returned.
Parámetros de entrada
idstringObligatorioThe campaign identifier for which to retrieve click details report.
pageintegerPage number for pagination. Use this to navigate through multiple pages of results.
limitintegerNumber of records to return per page. Controls the size of each page in paginated results.
to_datestringEnd date for filtering click details. Format: YYYY-MM-DD.
from_datestringStart date for filtering click details. Format: YYYY-MM-DD. Default is last 3 months if not specified. Note: if the campaign wasn't sent in the given dates, you'll get an error.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Campaign Spam ComplaintsACTIVE_TRAIL_GET_CAMPAIGN_REPORTS_COMPLAINTSAcciónTool to retrieve contacts who reported a specific campaign as spam. Use when you need to identify which contacts flagged your campaign as unwanted. The default search window is the last 3 months; if the campaign wasn't sent during the specified dates, an empty list is returned.
ACTIVE_TRAIL_GET_CAMPAIGN_REPORTS_COMPLAINTSAcciónTool to retrieve contacts who reported a specific campaign as spam. Use when you need to identify which contacts flagged your campaign as unwanted. The default search window is the last 3 months; if the campaign wasn't sent during the specified dates, an empty list is returned.
Parámetros de entrada
idstringObligatorioThe campaign identifier for which to retrieve spam complaint details.
pageintegerPage number for pagination. Use this to navigate through multiple pages of results.
limitintegerNumber of records to return per page. Controls the size of each page in paginated results.
groupidstringOptional filter to get complaints from a specific group only.
to_datestringEnd date for filtering complaints. Default: current date. Format: Date string (YYYY-MM-DD).
from_datestringStart date for filtering complaints. Default: 3 months prior to current date. Format: Date string (YYYY-MM-DD).
Parámetros de salida
dataobject[]List of contacts who reported the campaign as spam
pageintegerCurrent page number in the paginated results
errorstringError if any occurred during the execution of the action
limitintegerNumber of records per page
totalintegerTotal number of spam complaint records across all pages
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Campaign Email Activity ReportACTIVE_TRAIL_GET_CAMPAIGN_REPORTS_EMAIL_ACTIVITYAcciónTool to retrieve all contacts' activity on a specific campaign. Use when you need comprehensive activity data including opens, clicks, bounces, and other engagement metrics for each contact in a campaign. By default, the search covers campaigns updated in the last 3 months; if the campaign wasn't sent in the specified date range, an error will be returned.
ACTIVE_TRAIL_GET_CAMPAIGN_REPORTS_EMAIL_ACTIVITYAcciónTool to retrieve all contacts' activity on a specific campaign. Use when you need comprehensive activity data including opens, clicks, bounces, and other engagement metrics for each contact in a campaign. By default, the search covers campaigns updated in the last 3 months; if the campaign wasn't sent in the specified date range, an error will be returned.
Parámetros de entrada
idstringObligatorioThe campaign identifier for which to retrieve email activity details.
pageintegerPage number for pagination. Use this to navigate through multiple pages of results.
limitintegerNumber of records to return per page. Controls the size of each page in paginated results. Maximum: 100.
to_datestringEnd date for filtering email activity. Format: YYYY-MM-DD.
from_datestringStart date for filtering email activity. Format: YYYY-MM-DD. Default is last 3 months if not specified. Note: if the campaign wasn't sent in the given dates, you'll get an error.
Parámetros de salida
dataobject[]List of email activity records for all contacts in the campaign
pageintegerCurrent page number in the paginated results
errorstringError if any occurred during the execution of the action
limitintegerNumber of records per page
totalintegerTotal number of email activity records across all pages
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Campaign Sent EmailsACTIVE_TRAIL_GET_CAMPAIGN_REPORTS_SENTAcciónTool to retrieve contacts who received a specific campaign email. Use when you need to identify which recipients successfully received your campaign. The default search window is the last 3 months; if the campaign wasn't sent during the specified dates, an empty list is returned.
ACTIVE_TRAIL_GET_CAMPAIGN_REPORTS_SENTAcciónTool to retrieve contacts who received a specific campaign email. Use when you need to identify which recipients successfully received your campaign. The default search window is the last 3 months; if the campaign wasn't sent during the specified dates, an empty list is returned.
Parámetros de entrada
idstringObligatorioThe campaign identifier for which to retrieve sent email details.
pageintegerPage number for pagination. Use this to navigate through multiple pages of results.
limitintegerNumber of records to return per page. Controls the size of each page in paginated results.
groupidstringOptional filter to get sent emails from a specific group only.
to_datestringEnd date for filtering sent emails. Default: current date. Format: Date string (YYYY-MM-DD).
from_datestringStart date for filtering sent emails. Default: 3 months prior to current date. Format: Date string (YYYY-MM-DD).
Parámetros de salida
dataobject[]List of contacts who received the campaign
pageintegerCurrent page number in the paginated results
errorstringError if any occurred during the execution of the action
limitintegerNumber of records per page
totalintegerTotal number of sent email records across all pages
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Campaign Unopened ContactsACTIVE_TRAIL_GET_CAMPAIGN_REPORTS_UNOPENEDAcciónTool to retrieve contacts who did not open a specific campaign. Use when you need to identify which recipients received but did not open your campaign email. The default search window is the last 3 months; if the campaign wasn't sent during the specified dates, an empty list is returned.
ACTIVE_TRAIL_GET_CAMPAIGN_REPORTS_UNOPENEDAcciónTool to retrieve contacts who did not open a specific campaign. Use when you need to identify which recipients received but did not open your campaign email. The default search window is the last 3 months; if the campaign wasn't sent during the specified dates, an empty list is returned.
Parámetros de entrada
idstringObligatorioThe campaign identifier for which to retrieve unopened contact details.
pageintegerPage number for pagination. Use this to navigate through multiple pages of results.
limitintegerNumber of records to return per page. Controls the size of each page in paginated results.
groupidstringOptional filter to get unopened contacts from a specific group only.
to_datestringEnd date for filtering unopened contacts. Default: current date. Format: Date string (YYYY-MM-DD).
from_datestringStart date for filtering unopened contacts. Default: 3 months prior to current date. Format: Date string (YYYY-MM-DD).
Parámetros de salida
dataobject[]List of contacts who did not open the campaign
pageintegerCurrent page number in the paginated results
errorstringError if any occurred during the execution of the action
limitintegerNumber of records per page
totalintegerTotal number of unopened contact records across all pages
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Campaign SchedulingACTIVE_TRAIL_GET_CAMPAIGN_SCHEDULINGAcciónTool to retrieve campaign schedule configuration including timing and delivery settings. Use when you need to get the scheduling details of a specific email campaign.
ACTIVE_TRAIL_GET_CAMPAIGN_SCHEDULINGAcciónTool to retrieve campaign schedule configuration including timing and delivery settings. Use when you need to get the scheduling details of a specific email campaign.
Parámetros de entrada
idstringObligatorioThe unique identifier of the campaign. Can be found using 'Get account's email campaigns' endpoint or in the UI.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Campaign by IDACTIVE_TRAIL_GET_CAMPAIGN_S_DETAILSAcciónTool to retrieve complete campaign information including send settings, design, template, and A/B test configuration. Use when you need comprehensive details about a specific email campaign.
ACTIVE_TRAIL_GET_CAMPAIGN_S_DETAILSAcciónTool to retrieve complete campaign information including send settings, design, template, and A/B test configuration. Use when you need comprehensive details about a specific email campaign.
Parámetros de entrada
campaign_idintegerObligatorioCampaign identifier. Can be found using the endpoint 'Get account's email campaigns...' or in the UI
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Campaign DetailsACTIVE_TRAIL_GET_CAMPAIGNS_DETAILSAcciónTool to retrieve detailed campaign information including name, subject, and settings. Use when you need to get comprehensive details about a specific email campaign.
ACTIVE_TRAIL_GET_CAMPAIGNS_DETAILSAcciónTool to retrieve detailed campaign information including name, subject, and settings. Use when you need to get comprehensive details about a specific email campaign.
Parámetros de entrada
idintegerObligatorioCampaign identifier. Can be found using the 'Get account's email campaigns' endpoint or via the UI.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Campaign by ID (Copy)ACTIVE_TRAIL_GET_CAMPAIGN_S_DETAILS_COPYAcciónTool to retrieve complete campaign information including send settings, design, template, and A/B test configuration. Use when you need comprehensive details about a specific email campaign.
ACTIVE_TRAIL_GET_CAMPAIGN_S_DETAILS_COPYAcciónTool to retrieve complete campaign information including send settings, design, template, and A/B test configuration. Use when you need comprehensive details about a specific email campaign.
Parámetros de entrada
campaign_idintegerObligatorioCampaign id. Can be found using the endpoint 'Get account's email campaigns...' or in the UI
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Campaign Segment SettingsACTIVE_TRAIL_GET_CAMPAIGNS_SEGMENTAcciónTool to retrieve campaign sending settings including target groups and sending restrictions. Use when you need to get the segmentation configuration for a specific campaign.
ACTIVE_TRAIL_GET_CAMPAIGNS_SEGMENTAcciónTool to retrieve campaign sending settings including target groups and sending restrictions. Use when you need to get the segmentation configuration for a specific campaign.
Parámetros de entrada
idstringObligatorioThe unique identifier of the campaign. Can be found using 'Get account's email campaigns' endpoint or in the UI.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Sent CampaignsACTIVE_TRAIL_GET_CAMPAIGNS_SENT_CAMPAIGNSAcciónTool to retrieve a list of all sent campaigns from ActiveTrail. Use when you need to view all campaigns that have been sent, including their details such as name, subject, send status, and delivery metrics.
ACTIVE_TRAIL_GET_CAMPAIGNS_SENT_CAMPAIGNSAcciónTool to retrieve a list of all sent campaigns from ActiveTrail. Use when you need to view all campaigns that have been sent, including their details such as name, subject, send status, and delivery metrics.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Campaign TemplateACTIVE_TRAIL_GET_CAMPAIGN_TEMPLATEAcciónTool to retrieve template details associated with a specific campaign. Use when you need to get the template information used in a campaign.
ACTIVE_TRAIL_GET_CAMPAIGN_TEMPLATEAcciónTool to retrieve template details associated with a specific campaign. Use when you need to get the template information used in a campaign.
Parámetros de entrada
idstringObligatorioThe unique identifier of the campaign. Can be found using 'Get account's email campaigns' endpoint or in the UI.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Campaign Unopened ContactsACTIVE_TRAIL_GET_CAMPAIGN_UNOPENSAcciónTool to retrieve contacts who did not open a specific campaign. Use when you need to identify recipients who received but did not open your campaign email. Default search covers campaigns updated in the last 3 months; if the campaign wasn't sent during the specified date range, an empty list is returned. Supports pagination and filtering by group.
ACTIVE_TRAIL_GET_CAMPAIGN_UNOPENSAcciónTool to retrieve contacts who did not open a specific campaign. Use when you need to identify recipients who received but did not open your campaign email. Default search covers campaigns updated in the last 3 months; if the campaign wasn't sent during the specified date range, an empty list is returned. Supports pagination and filtering by group.
Parámetros de entrada
pageintegerPage number for pagination. Valid range: 1-2147483647.
limitintegerNumber of records per page. Valid range: 1-100. Default: 20.
groupidintegerOptional group identifier to filter results by specific group. Obtain via the 'Get account's groups' endpoint.
to_datestringCampaign last-update end date for filtering. Format: YYYY-MM-DD. Default: current date.
from_datestringCampaign last-update start date for filtering. Format: YYYY-MM-DD. Default: 3 months back from current date.
campaign_idintegerObligatorioCampaign identifier. Can be found using the 'Get account's email campaigns' endpoint.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Campaign Unsubscribed ContactsACTIVE_TRAIL_GET_CAMPAIGN_UNSUBSCRIBEDAcciónTool to retrieve contacts who unsubscribed from a specific email campaign. Use when you need to identify which recipients opted out of receiving future emails. The search defaults to campaigns updated within the last 3 months; if the campaign wasn't sent during the specified date range, an empty list is returned.
ACTIVE_TRAIL_GET_CAMPAIGN_UNSUBSCRIBEDAcciónTool to retrieve contacts who unsubscribed from a specific email campaign. Use when you need to identify which recipients opted out of receiving future emails. The search defaults to campaigns updated within the last 3 months; if the campaign wasn't sent during the specified date range, an empty list is returned.
Parámetros de entrada
idintegerObligatorioCampaign identifier. The unique ID of the campaign. Can be found via the 'Get account's email campaigns' endpoint or in the UI.
pageintegerPage number for pagination. Use this to navigate through multiple pages of results. Valid range: 1 to 2147483647.
limitintegerNumber of records to return per page. Controls the size of each page in paginated results. Valid range: 1 to 100. Defaults to 20 if not specified.
to_datestringEnd date for filtering campaign updates. Limits search to campaigns updated before this date. Format: YYYY-MM-DD. Defaults to current date if not specified.
from_datestringStart date for filtering campaign updates. Limits search to campaigns updated after this date. Format: YYYY-MM-DD. Defaults to 3 months prior if not specified.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Click Details by Link IDACTIVE_TRAIL_GET_CLICK_DETAILS_BY_LINK_IDAcciónTool to retrieve click details for a specific link within a campaign. Use when you need detailed information about who clicked a particular link, including contact details, timestamps, and device information. By default, the search covers campaigns updated in the last 3 months.
ACTIVE_TRAIL_GET_CLICK_DETAILS_BY_LINK_IDAcciónTool to retrieve click details for a specific link within a campaign. Use when you need detailed information about who clicked a particular link, including contact details, timestamps, and device information. By default, the search covers campaigns updated in the last 3 months.
Parámetros de entrada
pageintegerPage number for pagination. Use this to navigate through multiple pages of results. Defaults to 0.
limitintegerNumber of records to return per page. Controls the size of each page in paginated results. Maximum 100, defaults to 100.
link_idintegerObligatorioThe specific link identifier within the campaign to retrieve click details for.
to_datestringEnd date for filtering click data. Format: ISO 8601 date (YYYY-MM-DD).
from_datestringStart date for filtering click data. Format: ISO 8601 date (YYYY-MM-DD). Default is last 3 months if not specified. Note: if the campaign wasn't sent in the given dates, you'll get an error.
campaign_idintegerObligatorioThe campaign identifier for which to retrieve click details.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Contact ActivityACTIVE_TRAIL_GET_CONTACT_ACTIVITYAcciónTool to retrieve contact's email engagement history including opens and clicks. Use when you need detailed activity data showing which campaigns were sent to a contact and their engagement metrics.
ACTIVE_TRAIL_GET_CONTACT_ACTIVITYAcciónTool to retrieve contact's email engagement history including opens and clicks. Use when you need detailed activity data showing which campaigns were sent to a contact and their engagement metrics.
Parámetros de entrada
idintegerObligatorioContact identifier. Can be found using the 'Get account's contacts list' endpoint
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Contact BouncesACTIVE_TRAIL_GET_CONTACT_BOUNCESAcciónTool to retrieve bounce activity for a specific contact by contact ID. Use when you need to understand email delivery failures and bounce patterns for a contact's email address.
ACTIVE_TRAIL_GET_CONTACT_BOUNCESAcciónTool to retrieve bounce activity for a specific contact by contact ID. Use when you need to understand email delivery failures and bounce patterns for a contact's email address.
Parámetros de entrada
contact_idintegerObligatorioContact identifier. Can be found using the 'Get account's contacts list' endpoint
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Contact FieldsACTIVE_TRAIL_GET_CONTACT_FIELDSAcciónTool to retrieve account contact fields filtered by type. Use when you need to get contact field definitions from the ActiveTrail account.
ACTIVE_TRAIL_GET_CONTACT_FIELDSAcciónTool to retrieve account contact fields filtered by type. Use when you need to get contact field definitions from the ActiveTrail account.
Parámetros de entrada
fields_typestringFilter contact fields by type. Used to filter which contact fields to retrieve from the account.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Contact GroupsACTIVE_TRAIL_GET_CONTACT_GROUPSAcciónTool to retrieve all groups associated with a specific contact. Use when you need to list a contact's group memberships by contact ID.
ACTIVE_TRAIL_GET_CONTACT_GROUPSAcciónTool to retrieve all groups associated with a specific contact. Use when you need to list a contact's group memberships by contact ID.
Parámetros de entrada
idintegerObligatorioContact ID to retrieve group memberships for. Can be found using the endpoint 'Get account's contacts list'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Contact ListACTIVE_TRAIL_GET_CONTACT_LISTAcciónTool to retrieve account contacts filtered by status and date range. Use when you need to get a list of contacts filtered by customer status (active, unsubscribed, bounced, etc.) or by registration date. Default behavior: retrieves contacts modified within the last three months with a limit of 100 contacts per page.
ACTIVE_TRAIL_GET_CONTACT_LISTAcciónTool to retrieve account contacts filtered by status and date range. Use when you need to get a list of contacts filtered by customer status (active, unsubscribed, bounced, etc.) or by registration date. Default behavior: retrieves contacts modified within the last three months with a limit of 100 contacts per page.
Parámetros de entrada
pageintegerPage number for pagination, zero-indexed. Default: 0 (first page). Note: page=1 will skip the first page of results
limitintegerNumber of results per page. Default: 100. Maximum: 100
to_datestringdateEnd date for state change filtering. Defaults to current date if not provided
from_datestringdateStart date for state change filtering. Defaults to three months back from current date if not provided
search_termstringSearch term for filtering contacts across contact fields
customer_statesstringFilter contacts by customer status. Comma-separated values for multiple statuses.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Contact's ErrorsACTIVE_TRAIL_GET_CONTACTS_ERRORSAcciónTool to retrieve bounce and error history for a specific contact. Use when you need to understand delivery issues or bounce patterns for a contact's email address.
ACTIVE_TRAIL_GET_CONTACTS_ERRORSAcciónTool to retrieve bounce and error history for a specific contact. Use when you need to understand delivery issues or bounce patterns for a contact's email address.
Parámetros de entrada
idstringObligatorioThe unique contact identifier to retrieve bounces for
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Contact's Mailing ListsACTIVE_TRAIL_GET_CONTACTS_MAILINGLISTSAcciónTool to retrieve all mailing lists associated with a specific contact. Use when you need to list a contact's mailing list memberships by contact ID.
ACTIVE_TRAIL_GET_CONTACTS_MAILINGLISTSAcciónTool to retrieve all mailing lists associated with a specific contact. Use when you need to list a contact's mailing list memberships by contact ID.
Parámetros de entrada
idintegerObligatorioContact ID to retrieve mailing lists for. Can be found using the 'Get account's contacts list' endpoint.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Contacts MergesACTIVE_TRAIL_GET_CONTACTS_MERGESAcciónTool to retrieve contacts experiencing merge conflicts with filtering options. Use when you need to get the list of contacts with merge conflicts, filtered by status, date range, or limited to a specific number of conflicts.
ACTIVE_TRAIL_GET_CONTACTS_MERGESAcciónTool to retrieve contacts experiencing merge conflicts with filtering options. Use when you need to get the list of contacts with merge conflicts, filtered by status, date range, or limited to a specific number of conflicts.
Parámetros de entrada
pageintegerPage number for pagination of results. Used to navigate through multiple pages of merge conflicts.
limitintegerMaximum number of merge conflicts to return per page. Controls the number of results returned in each request.
to_datestringEnd date for filtering merge conflicts (ISO 8601 format: YYYY-MM-DD). Defaults to current date if not specified.
from_datestringStart date for filtering merge conflicts (ISO 8601 format: YYYY-MM-DD). Defaults to three months back if not specified.
state_typestringFilter contacts by conflict status (e.g., active, inactive, deleted). Used to filter which merge conflicts to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Contacts Subscription All ContactsACTIVE_TRAIL_GET_CONTACTS_SUBSCRIPTION_ALL_CONTACTSAcciónTool to get contacts' subscription status and the source of their status (if known). Use when you need to retrieve all contacts with their subscription status information filtered by creation date. Defaults to three months back if date range is not specified.
ACTIVE_TRAIL_GET_CONTACTS_SUBSCRIPTION_ALL_CONTACTSAcciónTool to get contacts' subscription status and the source of their status (if known). Use when you need to retrieve all contacts with their subscription status information filtered by creation date. Defaults to three months back if date range is not specified.
Parámetros de entrada
pageintegerPage number for pagination. Use this to navigate through multiple pages of results. Must be a positive integer.
limitintegerNumber of records to return per page. Controls the size of each page in paginated results. Must be between 1 and 100.
to_datestringEnd date for filtering contacts by creation date. Format: YYYY-MM-DD. Defaults to current date if not specified.
from_datestringStart date for filtering contacts by creation date. Format: YYYY-MM-DD. Defaults to 3 months prior to current date if not specified.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Contacts Subscription StatusACTIVE_TRAIL_GET_CONTACTS_SUBSCRIPTION_CUSTOMERS_STATUSAcciónTool to get statistics of contacts' statuses from specific dates. Use when you need to retrieve aggregated contact status statistics between date ranges (defaults to three months back).
ACTIVE_TRAIL_GET_CONTACTS_SUBSCRIPTION_CUSTOMERS_STATUSAcciónTool to get statistics of contacts' statuses from specific dates. Use when you need to retrieve aggregated contact status statistics between date ranges (defaults to three months back).
Parámetros de entrada
to_datestringdateEnd date for filtering contact status statistics. If not provided, defaults to the current date
from_datestringdateStart date for filtering contact status statistics. If not provided, defaults to three months prior to the current date
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Contacts Subscription UnsubscribersACTIVE_TRAIL_GET_CONTACTS_SUBSCRIPTION_UNSUBSCRIBERSAcciónTool to retrieve all contacts who unsubscribed and the source of their unsubscription status. Use when you need to get a comprehensive list of unsubscribers. The search defaults to 3 months back if date range is not specified.
ACTIVE_TRAIL_GET_CONTACTS_SUBSCRIPTION_UNSUBSCRIBERSAcciónTool to retrieve all contacts who unsubscribed and the source of their unsubscription status. Use when you need to get a comprehensive list of unsubscribers. The search defaults to 3 months back if date range is not specified.
Parámetros de entrada
pageintegerPage number for pagination. Use this to navigate through multiple pages of results. Valid range: 1 to 2147483647.
limitintegerNumber of records to return per page. Controls the size of each page in paginated results. Valid range: 1 to 100. Defaults to 20 if not specified.
to_datestringEnd date for filtering unsubscription records. Limits search to unsubscribes that occurred before this date. Format: YYYY-MM-DD. Defaults to current date if not specified.
from_datestringStart date for filtering unsubscription records. Limits search to unsubscribes that occurred after this date. Format: YYYY-MM-DD. Defaults to 3 months prior if not specified.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Contacts Unsubscribers SMSACTIVE_TRAIL_GET_CONTACTS_UNSUBSCRIBERS_SMSAcciónTool to retrieve all contacts who unsubscribed from receiving SMS messages. Use when you need to get a list of SMS unsubscribers with optional filtering by date range and pagination support.
ACTIVE_TRAIL_GET_CONTACTS_UNSUBSCRIBERS_SMSAcciónTool to retrieve all contacts who unsubscribed from receiving SMS messages. Use when you need to get a list of SMS unsubscribers with optional filtering by date range and pagination support.
Parámetros de entrada
pageintegerPage number for pagination. Use this to navigate through multiple pages of results. Valid range: 1 to 2147483647.
limitintegerNumber of records to return per page. Controls the size of each page in paginated results. Valid range: 1 to 100. Defaults to 20 if not specified.
to_datestringEnd date for filtering SMS unsubscription records. Limits search to unsubscribes that occurred before this date. Format: YYYY-MM-DD. Defaults to current date if not specified.
from_datestringStart date for filtering SMS unsubscription records. Limits search to unsubscribes that occurred after this date. Format: YYYY-MM-DD. Defaults to 3 months prior if not specified.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Contacts With SMS StateACTIVE_TRAIL_GET_CONTACTS_WITH_SMS_STATEAcciónTool to retrieve account's contacts list with SMS subscription state. Use when you need to get contacts filtered by customer status (active, unsubscribed, bounced, etc.) and by state change date range, with default filtering to three months back.
ACTIVE_TRAIL_GET_CONTACTS_WITH_SMS_STATEAcciónTool to retrieve account's contacts list with SMS subscription state. Use when you need to get contacts filtered by customer status (active, unsubscribed, bounced, etc.) and by state change date range, with default filtering to three months back.
Parámetros de entrada
pageintegerPage number for pagination. Use this to navigate through multiple pages of results.
limitintegerNumber of contacts to return per page. Controls the size of each page in paginated results.
to_datestringdateEnd date for filtering contacts by state change date. Format: YYYY-MM-DD. If not provided, defaults to three months back from current date.
from_datestringdateStart date for filtering contacts by state change date. Format: YYYY-MM-DD. If not provided, defaults to three months back from current date.
search_termstringSearch term for filtering contacts. Use this to search for specific contacts by name, email, or other identifying information.
customer_statesstringFilter by customer status. Comma-separated values for multiple states such as 'active', 'unsubscribed', 'bounced', etc. Use this to filter contacts by their subscription state.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Content CategoriesACTIVE_TRAIL_GET_CONTENT_CATEGORIESAcciónTool to retrieve all content categories from the ActiveTrail account. Use when you need to get the list of categories used for organizing campaigns and templates.
ACTIVE_TRAIL_GET_CONTENT_CATEGORIESAcciónTool to retrieve all content categories from the ActiveTrail account. Use when you need to get the list of categories used for organizing campaigns and templates.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Customer Stats for Transactional MessageACTIVE_TRAIL_GET_CUSTOMER_STATS_FOR_TRANSACTIONAL_MESSAGEAcciónTool to retrieve customer interaction statistics for a specific transactional message. Use when you need to see how a contact engaged with a transactional/operational message including delivery status, opens, clicks, and other interaction metrics.
ACTIVE_TRAIL_GET_CUSTOMER_STATS_FOR_TRANSACTIONAL_MESSAGEAcciónTool to retrieve customer interaction statistics for a specific transactional message. Use when you need to see how a contact engaged with a transactional/operational message including delivery status, opens, clicks, and other interaction metrics.
Parámetros de entrada
contact_idintegerObligatorioContact identifier. The unique ID of the customer/contact whose interaction statistics you want to retrieve
transactional_idintegerObligatorioTransactional message identifier. The unique ID of the operational/transactional message sent to the contact
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Executive ReportACTIVE_TRAIL_GET_EXECUTIVE_REPORTAcciónTool to retrieve executive performance reports for the ActiveTrail account. Use when you need to get a visual overview of email marketing campaign performance over the past 12 months including sent emails, bounce rates, open rates, click rates, complaints, and unsubscribe rates.
ACTIVE_TRAIL_GET_EXECUTIVE_REPORTAcciónTool to retrieve executive performance reports for the ActiveTrail account. Use when you need to get a visual overview of email marketing campaign performance over the past 12 months including sent emails, bounce rates, open rates, click rates, complaints, and unsubscribe rates.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Group DetailsACTIVE_TRAIL_GET_GROUPAcciónTool to retrieve detailed information about a specific group by its unique identifier. Use when you need to fetch group details including name, contact counters, and timestamps.
ACTIVE_TRAIL_GET_GROUPAcciónTool to retrieve detailed information about a specific group by its unique identifier. Use when you need to fetch group details including name, contact counters, and timestamps.
Parámetros de entrada
idintegerObligatorioGroup identifier. Can be found using the endpoint 'Get account's groups' or in the UI.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Group by IDACTIVE_TRAIL_GET_GROUP_BY_IDAcciónTool to retrieve detailed information about a specific group by its unique identifier. Use when you need to fetch group content including name, active/total contact counters, and creation timestamps.
ACTIVE_TRAIL_GET_GROUP_BY_IDAcciónTool to retrieve detailed information about a specific group by its unique identifier. Use when you need to fetch group content including name, active/total contact counters, and creation timestamps.
Parámetros de entrada
group_idintegerObligatorioGroup identifier. Can be found using the endpoint 'Get account's groups' or in the UI.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Group Contents by IDACTIVE_TRAIL_GET_GROUP_CONTENTS_BY_IDAcciónTool to retrieve all group members by group ID with pagination and filtering. Use when you need to get complete information about contacts in a specific group. Returns up to 100 contacts per page with optional filtering by status and date range.
ACTIVE_TRAIL_GET_GROUP_CONTENTS_BY_IDAcciónTool to retrieve all group members by group ID with pagination and filtering. Use when you need to get complete information about contacts in a specific group. Returns up to 100 contacts per page with optional filtering by status and date range.
Parámetros de entrada
pageintegerPage number for pagination. Range: 1-2147483647. Default: 0.
limitintegerNumber of results per page. Range: 1-100. Default: 100. Maximum limit is 100.
to_datestringdateEnd date for state change filtering. ISO 8601 date format. Defaults to current date if not provided.
group_idintegerObligatorioThe group identifier. Can be found using the 'Get All Groups' endpoint or in the UI.
from_datestringdateStart date for state change filtering. ISO 8601 date format. Defaults to 3 months prior to current date if not provided.
search_termstringSearch filter for members by email or SMS. Note: plus signs not supported.
customer_statesstringFilter by contact status. Possible values include: active, unsubscribed, bounced, blocked, etc. Comma-separated for multiple statuses.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Group Information for ContactACTIVE_TRAIL_GET_GROUP_INFORMATION_FOR_CONTACTAcciónTool to retrieve all groups that a specific contact belongs to by contact ID. Use when you need to view which groups a contact is associated with.
ACTIVE_TRAIL_GET_GROUP_INFORMATION_FOR_CONTACTAcciónTool to retrieve all groups that a specific contact belongs to by contact ID. Use when you need to view which groups a contact is associated with.
Parámetros de entrada
contact_idintegerObligatorioThe unique identifier of the contact whose group information is being retrieved. Can be found using the endpoint 'Get account's contacts list'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Group EventsACTIVE_TRAIL_GET_GROUPS_EVENTSAcciónTool to retrieve all events for a specific group with optional filtering by event type, event date, and subscriber creation date. Use when you need to analyze group engagement metrics like opens, clicks, and unsubscribes. Default date range is 3 months back if not specified.
ACTIVE_TRAIL_GET_GROUPS_EVENTSAcciónTool to retrieve all events for a specific group with optional filtering by event type, event date, and subscriber creation date. Use when you need to analyze group engagement metrics like opens, clicks, and unsubscribes. Default date range is 3 months back if not specified.
Parámetros de entrada
idintegerObligatorioGroup identifier. Can be found using the endpoint 'Get account's groups' or in the UI.
event_typestringFilter by event type (e.g., opens, clicks, unsubscribes, etc.). If not provided, returns all event types.
event_to_datestringFilter by event occurrence end date. Format: YYYY-MM-DD.
created_to_datestringFilter by subscriber creation end date. Format: YYYY-MM-DD.
event_from_datestringFilter by event occurrence start date. Format: YYYY-MM-DD. Default is 3 months back if not specified.
created_from_datestringFilter by subscriber creation start date. Format: YYYY-MM-DD. Default is 3 months back if not specified.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Landing PagesACTIVE_TRAIL_GET_LANDING_PAGESAcciónTool to retrieve landing pages from the ActiveTrail account with pagination support. Use when you need to get all landing pages or fetch paginated results.
ACTIVE_TRAIL_GET_LANDING_PAGESAcciónTool to retrieve landing pages from the ActiveTrail account with pagination support. Use when you need to get all landing pages or fetch paginated results.
Parámetros de entrada
pageintegerPage number for pagination. Range: 1-2147483647. Use this to navigate through multiple pages of results.
limitintegerMaximum number of landing pages to return per page. Range: 1-100. Default: 20.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Mailing ListACTIVE_TRAIL_GET_MAILING_LISTAcciónTool to retrieve detailed information about a specific mailing list by its unique identifier. Use when you need to fetch details of a single mailing list including name, description, and member counts.
ACTIVE_TRAIL_GET_MAILING_LISTAcciónTool to retrieve detailed information about a specific mailing list by its unique identifier. Use when you need to fetch details of a single mailing list including name, description, and member counts.
Parámetros de entrada
idstringObligatorioMailing list identifier. The unique ID of the mailing list to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Mailing List MembersACTIVE_TRAIL_GET_MAILING_LIST_MEMBERSAcciónTool to retrieve all members belonging to a specific mailing list. Use when you need to get contacts from a mailing list, with optional filtering by contact status and state change date range.
ACTIVE_TRAIL_GET_MAILING_LIST_MEMBERSAcciónTool to retrieve all members belonging to a specific mailing list. Use when you need to get contacts from a mailing list, with optional filtering by contact status and state change date range.
Parámetros de entrada
idstringObligatorioMailing list identifier - the ID of the mailing list to retrieve members from
pageintegerPage number for pagination. Use this to navigate through multiple pages of results
limitintegerMaximum number of results per page
to_datestringdateEnd date for filtering by state change. Defaults to current date if not provided. Format: YYYY-MM-DD
from_datestringdateStart date for filtering by state change. Defaults to three months back if not provided. Format: YYYY-MM-DD
customer_statesstringFilter results by contact status. Comma-separated values for multiple statuses (active, unsubscribed, bounced, blocked, etc.)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Mailing ListsACTIVE_TRAIL_GET_MAILING_LISTSAcciónTool to retrieve all mailing lists from the ActiveTrail account. Use when you need to get the list of mailing lists associated with the account.
ACTIVE_TRAIL_GET_MAILING_LISTSAcciónTool to retrieve all mailing lists from the ActiveTrail account. Use when you need to get the list of mailing lists associated with the account.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get OrderACTIVE_TRAIL_GET_ORDERAcciónTool to retrieve complete details of a specific order from ActiveTrail commerce system. Use when you need to fetch order information including customer details, financial data, products, and shipping information.
ACTIVE_TRAIL_GET_ORDERAcciónTool to retrieve complete details of a specific order from ActiveTrail commerce system. Use when you need to fetch order information including customer details, financial data, products, and shipping information.
Parámetros de entrada
order_idstringObligatorioUnique identifier for the order to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Push Campaign OpensACTIVE_TRAIL_GET_PUSH_CAMPAIGN_OPENSAcciónTool to retrieve contacts who opened a specific push notification campaign. Use when you need to track which recipients opened your push campaign. The campaign must have been sent within the specified date range (defaults to last 3 months).
ACTIVE_TRAIL_GET_PUSH_CAMPAIGN_OPENSAcciónTool to retrieve contacts who opened a specific push notification campaign. Use when you need to track which recipients opened your push campaign. The campaign must have been sent within the specified date range (defaults to last 3 months).
Parámetros de entrada
idstringObligatorioThe unique identifier of the push campaign to retrieve opens for.
pageintegerPage number for pagination. Use this to navigate through multiple pages of results.
limitintegerNumber of records to return per page. Controls the size of each page in paginated results.
to_datestringEnd date for filtering results. Default: current date. Format: Date string (YYYY-MM-DD).
from_datestringStart date for filtering results. Default: 3 months prior to current date. Format: Date string (YYYY-MM-DD).
send_typestringFilter by send type (immediate, scheduled, etc.).
search_termstringSearch term to filter results by contact details or other searchable fields.
Parámetros de salida
dataobject[]List of contacts who opened the push campaign
pageintegerCurrent page number in the paginated results
errorstringError if any occurred during the execution of the action
limitintegerNumber of records per page
totalintegerTotal number of push notification opens records across all pages
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Push Campaign Delivered ReportACTIVE_TRAIL_GET_PUSH_CAMPAIGN_REPORT_DELIVEREDAcciónTool to retrieve contacts who successfully received a specific push notification campaign. Use when you need to identify which recipients had the push campaign delivered to their devices. The campaign must have been sent within the specified date range (defaults to last 3 months); if not sent during these dates, an empty list is returned.
ACTIVE_TRAIL_GET_PUSH_CAMPAIGN_REPORT_DELIVEREDAcciónTool to retrieve contacts who successfully received a specific push notification campaign. Use when you need to identify which recipients had the push campaign delivered to their devices. The campaign must have been sent within the specified date range (defaults to last 3 months); if not sent during these dates, an empty list is returned.
Parámetros de entrada
idstringObligatorioThe unique identifier of the push campaign to retrieve delivered contacts for.
pageintegerPage number for pagination. Use this to navigate through multiple pages of results.
limitintegerNumber of records to return per page. Controls the size of each page in paginated results.
to_datestringEnd date for filtering results. Default: current date. Format: Date string (YYYY-MM-DD).
from_datestringStart date for filtering results. Default: 3 months prior to current date. Format: Date string (YYYY-MM-DD).
send_typestringFilter by send type (immediate, scheduled, etc.).
search_termstringSearch term to filter results by contact details or other searchable fields.
Parámetros de salida
dataobject[]List of contacts to whom the push campaign was successfully delivered
pageintegerCurrent page number in the paginated results
errorstringError if any occurred during the execution of the action
limitintegerNumber of records per page
totalintegerTotal number of delivered push notification records across all pages
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Push Campaign Failed Delivery ReportACTIVE_TRAIL_GET_PUSH_CAMPAIGN_REPORT_FAILEDAcciónTool to retrieve the failed delivery report for a specific push campaign. Use when you need to see which contacts experienced delivery failures and why. The campaign must be sent in the specified date range (defaults to last 3 months).
ACTIVE_TRAIL_GET_PUSH_CAMPAIGN_REPORT_FAILEDAcciónTool to retrieve the failed delivery report for a specific push campaign. Use when you need to see which contacts experienced delivery failures and why. The campaign must be sent in the specified date range (defaults to last 3 months).
Parámetros de entrada
idstringObligatorioThe unique identifier of the push campaign to retrieve failed delivery report for.
pageintegerPage number for pagination. Use this to navigate through multiple pages of failed delivery results.
limitintegerNumber of failed delivery records to return per page. Controls the size of each page in paginated results.
to_datestringEnd date for filtering failed deliveries. Format: YYYY-MM-DD or datetime string. Default: current date.
from_datestringStart date for filtering failed deliveries. Format: YYYY-MM-DD or datetime string. Default: 3 months prior to current date.
send_typestringFilter by send type (e.g., immediate, scheduled). Use to narrow down results by how the campaign was sent.
search_termstringSearch term to filter contact results by name, email, or other searchable contact fields.
Parámetros de salida
dataobject[]List of contacts for whom the push notification delivery failed
pageintegerCurrent page number in the paginated results
errorstringError if any occurred during the execution of the action
limitintegerNumber of records per page
totalintegerTotal number of failed delivery records across all pages
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Push Campaign ReportsACTIVE_TRAIL_GET_PUSH_CAMPAIGN_REPORTSAcciónTool to retrieve push notification campaign performance metrics and reports. Use when you need to access push campaign analytics including sent, delivered, opened, clicked, and engagement statistics. Returns the last 20 campaigns from the last 3 months by default when no date range is specified.
ACTIVE_TRAIL_GET_PUSH_CAMPAIGN_REPORTSAcciónTool to retrieve push notification campaign performance metrics and reports. Use when you need to access push campaign analytics including sent, delivered, opened, clicked, and engagement statistics. Returns the last 20 campaigns from the last 3 months by default when no date range is specified.
Parámetros de entrada
pageintegerPage number for pagination of results. Default: 1
limitintegerNumber of results per page. Default: 20
to_datestringEnd date for filtering campaigns. Default: current date. Format: Date string (e.g., YYYY-MM-DD)
from_datestringStart date for filtering campaigns. Default: 3 months prior to current date. Format: Date string (e.g., YYYY-MM-DD)
send_typestringFilter reports by send type
search_termstringSearch term to filter campaign results by campaign name or other searchable fields
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Push Campaign Sent ReportACTIVE_TRAIL_GET_PUSH_CAMPAIGN_REPORT_SENTAcciónTool to retrieve contacts who were sent a specific push notification campaign. Use when you need to see the complete list of recipients for a push campaign. The campaign must be sent in the time range specified using from_date and to_date (defaults to last 3 months).
ACTIVE_TRAIL_GET_PUSH_CAMPAIGN_REPORT_SENTAcciónTool to retrieve contacts who were sent a specific push notification campaign. Use when you need to see the complete list of recipients for a push campaign. The campaign must be sent in the time range specified using from_date and to_date (defaults to last 3 months).
Parámetros de entrada
idstringObligatorioThe unique identifier of the push campaign to retrieve sent contacts for.
pageintegerPage number for pagination. Use this to navigate through multiple pages of sent report results.
limitintegerNumber of records to return per page. Controls the size of each page in paginated results.
to_datestringEnd date for filtering sent report. Format: YYYY-MM-DD or datetime string. Default: current date.
from_datestringStart date for filtering sent report. Format: YYYY-MM-DD or datetime string. Default: 3 months prior to current date.
send_typestringFilter by send type (e.g., immediate, scheduled). Use to narrow down results by how the campaign was sent.
search_termstringSearch term to filter contact results by name, email, or other searchable contact fields.
Parámetros de salida
dataobject[]List of contacts to whom the push campaign was sent
pageintegerCurrent page number in the paginated results
errorstringError if any occurred during the execution of the action
limitintegerNumber of records per page
totalintegerTotal number of sent records across all pages
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Push Campaign Report SummaryACTIVE_TRAIL_GET_PUSH_CAMPAIGN_REPORT_SUMMARYAcciónTool to retrieve summary report information of Push campaigns by dates. Use when you need aggregated performance metrics for push notification campaigns including sent, delivered, opened, clicked, and engagement statistics. Default behavior: Returns campaigns from the last 3 months when date parameters are not specified.
ACTIVE_TRAIL_GET_PUSH_CAMPAIGN_REPORT_SUMMARYAcciónTool to retrieve summary report information of Push campaigns by dates. Use when you need aggregated performance metrics for push notification campaigns including sent, delivered, opened, clicked, and engagement statistics. Default behavior: Returns campaigns from the last 3 months when date parameters are not specified.
Parámetros de entrada
pageintegerPage number for pagination. Use this to navigate through multiple pages of results.
limitintegerNumber of records to return per page. Controls the size of each page in paginated results.
to_datestringEnd date for filtering campaigns. Default: current date. Format: Date string (YYYY-MM-DD).
from_datestringStart date for filtering campaigns. Default: 3 months prior to current date. Format: Date string (YYYY-MM-DD).
send_typestringFilter by send type (immediate, scheduled, etc.).
search_termstringSearch term to filter campaign results by campaign name or other searchable fields.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Push CampaignsACTIVE_TRAIL_GET_PUSH_CAMPAIGNSAcciónTool to retrieve push notification campaigns with optional filtering by date, campaign ID, and search criteria. Use when you need to get push campaigns filtered by date range (default is last 6 months and last 20 campaigns), or filtered by specific campaign ID or search term.
ACTIVE_TRAIL_GET_PUSH_CAMPAIGNSAcciónTool to retrieve push notification campaigns with optional filtering by date, campaign ID, and search criteria. Use when you need to get push campaigns filtered by date range (default is last 6 months and last 20 campaigns), or filtered by specific campaign ID or search term.
Parámetros de entrada
to_datestringEnd date for filtering campaign results in ISO format (YYYY-MM-DD). Default is current date if not specified
from_datestringStart date for filtering campaign results in ISO format (YYYY-MM-DD). Default is 6 months back if not specified
page_sizeintegerNumber of results per page
campaign_idstringFilter results by specific campaign identifier
filter_typestringType of filter to apply to campaign results
page_numberintegerPage number for pagination
search_termstringSearch term to filter campaigns by name or content
include_deletedbooleanWhether to include deleted campaigns in results
include_not_sentbooleanWhether to include unsent campaigns in results
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Segmentation Rule Field TypesACTIVE_TRAIL_GET_SEGMENTATION_RULE_FIELD_TYPESAcciónTool to retrieve dictionary of rule field types for segmentation. Use when you need to get available field types for building segmentation rules.
ACTIVE_TRAIL_GET_SEGMENTATION_RULE_FIELD_TYPESAcciónTool to retrieve dictionary of rule field types for segmentation. Use when you need to get available field types for building segmentation rules.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Segmentation Rule OperationsACTIVE_TRAIL_GET_SEGMENTATION_RULE_OPERATIONSAcciónTool to retrieve dictionary of rule operations for segmentation. Use when you need to get available operations for building segmentation rules.
ACTIVE_TRAIL_GET_SEGMENTATION_RULE_OPERATIONSAcciónTool to retrieve dictionary of rule operations for segmentation. Use when you need to get available operations for building segmentation rules.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Segmentation Rule TypesACTIVE_TRAIL_GET_SEGMENTATION_RULE_TYPESAcciónTool to retrieve dictionary of segmentation rule types for automation. Use when you need to get available rule types for building automation segmentations.
ACTIVE_TRAIL_GET_SEGMENTATION_RULE_TYPESAcciónTool to retrieve dictionary of segmentation rule types for automation. Use when you need to get available rule types for building automation segmentations.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SegmentationsACTIVE_TRAIL_GET_SEGMENTATIONSAcciónTool to retrieve all segmentations from the ActiveTrail account. Use when you need to get the list of segmentation configurations associated with the authenticated user's account.
ACTIVE_TRAIL_GET_SEGMENTATIONSAcciónTool to retrieve all segmentations from the ActiveTrail account. Use when you need to get the list of segmentation configurations associated with the authenticated user's account.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Sending ProfilesACTIVE_TRAIL_GET_SENDING_PROFILESAcciónTool to retrieve account email sending profiles. Use when you need to get sending profile configurations including sender names, email addresses, and reply-to settings.
ACTIVE_TRAIL_GET_SENDING_PROFILESAcciónTool to retrieve account email sending profiles. Use when you need to get sending profile configurations including sender names, email addresses, and reply-to settings.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobject[]ObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Signup FormACTIVE_TRAIL_GET_SIGNUP_FORMAcciónTool to retrieve detailed information about a specific signup form by its unique identifier. Use when you need to fetch details of a single signup form.
ACTIVE_TRAIL_GET_SIGNUP_FORMAcciónTool to retrieve detailed information about a specific signup form by its unique identifier. Use when you need to fetch details of a single signup form.
Parámetros de entrada
idstringObligatorioSignup form identifier. The unique ID of the signup form to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Signup FormsACTIVE_TRAIL_GET_SIGNUP_FORMSAcciónTool to retrieve all signup forms from the ActiveTrail account. Use when you need to get the list of signup forms associated with the account.
ACTIVE_TRAIL_GET_SIGNUP_FORMSAcciónTool to retrieve all signup forms from the ActiveTrail account. Use when you need to get the list of signup forms associated with the account.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Smart Code SitesACTIVE_TRAIL_GET_SMART_CODE_SITESAcciónTool to retrieve all Smart Code sites from the ActiveTrail account. Use when you need to get the list of Smart Code sites.
ACTIVE_TRAIL_GET_SMART_CODE_SITESAcciónTool to retrieve all Smart Code sites from the ActiveTrail account. Use when you need to get the list of Smart Code sites.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SMS Campaign by IDACTIVE_TRAIL_GET_SMS_CAMPAIGNAcciónTool to retrieve detailed information about a specific SMS campaign by its unique identifier. Use when you need to fetch campaign details including message content, sender, status, and delivery metrics.
ACTIVE_TRAIL_GET_SMS_CAMPAIGNAcciónTool to retrieve detailed information about a specific SMS campaign by its unique identifier. Use when you need to fetch campaign details including message content, sender, status, and delivery metrics.
Parámetros de entrada
idintegerObligatorioSMS campaign identifier. Can be found using the endpoint 'Get account's SMS campaigns' or in the UI.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SMS Campaign ClickersACTIVE_TRAIL_GET_SMS_CAMPAIGN_CLICKERSAcciónTool to access link click data for SMS campaigns. Use when you need to retrieve contacts who clicked links in a specific SMS campaign with optional filtering by link, date range, or search terms. Default search window is 3 months; manually-added numbers may return click counts without mobile numbers.
ACTIVE_TRAIL_GET_SMS_CAMPAIGN_CLICKERSAcciónTool to access link click data for SMS campaigns. Use when you need to retrieve contacts who clicked links in a specific SMS campaign with optional filtering by link, date range, or search terms. Default search window is 3 months; manually-added numbers may return click counts without mobile numbers.
Parámetros de entrada
idstringObligatorioCampaign identifier for which to retrieve clickers data.
pageintegerPage number for pagination. Use this to navigate through multiple pages of results.
limitintegerResults per page limit. Controls the number of records returned per page.
link_idstringFilter results by specific link identifier.
to_datestringEnd date for filtering campaign data. Format: YYYY-MM-DD.
from_datestringStart date for filtering campaign data. Format: YYYY-MM-DD. Default search window is 3 months.
send_typestringFilter by send type classification (e.g., immediate, scheduled).
search_termstringSearch filter for results.
rows_affectedintegerPagination parameter for row count.
previous_row_countintegerPagination parameter for previous results.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SMS Campaign Delivered ReportACTIVE_TRAIL_GET_SMS_CAMPAIGN_DELIVEREDAcciónTool to retrieve delivery confirmations for a specific SMS campaign. Use when you need to see which contacts successfully received the SMS message. The campaign must be sent in the specified date range (defaults to last 3 months). Note: If SMS was sent using manual number entry instead of a group, only the delivery count is returned without specific mobile numbers.
ACTIVE_TRAIL_GET_SMS_CAMPAIGN_DELIVEREDAcciónTool to retrieve delivery confirmations for a specific SMS campaign. Use when you need to see which contacts successfully received the SMS message. The campaign must be sent in the specified date range (defaults to last 3 months). Note: If SMS was sent using manual number entry instead of a group, only the delivery count is returned without specific mobile numbers.
Parámetros de entrada
idstringObligatorioThe unique identifier of the SMS campaign to retrieve delivered contacts for.
pageintegerPage number for pagination. Use this to navigate through multiple pages of delivered contact results.
limitintegerNumber of delivered contact records to return per page. Controls the size of each page in paginated results.
to_datestringEnd date for filtering delivered SMS. Format: YYYY-MM-DD or datetime string. Default: current date.
from_datestringStart date for filtering delivered SMS. Format: YYYY-MM-DD or datetime string. Default: 3 months prior to current date.
send_typestringFilter by send type (e.g., immediate, scheduled). Use to narrow down results by how the campaign was sent.
search_termstringSearch term to filter contact results by name, phone number, or other searchable contact fields.
Parámetros de salida
dataobject[]List of contacts who successfully received the SMS. May be empty if campaign was sent using manual number entry.
pageintegerCurrent page number in the paginated results
errorstringError if any occurred during the execution of the action
limitintegerNumber of records per page
totalintegerTotal number of delivered SMS records across all pages. Note: If SMS was sent manually (not to a group), only the count is returned without mobile numbers.
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SMS Operational Message by IDACTIVE_TRAIL_GET_SMS_CAMPAIGN_OPERATIONAL_MESSAGEAcciónTool to retrieve operational SMS message details by unique identifier. Use when you need to fetch SMS campaign information including sender name, profile, and message content.
ACTIVE_TRAIL_GET_SMS_CAMPAIGN_OPERATIONAL_MESSAGEAcciónTool to retrieve operational SMS message details by unique identifier. Use when you need to fetch SMS campaign information including sender name, profile, and message content.
Parámetros de entrada
idintegerObligatorioOperational SMS id. Can be found in the UI (go to Mobile -> SMS -> SMS list -> filter table by 'Transactional SMS' -> inspect/F12)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SMS Campaign Report ClicksACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORT_CLICKSAcciónTool to retrieve SMS clicks (on links) reports for a specific campaign. Use when you need detailed information about link clicks from SMS campaigns, including contact details, timestamps, and device information.
ACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORT_CLICKSAcciónTool to retrieve SMS clicks (on links) reports for a specific campaign. Use when you need detailed information about link clicks from SMS campaigns, including contact details, timestamps, and device information.
Parámetros de entrada
idstringObligatorioThe SMS campaign report identifier for which to retrieve click data on links.
pageintegerPage number for pagination. Use this to navigate through multiple pages of results.
limitintegerNumber of records to return per page. Controls the size of each page in paginated results.
to_datestringEnd date for filtering click reports. Format: YYYY-MM-DD.
from_datestringStart date for filtering click reports. Format: YYYY-MM-DD.
send_typestringFilter by send type (immediate, scheduled, etc.).
search_termstringSearch criteria for filtering click results.
rows_affectedintegerNumber of rows affected in the result set.
previous_row_countintegerPrevious row count for pagination purposes.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SMS Campaign Failed Delivery ReportACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORT_FAILEDAcciónTool to retrieve the failed delivery report for a specific SMS campaign. Use when you need to see which contacts experienced delivery failures and why. The campaign must be sent in the specified date range (defaults to last 3 months). Note: If SMS was sent using manual number entry instead of a group, only the failure count is returned without specific mobile numbers.
ACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORT_FAILEDAcciónTool to retrieve the failed delivery report for a specific SMS campaign. Use when you need to see which contacts experienced delivery failures and why. The campaign must be sent in the specified date range (defaults to last 3 months). Note: If SMS was sent using manual number entry instead of a group, only the failure count is returned without specific mobile numbers.
Parámetros de entrada
idstringObligatorioThe unique identifier of the SMS campaign to retrieve failed delivery report for.
pageintegerPage number for pagination. Use this to navigate through multiple pages of failed delivery results.
limitintegerNumber of failed delivery records to return per page. Controls the size of each page in paginated results.
to_datestringEnd date for filtering failed deliveries. Format: YYYY-MM-DD or datetime string. Default: current date.
from_datestringStart date for filtering failed deliveries. Format: YYYY-MM-DD or datetime string. Default: 3 months prior to current date.
send_typestringFilter by send type (e.g., immediate, scheduled). Use to narrow down results by how the campaign was sent.
search_termstringSearch term to filter contact results by name, phone number, or other searchable contact fields.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SMS Campaign ReportsACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORTSAcciónTool to retrieve SMS campaign performance metrics and reports with filtering options. Use when you need to access SMS campaign analytics including sent, delivered, failed, clicks, and engagement statistics. Returns the last 20 campaigns from the last 6 months by default when no date range or filters are specified.
ACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORTSAcciónTool to retrieve SMS campaign performance metrics and reports with filtering options. Use when you need to access SMS campaign analytics including sent, delivered, failed, clicks, and engagement statistics. Returns the last 20 campaigns from the last 6 months by default when no date range or filters are specified.
Parámetros de entrada
pageintegerPage number for pagination of results. Default: 1
limitintegerNumber of results per page. Default: 20
to_datestringEnd date for filtering campaigns (ISO 8601 format). Default: current date
from_datestringStart date for filtering campaigns (ISO 8601 format). Default: 3 months prior to current date
send_typestringFilter campaigns by send type (e.g., transactional messages, test messages, or all campaigns excluding transactional)
search_termstringSearch term to filter campaign results by campaign name or other searchable fields
rows_affectedintegerNumber of rows affected in the query
previous_row_countintegerCount from previous request for pagination tracking
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SMS Campaign Sent Contacts ReportACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORT_SENTAcciónTool to retrieve all contacts that an SMS campaign was sent to. Use when you need to see the list of recipients for a specific SMS campaign. The campaign must be sent in the specified date range (defaults to last 3 months). Note: If SMS was sent using manual number entry instead of a group, only the contact count is returned without specific mobile numbers.
ACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORT_SENTAcciónTool to retrieve all contacts that an SMS campaign was sent to. Use when you need to see the list of recipients for a specific SMS campaign. The campaign must be sent in the specified date range (defaults to last 3 months). Note: If SMS was sent using manual number entry instead of a group, only the contact count is returned without specific mobile numbers.
Parámetros de entrada
idstringObligatorioThe unique identifier of the SMS campaign to retrieve sent contacts report for.
pageintegerPage number for pagination. Use this to navigate through multiple pages of sent contact results.
limitintegerNumber of sent contact records to return per page. Controls the size of each page in paginated results.
to_datestringEnd date for filtering sent contacts. Format: YYYY-MM-DD or datetime string. Default: current date.
from_datestringStart date for filtering sent contacts. Format: YYYY-MM-DD or datetime string. Default: 3 months prior to current date.
send_typestringFilter by send type (e.g., immediate, scheduled). Use to narrow down results by how the campaign was sent.
search_termstringSearch term to filter contact results by name, phone number, or other searchable contact fields.
rows_affectedintegerNumber of rows affected. Use when tracking batch operations or modifications.
previous_row_countintegerPrevious row count value. Use when tracking changes or pagination state.
Parámetros de salida
dataobject[]List of contacts who received the SMS. May be empty if campaign was sent using manual number entry.
pageintegerCurrent page number in the paginated results
errorstringError if any occurred during the execution of the action
limitintegerNumber of records per page
totalintegerTotal number of contacts the SMS was sent to across all pages. Note: If SMS was sent manually (not to a group), only the count is returned without mobile numbers.
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SMS Campaign Report SummaryACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORT_SUMMARYAcciónTool to retrieve summary report information of SMS campaigns by dates. Use when you need aggregated performance metrics for SMS campaigns including sent, delivered, failed, credits consumed, unsubscribe, and click statistics. Default behavior: Returns the last 20 campaigns from the last 3 months when date parameters are not specified.
ACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORT_SUMMARYAcciónTool to retrieve summary report information of SMS campaigns by dates. Use when you need aggregated performance metrics for SMS campaigns including sent, delivered, failed, credits consumed, unsubscribe, and click statistics. Default behavior: Returns the last 20 campaigns from the last 3 months when date parameters are not specified.
Parámetros de entrada
pageintegerPage number for pagination. Use this to navigate through multiple pages of results.
limitintegerNumber of records to return per page. Controls the size of each page in paginated results.
to_datestringEnd date for filtering campaigns. Default: current date. Format: Date string (YYYY-MM-DD).
from_datestringStart date for filtering campaigns. Default: 3 months prior to current date. Format: Date string (YYYY-MM-DD).
send_typestringFilter by send type (immediate, scheduled, etc.).
search_termstringSearch term to filter campaign results by campaign name or other searchable fields.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SMS Campaign Unsubscribed ContactsACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORT_UNSUBSCRIBEDAcciónTool to retrieve contacts who unsubscribed from a specific SMS campaign. Use when you need to identify recipients who opted out of receiving future SMS messages. Note: For manually added numbers, only the count is returned, not individual phone numbers. Default search range is last 3 months; if campaign wasn't sent in the given range, no information will be returned.
ACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORT_UNSUBSCRIBEDAcciónTool to retrieve contacts who unsubscribed from a specific SMS campaign. Use when you need to identify recipients who opted out of receiving future SMS messages. Note: For manually added numbers, only the count is returned, not individual phone numbers. Default search range is last 3 months; if campaign wasn't sent in the given range, no information will be returned.
Parámetros de entrada
idstringObligatorioThe SMS campaign identifier for which to retrieve unsubscribe data. Can be found via the 'Get account's sms campaigns' endpoint or in the UI.
pageintegerPage number for pagination. Use this to navigate through multiple pages of results.
limitintegerNumber of records to return per page. Controls the size of each page in paginated results.
to_datestringEnd date for filtering unsubscribe reports. Format: YYYY-MM-DD. Defaults to current date if not specified.
from_datestringStart date for filtering unsubscribe reports. Format: YYYY-MM-DD. Defaults to 3 months prior if not specified.
send_typestringFilter by send type (immediate, scheduled, etc.).
search_termstringSearch criteria for filtering unsubscribe results.
rows_affectedintegerNumber of rows affected in the result set.
previous_row_countintegerPrevious row count for pagination purposes.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SMS Sending ProfilesACTIVE_TRAIL_GET_SMS_SENDING_PROFILESAcciónTool to retrieve SMS sending profiles configured for the account. Use when you need to get SMS sender profile configurations including sender names and phone numbers.
ACTIVE_TRAIL_GET_SMS_SENDING_PROFILESAcciónTool to retrieve SMS sending profiles configured for the account. Use when you need to get SMS sender profile configurations including sender names and phone numbers.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobject[]ObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get TemplateACTIVE_TRAIL_GET_TEMPLATEAcciónTool to retrieve detailed information about a specific template from the account's saved templates. Use when you need to fetch template details including name, subject, content, category, and encoding settings.
ACTIVE_TRAIL_GET_TEMPLATEAcciónTool to retrieve detailed information about a specific template from the account's saved templates. Use when you need to fetch template details including name, subject, content, category, and encoding settings.
Parámetros de entrada
idintegerObligatorioTemplate identifier. Can be found using 'Get account's my templates' endpoint or in the UI URL.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Template ContentACTIVE_TRAIL_GET_TEMPLATE_CONTENTAcciónTool to retrieve HTML content of a specific template. Use when you need to get the HTML markup or design content of a template by its ID.
ACTIVE_TRAIL_GET_TEMPLATE_CONTENTAcciónTool to retrieve HTML content of a specific template. Use when you need to get the HTML markup or design content of a template by its ID.
Parámetros de entrada
idstringObligatorioThe unique identifier of the template. Can be found using 'Get Templates' endpoint or in the UI.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get TemplatesACTIVE_TRAIL_GET_TEMPLATESAcciónTool to retrieve saved templates from the ActiveTrail account. Use when you need to list all templates or search for templates by name. Supports pagination and filtering.
ACTIVE_TRAIL_GET_TEMPLATESAcciónTool to retrieve saved templates from the ActiveTrail account. Use when you need to list all templates or search for templates by name. Supports pagination and filtering.
Parámetros de entrada
pageintegerPage number for pagination. Range: 1-2147483647. Use this to navigate through multiple pages of results.
limitintegerMaximum number of templates to return per page. Range: 1-100. Controls the number of results returned in each request.
search_termstringSearch term for filtering templates by name. Used to find specific templates.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Template CategoriesACTIVE_TRAIL_GET_TEMPLATES_TEMPLATE_CATEGORYAcciónTool to retrieve all template categories from 'my templates' section. Use when you need to get the list of categories for organizing email templates.
ACTIVE_TRAIL_GET_TEMPLATES_TEMPLATE_CATEGORYAcciónTool to retrieve all template categories from 'my templates' section. Use when you need to get the list of categories for organizing email templates.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectData wrapper containing template category details.
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
successfullbooleanWhether the request was successful
Get Transactional Messages ClassificationACTIVE_TRAIL_GET_TRANSACTIONAL_MESSAGES_CLASSIFICATIONAcciónTool to retrieve all classification options for operational/transactional messages. Use when you need to get available classifications for categorizing and filtering transactional message reports.
ACTIVE_TRAIL_GET_TRANSACTIONAL_MESSAGES_CLASSIFICATIONAcciónTool to retrieve all classification options for operational/transactional messages. Use when you need to get available classifications for categorizing and filtering transactional message reports.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobject[]ObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Transactional SMS MessageACTIVE_TRAIL_GET_TRANSACTIONAL_SMS_MESSAGEAcciónTool to retrieve detailed information about a specific transactional SMS message by its unique identifier. Use when you need to fetch SMS message content, delivery statistics, and metadata for operational SMS messages.
ACTIVE_TRAIL_GET_TRANSACTIONAL_SMS_MESSAGEAcciónTool to retrieve detailed information about a specific transactional SMS message by its unique identifier. Use when you need to fetch SMS message content, delivery statistics, and metadata for operational SMS messages.
Parámetros de entrada
transactional_sms_idintegerObligatorioTransactional SMS message identifier. The unique ID of the operational SMS message to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Two-Way SMS RepliesACTIVE_TRAIL_GET_TWO_WAY_SMS_REPLIESAcciónTool to retrieve virtual number SMS replies with filtering options. Use when you need to fetch two-way SMS responses for campaigns with optional filtering by search term, campaign ID, or date range.
ACTIVE_TRAIL_GET_TWO_WAY_SMS_REPLIESAcciónTool to retrieve virtual number SMS replies with filtering options. Use when you need to fetch two-way SMS responses for campaigns with optional filtering by search term, campaign ID, or date range.
Parámetros de entrada
pageintegerPage number for pagination (range: 1-2147483647)
limitintegerNumber of results per page (range: 1-100). Default is 20
to_datestringdateEnd date for filtering replies. Defaults to 3 months after FromDate if not provided
from_datestringdateStart date for filtering replies. Defaults to 3 months before ToDate if not provided
campaign_idintegerSMS campaign ID. Can be found using the endpoint 'Get account's sms campaigns'
search_termstringSearch filter for responses
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Automation Update ActionsACTIVE_TRAIL_GET_UPDATE_ACTIONSAcciónTool to retrieve all types of actions that can update a contact in an automation. Use when you need to discover available update actions for automation workflows in ActiveTrail.
ACTIVE_TRAIL_GET_UPDATE_ACTIONSAcciónTool to retrieve all types of actions that can update a contact in an automation. Use when you need to discover available update actions for automation workflows in ActiveTrail.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get User Bounces by Campaign IDACTIVE_TRAIL_GET_USER_BOUNCES_BY_CAMPAIGN_IDAcciónTool to retrieve specific user details of users that got a bounce by Campaign ID, filtered by bounce type. Use when you need to identify which email addresses bounced and distinguish between soft bounces (temporary failures like mailbox full) and hard bounces (permanent failures like invalid addresses). Hard bounce addresses will be excluded from future sends.
ACTIVE_TRAIL_GET_USER_BOUNCES_BY_CAMPAIGN_IDAcciónTool to retrieve specific user details of users that got a bounce by Campaign ID, filtered by bounce type. Use when you need to identify which email addresses bounced and distinguish between soft bounces (temporary failures like mailbox full) and hard bounces (permanent failures like invalid addresses). Hard bounce addresses will be excluded from future sends.
Parámetros de entrada
bounce_typestringObligatorioenumFilter by bounce category. 'soft' for temporary failures (e.g., mailbox full) or 'hard' for permanent failures (e.g., invalid email address).
softhardcampaign_idintegerObligatorioCampaign identifier. Can be found using the endpoint 'Get account's email campaigns'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get User Social AccountsACTIVE_TRAIL_GET_USER_SOCIAL_ACCOUNTS_GETAcciónTool to retrieve social media accounts connected to the ActiveTrail account. Use when you need to view connected social platforms.
ACTIVE_TRAIL_GET_USER_SOCIAL_ACCOUNTS_GETAcciónTool to retrieve social media accounts connected to the ActiveTrail account. Use when you need to view connected social platforms.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Webhook by IDACTIVE_TRAIL_GET_WEBHOOKAcciónTool to retrieve detailed information about a specific webhook by its unique identifier. Use when you need to fetch complete webhook configuration including event type, target URL, state, and associated parameters.
ACTIVE_TRAIL_GET_WEBHOOKAcciónTool to retrieve detailed information about a specific webhook by its unique identifier. Use when you need to fetch complete webhook configuration including event type, target URL, state, and associated parameters.
Parámetros de entrada
webhook_idintegerObligatorioThe unique identifier of the webhook to retrieve. Can be found using the 'Get Webhooks' endpoint or in the UI.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get WebhooksACTIVE_TRAIL_GET_WEBHOOKSAcciónTool to list account webhooks with optional filtering. Use when you need to retrieve webhooks configured for the ActiveTrail account with filtering by event type, state, or target type.
ACTIVE_TRAIL_GET_WEBHOOKSAcciónTool to list account webhooks with optional filtering. Use when you need to retrieve webhooks configured for the ActiveTrail account with filtering by event type, state, or target type.
Parámetros de entrada
event_typestringFilter webhooks by event type. Used to retrieve only webhooks configured for specific events.
state_typestringFilter webhooks by state type. Used to retrieve webhooks based on their operational status.
target_typestringFilter webhooks by target type. Used to retrieve webhooks based on their target configuration.
is_ignore_parametersbooleanOption to ignore parameters in filtering. When true, parameters are excluded from the filter criteria.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Webhook ParametersACTIVE_TRAIL_GET_WEBHOOKS_PARAMETERSAcciónTool to retrieve webhook parameters for a specified webhook ID. Use when you need to fetch parameter details including parameter ID, key, value, parameter type, and event value type.
ACTIVE_TRAIL_GET_WEBHOOKS_PARAMETERSAcciónTool to retrieve webhook parameters for a specified webhook ID. Use when you need to fetch parameter details including parameter ID, key, value, parameter type, and event value type.
Parámetros de entrada
webhook_idintegerObligatorioWebhook identifier. Can be found using the endpoint 'Get account's Webhooks information'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Import New ContactsACTIVE_TRAIL_IMPORT_NEW_CONTACTSAcciónTool to import new contacts into a group in ActiveTrail. Use when you need to bulk import contacts with customer information (limited to 1000 contacts per call). Returns success count and any errors for failed contact imports.
ACTIVE_TRAIL_IMPORT_NEW_CONTACTSAcciónTool to import new contacts into a group in ActiveTrail. Use when you need to bulk import contacts with customer information (limited to 1000 contacts per call). Returns success count and any errors for failed contact imports.
Parámetros de entrada
groupintegerObligatorioGroup identifier for contact assignment (required). Find using 'Get account's groups' endpoint or via UI: Contacts→Groups→click group name→check URL
contactsobject[]ObligatorioArray of contact objects to import. Maximum 1000 contacts per request.
mailing_listintegerMailing list identifier (optional). Locate via 'Get account's mailing lists' endpoint or UI path: Contacts→Mailing Lists→click list name→view URL
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Landing PagesACTIVE_TRAIL_LIST_LANDING_PAGESAcciónTool to retrieve landing pages from ActiveTrail. Use 0 as landing_page_id to get all landing pages, or provide a specific ID to get a single landing page.
ACTIVE_TRAIL_LIST_LANDING_PAGESAcciónTool to retrieve landing pages from ActiveTrail. Use 0 as landing_page_id to get all landing pages, or provide a specific ID to get a single landing page.
Parámetros de entrada
landing_page_idintegerLanding page identifier. Use 0 to retrieve all landing pages, or provide a specific ID to retrieve a single landing page.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Mailing ListsACTIVE_TRAIL_LIST_MAILING_LISTSAcciónTool to list mailing lists from ActiveTrail account. Use when you need to retrieve all mailing lists or get details of a specific mailing list by ID.
ACTIVE_TRAIL_LIST_MAILING_LISTSAcciónTool to list mailing lists from ActiveTrail account. Use when you need to retrieve all mailing lists or get details of a specific mailing list by ID.
Parámetros de entrada
mailinglist_idintegerOptional mailing list identifier. If provided, retrieves details for the specific mailing list. If omitted, retrieves all mailing lists in the account.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Members Of A Mailing ListACTIVE_TRAIL_LIST_MEMBERS_OF_A_MAILING_LISTAcciónTool to get all information of your mailing list members by page, limited to 50 contacts each time. Use when you need to retrieve members from a specific mailing list with optional filtering by contact status and state change date range.
ACTIVE_TRAIL_LIST_MEMBERS_OF_A_MAILING_LISTAcciónTool to get all information of your mailing list members by page, limited to 50 contacts each time. Use when you need to retrieve members from a specific mailing list with optional filtering by contact status and state change date range.
Parámetros de entrada
pageintegerPage number for pagination. Valid range: 1 to 2,147,483,647
limitintegerNumber of results per page. Valid range: 1 to 100. Default is 20 if omitted
to_datestringdateState change end date. Defaults to current date if not specified. Format: YYYY-MM-DD
from_datestringdateState change start date. Default is 3 months prior to current date if not specified. Format: YYYY-MM-DD
mailinglist_idstringObligatorioMailing list identifier - the ID of the mailing list to retrieve members from. Can be found via the 'Get account's mailing lists' endpoint or in the UI at Contacts → Mailing Lists → click list name → check URL
customer_statesstringFilter results by contact status. Comma-separated values for multiple statuses (active, unsubscribed, bounced, blocked, etc.)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Sign-Up FormsACTIVE_TRAIL_LIST_SIGN_UP_FORMSAcciónTool to retrieve signup forms from the ActiveTrail account. Use when you need to get a list of all signup forms (by using signup_form_id=0) or details of a specific signup form (by providing the form ID).
ACTIVE_TRAIL_LIST_SIGN_UP_FORMSAcciónTool to retrieve signup forms from the ActiveTrail account. Use when you need to get a list of all signup forms (by using signup_form_id=0) or details of a specific signup form (by providing the form ID).
Parámetros de entrada
signup_form_idintegerSignup form identifier. Use 0 to retrieve all signup forms, or provide a specific form ID to retrieve that form's details. Can be found in the UI or from the Get Signup Forms endpoint.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List SMS CampaignsACTIVE_TRAIL_LIST_SMS_CAMPAIGNSAcciónTool to retrieve SMS campaigns with optional filtering by date, search term, and type. Use when you need to get SMS campaigns filtered by date range (default is last 3 months) or other criteria. Returns up to 20 campaigns per page by default.
ACTIVE_TRAIL_LIST_SMS_CAMPAIGNSAcciónTool to retrieve SMS campaigns with optional filtering by date, search term, and type. Use when you need to get SMS campaigns filtered by date range (default is last 3 months) or other criteria. Returns up to 20 campaigns per page by default.
Parámetros de entrada
pageintegerPage number for pagination. Default is 1
limitintegerNumber of results per page. Default is 20
to_datestringFilter campaigns up to this end date in ISO format (YYYY-MM-DD). Campaigns must be sent in the time range set. Default is current date if not specified
from_datestringFilter campaigns from this start date in ISO format (YYYY-MM-DD). Campaigns must be sent in the time range set. Default is 3 months ago from current date if not specified
filter_typestringFilter campaigns by type/status
search_termstringSearch campaigns by name or content
is_include_not_sentbooleanInclude campaigns that have not yet been sent
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Specific SMS CampaignACTIVE_TRAIL_LIST_SPECIFIC_SMS_CAMPAIGNAcciónTool to retrieve a specific SMS campaign by ID including full details like content, status, targeting, and scheduling. Use when you need comprehensive information about a particular SMS campaign.
ACTIVE_TRAIL_LIST_SPECIFIC_SMS_CAMPAIGNAcciónTool to retrieve a specific SMS campaign by ID including full details like content, status, targeting, and scheduling. Use when you need comprehensive information about a particular SMS campaign.
Parámetros de entrada
sms_campaign_idintegerObligatorioSMS campaign identifier. Can be found using the endpoint 'Get account's SMS campaigns'
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Transactional SMS MessagesACTIVE_TRAIL_LIST_TRANSACTIONAL_SMS_MESSAGESAcciónTool to retrieve all SMS transactional messages with pagination support. Use when you need to fetch the list of operational SMS campaigns configured in the account.
ACTIVE_TRAIL_LIST_TRANSACTIONAL_SMS_MESSAGESAcciónTool to retrieve all SMS transactional messages with pagination support. Use when you need to fetch the list of operational SMS campaigns configured in the account.
Parámetros de entrada
pageintegerPage number for pagination. Use this to navigate through multiple pages of results.
limitintegerMaximum number of results to return per page. Controls the page size for pagination.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Campaign from TemplateACTIVE_TRAIL_POST_TEMPLATES_CAMPAIGNAcciónTool to create a campaign using a specific template. Use when you need to create a new email campaign based on an existing template.
ACTIVE_TRAIL_POST_TEMPLATES_CAMPAIGNAcciónTool to create a campaign using a specific template. Use when you need to create a new email campaign based on an existing template.
Parámetros de entrada
template_idstringObligatorioThe unique identifier of the template to use for campaign creation
campaign_detailsobjectObligatorioCampaign details including name, subject, and user profile ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Template CategoryACTIVE_TRAIL_POST_TEMPLATES_TEMPLATE_CATEGORYAcciónTool to create a new template category in ActiveTrail. Use when you need to add a new category for organizing email templates.
ACTIVE_TRAIL_POST_TEMPLATES_TEMPLATE_CATEGORYAcciónTool to create a new template category in ActiveTrail. Use when you need to add a new category for organizing email templates.
Parámetros de entrada
namestringObligatorioThe name of the template category to create. This is a required field.
name_keystringOptional name key identifier. Can be deleted in a post/put endpoints.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Webhook ParameterACTIVE_TRAIL_POST_WEBHOOKS_PARAMETERSAcciónTool to update a given webhook parameter configuration in your ActiveTrail account. Use when you need to add or update parameters for webhook events such as headers, query parameters, or body data.
ACTIVE_TRAIL_POST_WEBHOOKS_PARAMETERSAcciónTool to update a given webhook parameter configuration in your ActiveTrail account. Use when you need to add or update parameters for webhook events such as headers, query parameters, or body data.
Parámetros de entrada
keystringObligatorioName of the parameter (e.g., 'X-API-Key' for headers)
valuestringObligatorioValue of the parameter
user_fieldstringUser field mapping. Required when event_value_type is 'user_field'
webhook_idstringObligatorioThe webhook identifier
event_value_typestringObligatorioValue type of parameter (e.g., 'custom_text', 'user_field')
event_parameter_typestringObligatorioType of parameter as enum (e.g., 'header', 'query', 'body')
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Send Test Webhook RequestACTIVE_TRAIL_POST_WEBHOOKS_TEST2AcciónTool to send a test webhook request with configurable URL and parameters. Use when you need to validate webhook configurations by sending a test request to a specified URL with custom event types, parameters, and target types.
ACTIVE_TRAIL_POST_WEBHOOKS_TEST2AcciónTool to send a test webhook request with configurable URL and parameters. Use when you need to validate webhook configurations by sending a test request to a specified URL with custom event types, parameters, and target types.
Parámetros de entrada
urlstringObligatorioTarget webhook endpoint URL to receive the test request
formatintegerObligatorioResponse format identifier
user_idintegerUser identifier
event_typestringObligatorioEvent type for the webhook test (e.g., 'contact_change')
parametersobject[]Collection of key-value pairs with event parameter type for custom headers or body parameters
target_typestringObligatorioTarget type for the webhook (e.g., 'zapier', 'custom')
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update content categoryACTIVE_TRAIL_PUT_ACCOUNT_CONTENT_CATEGORIESAcciónTool to update a specific content category by ID. Use when you need to modify the name or display order of a category in your ActiveTrail account.
ACTIVE_TRAIL_PUT_ACCOUNT_CONTENT_CATEGORIESAcciónTool to update a specific content category by ID. Use when you need to modify the name or display order of a category in your ActiveTrail account.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the category to update
namestringObligatorioThe new name for the category
display_orderintegerObligatorioThe display order for the category (determines the position in lists)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Campaign DetailsACTIVE_TRAIL_PUT_CAMPAIGNS_DETAILSAcciónTool to update campaign details in ActiveTrail. Use when you need to modify campaign properties like name, subject, or settings. Note: Only campaigns in draft mode can be updated.
ACTIVE_TRAIL_PUT_CAMPAIGNS_DETAILSAcciónTool to update campaign details in ActiveTrail. Use when you need to modify campaign properties like name, subject, or settings. Note: Only campaigns in draft mode can be updated.
Parámetros de entrada
idintegerObligatorioCampaign identifier. Only draft campaigns can be updated.
namestringObligatorioInternal campaign name
subjectstringObligatorioEmail subject line
preheaderstringShort summary text that follows the subject line when viewing email in inbox
user_profile_idintegerObligatorioSender profile ID
content_category_idintegerObligatorioCategory ID for organizing campaigns
predictive_deliverybooleanObligatorioEnables predictive delivery feature if available on the account
google_analytics_namestringGoogle Analytics campaign name for tracking integration (English characters only, no special characters or spaces)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Campaign Segment SettingsACTIVE_TRAIL_PUT_CAMPAIGNS_SEGMENTAcciónTool to update campaign sending settings including groups and sending restrictions. Use when you need to modify which groups receive a campaign. Note: Only campaigns in draft mode can be updated.
ACTIVE_TRAIL_PUT_CAMPAIGNS_SEGMENTAcciónTool to update campaign sending settings including groups and sending restrictions. Use when you need to modify which groups receive a campaign. Note: Only campaigns in draft mode can be updated.
Parámetros de entrada
idintegerObligatorioCampaign identifier. Only draft campaigns can be updated.
group_idsinteger[]ObligatorioList of group IDs to target for the campaign. These groups will receive the campaign.
restricted_group_idsinteger[]List of group IDs to exclude from the campaign. Members of these groups will not receive the campaign even if they belong to target groups.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Remove Contact from Mailing ListACTIVE_TRAIL_REMOVE_A_CONTACT_FROM_A_MAILING_LISTAcciónTool to remove a contact from a mailing list in ActiveTrail. Use when you need to delete a specific contact from a mailing list.
ACTIVE_TRAIL_REMOVE_A_CONTACT_FROM_A_MAILING_LISTAcciónTool to remove a contact from a mailing list in ActiveTrail. Use when you need to delete a specific contact from a mailing list.
Parámetros de entrada
contact_idstringObligatorioThe contact identifier to be removed from the mailing list
mailinglist_idstringObligatorioThe mailing list identifier from which to remove the contact
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Remove external contacts from groupACTIVE_TRAIL_REMOVE_EXTERNAL_CONTACT_FROM_GROUPAcciónTool to remove contacts from a group via external ID. Use when you need to delete external contacts from a specific group in ActiveTrail. Limited to 1000 contacts per call.
ACTIVE_TRAIL_REMOVE_EXTERNAL_CONTACT_FROM_GROUPAcciónTool to remove contacts from a group via external ID. Use when you need to delete external contacts from a specific group in ActiveTrail. Limited to 1000 contacts per call.
Parámetros de entrada
group_idstringObligatorioThe unique identifier for the group from which contacts will be removed
external_contactsobject[]ObligatorioList of external contacts to remove from the group. Each contact requires both externalId and externalName to match. Maximum 1000 contacts per call.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Test WebhookACTIVE_TRAIL_TEST_WEBHOOKAcciónTool to send a test request for a given webhook by its ID. Use when you need to validate an existing webhook configuration without requiring actual trigger events.
ACTIVE_TRAIL_TEST_WEBHOOKAcciónTool to send a test request for a given webhook by its ID. Use when you need to validate an existing webhook configuration without requiring actual trigger events.
Parámetros de entrada
idintegerObligatorioWebhook identifier - the ID of the webhook you want to test
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update CampaignACTIVE_TRAIL_UPDATE_CAMPAIGNAcciónTool to update draft campaigns in ActiveTrail. Use when you need to modify campaign properties such as name, subject, content, or design settings. IMPORTANT: Only campaigns in draft mode can be updated - campaigns that have been sent or are scheduled cannot be modified.
ACTIVE_TRAIL_UPDATE_CAMPAIGNAcciónTool to update draft campaigns in ActiveTrail. Use when you need to modify campaign properties such as name, subject, content, or design settings. IMPORTANT: Only campaigns in draft mode can be updated - campaigns that have been sent or are scheduled cannot be modified.
Parámetros de entrada
idintegerObligatorioThe campaign identifier (used in URL path)
designobjectObligatorioCampaign design configuration containing HTML content and formatting options
detailsobjectObligatorioCampaign details object containing name, subject, and configuration
send_teststringComma-separated list of email addresses for test emails
send_typestringCampaign send type (e.g., 'Regular', 'Empty')
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Campaign DesignACTIVE_TRAIL_UPDATE_CAMPAIGN_DESIGNAcciónTool to update the design and HTML content of an email campaign in ActiveTrail. Use when you need to modify a campaign's visual layout, HTML content, or encoding settings. Important: Only campaigns in draft mode can be updated through this endpoint.
ACTIVE_TRAIL_UPDATE_CAMPAIGN_DESIGNAcciónTool to update the design and HTML content of an email campaign in ActiveTrail. Use when you need to modify a campaign's visual layout, HTML content, or encoding settings. Important: Only campaigns in draft mode can be updated through this endpoint.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the campaign whose design should be modified. Only campaigns in draft mode can be updated.
contentstringObligatorioHTML content for the campaign email body. This is the main visual content that recipients will see.
language_typestringCharacter encoding type for the email content. Common value is 'UTF_8'.
is_add_print_emailbooleanWhether to add a print email option to the campaign. Set to true to include print functionality.
is_auto_css_inlinerbooleanWhether to automatically inline CSS styles into HTML elements. This improves email client compatibility.
is_remove_system_linksbooleanWhether to remove system-generated links (such as unsubscribe links) from the campaign.
header_footer_language_typestringCharacter encoding type for the header and footer sections. Common value is 'UTF_8'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Campaign SchedulingACTIVE_TRAIL_UPDATE_CAMPAIGN_SCHEDULINGAcciónTool to configure send schedule for draft campaigns. Use when you need to update the scheduling configuration of a campaign. Only campaigns in draft mode can be updated.
ACTIVE_TRAIL_UPDATE_CAMPAIGN_SCHEDULINGAcciónTool to configure send schedule for draft campaigns. Use when you need to update the scheduling configuration of a campaign. Only campaigns in draft mode can be updated.
Parámetros de entrada
idintegerObligatorioCampaign identifier. Can be found using the 'Get account's email campaigns' endpoint or from the campaign preview URL in the UI
is_sentbooleanObligatorioFlag indicating whether the campaign should be dispatched
scheduled_date_utcstringObligatorioPlanned send date/time in UTC format (e.g., '2016-12-24T14:12:12'). Cannot be set to a past date
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Campaign DetailsACTIVE_TRAIL_UPDATE_CAMPAIGN_S_DETAILSAcciónTool to update a campaign's details by ID in ActiveTrail. Use when you need to modify campaign properties like name, subject, sender profile, or settings. Important: Only campaigns in draft mode can be updated.
ACTIVE_TRAIL_UPDATE_CAMPAIGN_S_DETAILSAcciónTool to update a campaign's details by ID in ActiveTrail. Use when you need to modify campaign properties like name, subject, sender profile, or settings. Important: Only campaigns in draft mode can be updated.
Parámetros de entrada
idintegerObligatorioCampaign identifier. Only draft campaigns can be updated.
namestringObligatorioInternal campaign name for identification purposes
subjectstringObligatorioEmail subject line that recipients will see
preheaderstringShort summary text that follows the subject line when viewing an email from the inbox. For A/B testing, preheader text remains identical across versions.
user_profile_idintegerObligatorioSender email profile ID obtained from 'Get account emails sending profiles' endpoint
content_category_idintegerObligatorioCategory ID for organizing campaigns. Defaults to default category if omitted.
predictive_deliverybooleanObligatorioEnable predictive delivery feature. Requires feature activation on the account. Remove parameter if account lacks this feature.
google_analytics_namestringGoogle Analytics integration label. Must be in English with no special characters or spaces. If UTM parameters already exist on links, GA integration may not work.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Campaign TemplateACTIVE_TRAIL_UPDATE_CAMPAIGN_TEMPLATEAcciónTool to update the template associated with an email campaign in ActiveTrail. Use when you need to assign or change a template for a campaign. Important: Only campaigns in draft mode can be updated through this endpoint.
ACTIVE_TRAIL_UPDATE_CAMPAIGN_TEMPLATEAcciónTool to update the template associated with an email campaign in ActiveTrail. Use when you need to assign or change a template for a campaign. Important: Only campaigns in draft mode can be updated through this endpoint.
Parámetros de entrada
campaign_idintegerObligatorioThe unique identifier of the campaign whose template should be updated. Only campaigns in draft mode can be updated.
template_idintegerObligatorioThe unique identifier of the template to assign to the campaign.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ContactACTIVE_TRAIL_UPDATE_CONTACTAcciónTool to update an existing contact's information by ID. Use when you need to modify contact details such as name, email, phone, address, or custom fields. Only the fields you include in the request will be updated; other fields remain unchanged.
ACTIVE_TRAIL_UPDATE_CONTACTAcciónTool to update an existing contact's information by ID. Use when you need to modify contact details such as name, email, phone, address, or custom fields. Only the fields you include in the request will be updated; other fields remain unchanged.
Parámetros de entrada
idintegerObligatorioContact ID to update. Can be found using the 'Get account's contacts list' endpoint
faxstringFax number
smsstringContact's SMS/phone number. Either email or sms must be provided
citystringCity
ext1stringCustom extension field 1
ext2stringCustom extension field 2
ext3stringCustom extension field 3
ext4stringCustom extension field 4
ext5stringCustom extension field 5
ext6stringCustom extension field 6
ext7stringCustom extension field 7
ext8stringCustom extension field 8
ext9stringCustom extension field 9
num1integerCustom numeric field 1
num2integerCustom numeric field 2
num3integerCustom numeric field 3
num4integerCustom numeric field 4
num5integerCustom numeric field 5
date1stringdateCustom date field 1
date2stringdateCustom date field 2
date3stringdateCustom date field 3
date4stringdateCustom date field 4
date5stringdateCustom date field 5
emailstringContact's email address. Either email or sms must be provided
ext10stringCustom extension field 10
ext11stringCustom extension field 11
ext12stringCustom extension field 12
ext13stringCustom extension field 13
ext14stringCustom extension field 14
ext15stringCustom extension field 15
ext16stringCustom extension field 16
ext17stringCustom extension field 17
ext18stringCustom extension field 18
ext19stringCustom extension field 19
ext20stringCustom extension field 20
ext21stringCustom extension field 21
ext22stringCustom extension field 22
ext23stringCustom extension field 23
ext24stringCustom extension field 24
ext25stringCustom extension field 25
phone1stringPrimary phone number
phone2stringSecondary phone number
statusstringContact status
streetstringStreet address
birthdaystringdateBirthday date
zip_codestringPostal/ZIP code
last_namestringLast name
first_namestringFirst name
is_deletedbooleanIf true - contact will be deleted. If false - contact will be restored if previously deleted
sms_statusstringSMS contact status
anniversarystringdateAnniversary date
subscribe_ipstringThe Subscribe IP address
double_opt_in_configobjectConfiguration for double opt-in email.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Contact DetailsACTIVE_TRAIL_UPDATE_CONTACT_S_DETAILSAcciónTool to update an existing contact's information in ActiveTrail. Use when you need to modify contact data by contact ID or email address. Changes are permanent and cannot be undone. Include only the fields you want to update in the request.
ACTIVE_TRAIL_UPDATE_CONTACT_S_DETAILSAcciónTool to update an existing contact's information in ActiveTrail. Use when you need to modify contact data by contact ID or email address. Changes are permanent and cannot be undone. Include only the fields you want to update in the request.
Parámetros de entrada
faxstringFax number
smsstringSMS phone number for text messages
citystringCity name
ext1stringCustom field 1
ext2stringCustom field 2
ext3stringCustom field 3
ext4stringCustom field 4
ext5stringCustom field 5
ext6stringCustom field 6
emailstringContact's email address (read-only field, will be ignored if included)
statestringContact state (e.g., 'unsubscribed', 'cleaned')
phone1stringPrimary phone number
phone2stringSecondary phone number
statusstringContact status
streetstringStreet address
birthdaystringdateContact's birth date
is_optinbooleanWhether contact confirmed subscription via double opt-in (true = confirmed, false = not confirmed)
zip_codestringZip or postal code
last_namestringContact's last name
contact_idstringObligatorioContact identifier (ID or email address in lowercase)
first_namestringContact's first name
anniversarystringdateWedding anniversary date
campaign_idstringGroup/campaign ID for adding contact to groups
encryptedext1stringEncrypted custom field 1
encryptedext2stringEncrypted custom field 2
encryptedext3stringEncrypted custom field 3
encryptedext4stringEncrypted custom field 4
is_do_not_mailbooleanEmail delivery control (true = won't receive email, false = ready to receive)
is_trigger_eventsbooleanWhether to trigger automated events/workflows when updating
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update GroupACTIVE_TRAIL_UPDATE_GROUPAcciónTool to update an existing group by ID. Use when you need to modify group properties such as name, counters, or timestamps in ActiveTrail.
ACTIVE_TRAIL_UPDATE_GROUPAcciónTool to update an existing group by ID. Use when you need to modify group properties such as name, counters, or timestamps in ActiveTrail.
Parámetros de entrada
idintegerObligatorioGroup id. Can be found using the endpoint 'Get account's groups'
namestringName of the group
counterintegerTotal contacts in the group
createdstringDate of creation of the group in ISO 8601 datetime format (e.g., '2016-12-24T14:12:12')
active_counterintegerNumber of active contacts in the group
last_generatedstringDynamic group only - the last time it generated contacts in ISO 8601 datetime format (e.g., '2016-12-24T14:12:12')
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Rename GroupACTIVE_TRAIL_UPDATE_GROUP_S_NAMEAcciónTool to rename a group's name in ActiveTrail. Use when you need to change the name of an existing group.
ACTIVE_TRAIL_UPDATE_GROUP_S_NAMEAcciónTool to rename a group's name in ActiveTrail. Use when you need to change the name of an existing group.
Parámetros de entrada
namestringObligatorioThe new name for the group
group_idintegerObligatorioThe unique identifier of the group to rename. Can be found using the 'Get account's groups' endpoint
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update OrderACTIVE_TRAIL_UPDATE_ORDERAcciónTool to modify existing orders in ActiveTrail commerce system. Use when you need to update order details such as customer information, order status, pricing, or items. Requires the order ID.
ACTIVE_TRAIL_UPDATE_ORDERAcciónTool to modify existing orders in ActiveTrail commerce system. Use when you need to update order details such as customer information, order status, pricing, or items. Requires the order ID.
Parámetros de entrada
taxnumberTax amount applied to the order
citystringShipping city
emailstringCustomer email address
itemsobject[]Array of product items in the order
mobilestringCustomer mobile phone number
statusstringCurrent order status
addressstringShipping street address
orderIdstringOrder identifier (included in request body if updating)
currencystringCurrency code
lastNamestringCustomer's last name
order_idstringObligatorioUnique identifier for the order to update (used in URL path)
firstNamestringCustomer's first name
netAmountnumberPre-tax order amount
orderNamestringName or label for the order
totalPricenumberTotal order price
totalAmountnumberFinal order total including tax
purchaseDatestringTransaction date in ISO 8601 format
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Smart Code SiteACTIVE_TRAIL_UPDATE_SMART_CODE_SITEAcciónTool to update an existing Smart Code site in ActiveTrail. Use when you need to modify site details such as name or associated domains.
ACTIVE_TRAIL_UPDATE_SMART_CODE_SITEAcciónTool to update an existing Smart Code site in ActiveTrail. Use when you need to modify site details such as name or associated domains.
Parámetros de entrada
idstringObligatorioThe unique identifier of the Smart Code site to update (used in URL path)
namestringThe name of the Smart Code site
domainsstringComma-separated list of domains associated with the Smart Code site
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update TemplateACTIVE_TRAIL_UPDATE_TEMPLATEAcciónTool to update an existing template in ActiveTrail account. Use when you need to modify template properties such as name, subject, content, category, or encoding settings.
ACTIVE_TRAIL_UPDATE_TEMPLATEAcciónTool to update an existing template in ActiveTrail account. Use when you need to modify template properties such as name, subject, content, category, or encoding settings.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the template to update
namestringTemplate name. Update this to change the template's display name.
contentstringHTML or text content of the template. Update this to change the template's body content.
subjectstringEmail subject line. Update this to change the default subject for emails using this template.
editor_typestringTemplate editor type. Typically 'HTML' for HTML-based templates.
AddPrintButtonbooleanWhether to include a print button in the template
campaign_encodingintegerCharacter encoding for the campaign. 0 typically represents UTF-8.
template_category_idintegerCategory identifier for organizing templates
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Template ContentACTIVE_TRAIL_UPDATE_TEMPLATE_CONTENTAcciónTool to update the HTML content of an email template in ActiveTrail. Use when you need to modify the design or layout of an existing template.
ACTIVE_TRAIL_UPDATE_TEMPLATE_CONTENTAcciónTool to update the HTML content of an email template in ActiveTrail. Use when you need to modify the design or layout of an existing template.
Parámetros de entrada
idstringObligatorioThe unique identifier of the template to update
contentstringObligatorioThe HTML content for the template. This field contains the email template's HTML design/layout.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update WebhookACTIVE_TRAIL_UPDATE_WEBHOOKAcciónTool to update an existing webhook configuration in ActiveTrail. Use when you need to modify webhook properties such as name, URL, event type, format, or active status.
ACTIVE_TRAIL_UPDATE_WEBHOOKAcciónTool to update an existing webhook configuration in ActiveTrail. Use when you need to modify webhook properties such as name, URL, event type, format, or active status.
Parámetros de entrada
idintegerObligatorioThe webhook ID to update. Can be found using the GET /api/webhooks endpoint.
urlstringObligatorioThe target URL that the webhook will call. Must be a full URL including http:// or https://
namestringObligatorioThe name of the webhook
formatintegerWebhook format specification. Can be a string like 'json' or 'xml', or an integer code.
typeidintegerWebhook type ID. Required by API. Typically set to 1.
stateidintegerWebhook state ID. Required by API. Use 10 for active webhooks.
is_activebooleanIndicates whether the webhook is active or not
event_typestringEvent type designation that triggers the webhook
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not