Documentation Index
Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /activetrail-campaigns | Type: Application | PCID required: Yes
activetrail_campaigns_create_campaign
Create a new email campaign for specific groups
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
content | object | No | — | Campaign content |
groupIds | integer[] | Yes | — | Target group IDs |
name | string | Yes | — | Campaign name |
subject | string | Yes | — | Email subject line |
type | string | No | — | Campaign type |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"content": {
"type": "object",
"description": "Campaign content"
},
"groupIds": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Target group IDs"
},
"name": {
"type": "string",
"description": "Campaign name"
},
"subject": {
"type": "string",
"description": "Email subject line"
},
"type": {
"type": "string",
"description": "Campaign type"
}
},
"required": [
"PCID",
"groupIds",
"name",
"subject"
]
}
activetrail_campaigns_create_sms_campaign
Create a new SMS campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
content | string | Yes | — | SMS message content |
groupIds | integer[] | Yes | — | Target group IDs |
name | string | Yes | — | Campaign name |
sendDate | string | No | — | Scheduled send date |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"content": {
"type": "string",
"description": "SMS message content"
},
"groupIds": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Target group IDs"
},
"name": {
"type": "string",
"description": "Campaign name"
},
"sendDate": {
"type": "string",
"description": "Scheduled send date"
}
},
"required": [
"PCID",
"content",
"groupIds",
"name"
]
}
activetrail_campaigns_create_template
Create a new email template
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
category | string | No | — | Template category |
content | string | Yes | — | Template HTML content |
name | string | Yes | — | Template name |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"category": {
"type": "string",
"description": "Template category"
},
"content": {
"type": "string",
"description": "Template HTML content"
},
"name": {
"type": "string",
"description": "Template name"
}
},
"required": [
"PCID",
"content",
"name"
]
}
activetrail_campaigns_delete_campaign
Delete a campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Campaign ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Campaign ID"
}
},
"required": [
"PCID",
"id"
]
}
activetrail_campaigns_delete_template
Delete a template
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Template ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Template ID"
}
},
"required": [
"PCID",
"id"
]
}
activetrail_campaigns_get_campaign
Get a campaign by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Campaign ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Campaign ID"
}
},
"required": [
"PCID",
"id"
]
}
activetrail_campaigns_get_campaign_bounces
Get campaign bounce data and domain breakdown
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Campaign ID |
FromDate | string | No | — | Start date for filtering (inclusive) |
ToDate | string | No | — | End date for filtering (inclusive) |
Page | integer | No | — | Page number for pagination |
Limit | integer | No | — | Maximum number of results to return |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Campaign ID"
},
"FromDate": {
"type": "string",
"description": "Start date for filtering (inclusive)"
},
"ToDate": {
"type": "string",
"description": "End date for filtering (inclusive)"
},
"Page": {
"type": "integer",
"description": "Page number for pagination"
},
"Limit": {
"type": "integer",
"description": "Maximum number of results to return"
}
},
"required": [
"PCID",
"id"
]
}
activetrail_campaigns_get_campaign_click_details
Get click report with link details for a campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Campaign ID |
FromDate | string | No | — | Start date for filtering (inclusive) |
ToDate | string | No | — | End date for filtering (inclusive) |
Page | integer | No | — | Page number for pagination |
Limit | integer | No | — | Maximum number of results to return |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Campaign ID"
},
"FromDate": {
"type": "string",
"description": "Start date for filtering (inclusive)"
},
"ToDate": {
"type": "string",
"description": "End date for filtering (inclusive)"
},
"Page": {
"type": "integer",
"description": "Page number for pagination"
},
"Limit": {
"type": "integer",
"description": "Maximum number of results to return"
}
},
"required": [
"PCID",
"id"
]
}
activetrail_campaigns_get_campaign_opens
Get contacts who opened a campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Campaign ID |
Groupid | integer | No | — | Filter by group |
FromDate | string | No | — | Start date for filtering (inclusive) |
ToDate | string | No | — | End date for filtering (inclusive) |
Page | integer | No | — | Page number for pagination |
Limit | integer | No | — | Maximum number of results to return |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Campaign ID"
},
"Groupid": {
"type": "integer",
"description": "Filter by group"
},
"FromDate": {
"type": "string",
"description": "Start date for filtering (inclusive)"
},
"ToDate": {
"type": "string",
"description": "End date for filtering (inclusive)"
},
"Page": {
"type": "integer",
"description": "Page number for pagination"
},
"Limit": {
"type": "integer",
"description": "Maximum number of results to return"
}
},
"required": [
"PCID",
"id"
]
}
activetrail_campaigns_get_campaign_report
Get overview report for a specific campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Campaign ID |
FromDate | string | No | — | Start date for filtering (inclusive) |
ToDate | string | No | — | End date for filtering (inclusive) |
Page | integer | No | — | Page number for pagination |
Limit | integer | No | — | Maximum number of results to return |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Campaign ID"
},
"FromDate": {
"type": "string",
"description": "Start date for filtering (inclusive)"
},
"ToDate": {
"type": "string",
"description": "End date for filtering (inclusive)"
},
"Page": {
"type": "integer",
"description": "Page number for pagination"
},
"Limit": {
"type": "integer",
"description": "Maximum number of results to return"
}
},
"required": [
"PCID",
"id"
]
}
activetrail_campaigns_get_campaign_scheduling
Get campaign schedule settings
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Campaign ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Campaign ID"
}
},
"required": [
"PCID",
"id"
]
}
activetrail_campaigns_get_campaign_unsubscribed
Get unsubscribed contacts from a campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Campaign ID |
FromDate | string | No | — | Start date for filtering (inclusive) |
ToDate | string | No | — | End date for filtering (inclusive) |
Page | integer | No | — | Page number for pagination |
Limit | integer | No | — | Maximum number of results to return |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Campaign ID"
},
"FromDate": {
"type": "string",
"description": "Start date for filtering (inclusive)"
},
"ToDate": {
"type": "string",
"description": "End date for filtering (inclusive)"
},
"Page": {
"type": "integer",
"description": "Page number for pagination"
},
"Limit": {
"type": "integer",
"description": "Maximum number of results to return"
}
},
"required": [
"PCID",
"id"
]
}
activetrail_campaigns_get_sms_campaign
Get an SMS campaign by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | SMS campaign ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "SMS campaign ID"
}
},
"required": [
"PCID",
"id"
]
}
activetrail_campaigns_get_sms_campaign_report
Get a specific SMS campaign summary report
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | SMS campaign ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "SMS campaign ID"
}
},
"required": [
"PCID",
"id"
]
}
activetrail_campaigns_get_template
Get a specific template
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Template ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Template ID"
}
},
"required": [
"PCID",
"id"
]
}
activetrail_campaigns_list_campaign_reports
Get campaign reports with send, open, click, bounce data
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
FromDate | string | No | — | Start date for filtering (inclusive) |
ToDate | string | No | — | End date for filtering (inclusive) |
Page | integer | No | — | Page number for pagination |
Limit | integer | No | — | Maximum number of results to return |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"FromDate": {
"type": "string",
"description": "Start date for filtering (inclusive)"
},
"ToDate": {
"type": "string",
"description": "End date for filtering (inclusive)"
},
"Page": {
"type": "integer",
"description": "Page number for pagination"
},
"Limit": {
"type": "integer",
"description": "Maximum number of results to return"
}
},
"required": [
"PCID"
]
}
activetrail_campaigns_list_campaigns
Get account email campaigns
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
MailingListId | integer | No | — | Filter by mailing list |
ContentCategoryId | integer | No | — | Filter by content category |
SearchTerm | string | No | — | Search term to filter results |
SendType | string | No | — | Send Type |
FromDate | string | No | — | Start date for filtering (inclusive) |
ToDate | string | No | — | End date for filtering (inclusive) |
Page | integer | No | — | Page number for pagination |
Limit | integer | No | — | Maximum number of results to return |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"MailingListId": {
"type": "integer",
"description": "Filter by mailing list"
},
"ContentCategoryId": {
"type": "integer",
"description": "Filter by content category"
},
"SearchTerm": {
"type": "string",
"description": "Search term to filter results"
},
"SendType": {
"type": "string",
"description": "Send Type"
},
"FromDate": {
"type": "string",
"description": "Start date for filtering (inclusive)"
},
"ToDate": {
"type": "string",
"description": "End date for filtering (inclusive)"
},
"Page": {
"type": "integer",
"description": "Page number for pagination"
},
"Limit": {
"type": "integer",
"description": "Maximum number of results to return"
}
},
"required": [
"PCID"
]
}
activetrail_campaigns_list_sent_campaigns
Get list of sent campaigns
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
activetrail_campaigns_list_sms_campaign_reports
Get SMS campaign reports
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
SendType | string | No | — | Send Type |
SearchTerm | string | No | — | Search term to filter results |
FromDate | string | No | — | Start date for filtering (inclusive) |
ToDate | string | No | — | End date for filtering (inclusive) |
Page | integer | No | — | Page number for pagination |
Limit | integer | No | — | Maximum number of results to return |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"SendType": {
"type": "string",
"description": "Send Type"
},
"SearchTerm": {
"type": "string",
"description": "Search term to filter results"
},
"FromDate": {
"type": "string",
"description": "Start date for filtering (inclusive)"
},
"ToDate": {
"type": "string",
"description": "End date for filtering (inclusive)"
},
"Page": {
"type": "integer",
"description": "Page number for pagination"
},
"Limit": {
"type": "integer",
"description": "Maximum number of results to return"
}
},
"required": [
"PCID"
]
}
activetrail_campaigns_list_sms_campaigns
Get account SMS campaigns
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
IsIncludeNotSent | boolean | No | — | Include unsent campaigns |
FromDate | string | No | — | Start date for filtering (inclusive) |
ToDate | string | No | — | End date for filtering (inclusive) |
SearchTerm | string | No | — | Search term to filter results |
FilterType | string | No | — | Filter Type |
Page | integer | No | — | Page number for pagination |
Limit | integer | No | — | Maximum number of results to return |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"IsIncludeNotSent": {
"type": "boolean",
"description": "Include unsent campaigns"
},
"FromDate": {
"type": "string",
"description": "Start date for filtering (inclusive)"
},
"ToDate": {
"type": "string",
"description": "End date for filtering (inclusive)"
},
"SearchTerm": {
"type": "string",
"description": "Search term to filter results"
},
"FilterType": {
"type": "string",
"description": "Filter Type"
},
"Page": {
"type": "integer",
"description": "Page number for pagination"
},
"Limit": {
"type": "integer",
"description": "Maximum number of results to return"
}
},
"required": [
"PCID"
]
}
activetrail_campaigns_list_templates
Get saved email templates
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
activetrail_campaigns_list_whats_app_templates
Get all approved WhatsApp templates
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
activetrail_campaigns_send_operational_email
Send an email operational message to individual emails (max 500)
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
content | string | Yes | — | Email HTML content |
email | string | Yes | — | Recipient email address |
subject | string | Yes | — | Email subject |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"content": {
"type": "string",
"description": "Email HTML content"
},
"email": {
"type": "string",
"description": "Recipient email address"
},
"subject": {
"type": "string",
"description": "Email subject"
}
},
"required": [
"PCID",
"content",
"email",
"subject"
]
}
Send an email operational message to contacts (max 500)
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
contactId | string | Yes | — | Contact ID |
content | string | Yes | — | Email HTML content |
subject | string | Yes | — | Email subject |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "Contact ID"
},
"content": {
"type": "string",
"description": "Email HTML content"
},
"subject": {
"type": "string",
"description": "Email subject"
}
},
"required": [
"PCID",
"contactId",
"content",
"subject"
]
}
activetrail_campaigns_send_whats_app_campaign
Create and send a WhatsApp campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
attachment | object | No | — | File attachment |
contacts | object[] | Yes | — | Target contacts |
content | string | No | — | Message content |
templateSid | string | Yes | — | Approved WhatsApp template SID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"attachment": {
"type": "object",
"description": "File attachment"
},
"contacts": {
"type": "array",
"items": {
"type": "object"
},
"description": "Target contacts"
},
"content": {
"type": "string",
"description": "Message content"
},
"templateSid": {
"type": "string",
"description": "Approved WhatsApp template SID"
}
},
"required": [
"PCID",
"contacts",
"templateSid"
]
}
activetrail_campaigns_update_campaign
Update a draft campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Campaign ID |
content | object | No | — | The content value |
groupIds | integer[] | No | — | Group Ids |
name | string | No | — | The name value |
subject | string | No | — | The subject value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Campaign ID"
},
"content": {
"type": "object",
"description": "The content value"
},
"groupIds": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Group Ids"
},
"name": {
"type": "string",
"description": "The name value"
},
"subject": {
"type": "string",
"description": "The subject value"
}
},
"required": [
"PCID",
"id"
]
}
activetrail_campaigns_update_campaign_scheduling
Update campaign schedule (draft only)
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Campaign ID |
recurring | boolean | No | — | Whether campaign is recurring |
sendDate | string | No | — | Scheduled send date |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Campaign ID"
},
"recurring": {
"type": "boolean",
"description": "Whether campaign is recurring"
},
"sendDate": {
"type": "string",
"description": "Scheduled send date"
}
},
"required": [
"PCID",
"id"
]
}
activetrail_campaigns_update_sms_campaign
Update an SMS campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | SMS campaign ID |
content | string | No | — | The content value |
groupIds | integer[] | No | — | Group Ids |
name | string | No | — | The name value |
sendDate | string | No | — | Send Date |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "SMS campaign ID"
},
"content": {
"type": "string",
"description": "The content value"
},
"groupIds": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Group Ids"
},
"name": {
"type": "string",
"description": "The name value"
},
"sendDate": {
"type": "string",
"description": "Send Date"
}
},
"required": [
"PCID",
"id"
]
}
activetrail_campaigns_update_template
Update a template
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Template ID |
category | string | No | — | The category value |
content | string | No | — | The content value |
name | string | No | — | The name value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Template ID"
},
"category": {
"type": "string",
"description": "The category value"
},
"content": {
"type": "string",
"description": "The content value"
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"PCID",
"id"
]
}