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-management | Type: Application | PCID required: Yes
activetrail_management_create_content_category
Create a new content category
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
description | string | No | — | Category description |
name | string | Yes | — | Category name |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"description": {
"type": "string",
"description": "Category description"
},
"name": {
"type": "string",
"description": "Category name"
}
},
"required": [
"PCID",
"name"
]
}
activetrail_management_create_webhook
Create a new webhook
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
eventType | string | Yes | — | Event type to listen for |
state | string | No | — | Webhook state |
url | string | Yes | — | Webhook callback URL |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"eventType": {
"type": "string",
"description": "Event type to listen for"
},
"state": {
"type": "string",
"description": "Webhook state"
},
"url": {
"type": "string",
"description": "Webhook callback URL"
}
},
"required": [
"PCID",
"eventType",
"url"
]
}
activetrail_management_delete_content_category
Delete a content category by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Category ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Category ID"
}
},
"required": [
"PCID",
"id"
]
}
activetrail_management_delete_webhook
Delete a webhook
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Webhook ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Webhook ID"
}
},
"required": [
"PCID",
"id"
]
}
activetrail_management_get_account_balance
Get email and SMS credit balance
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
activetrail_management_get_automation
Get automation details by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Automation ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Automation ID"
}
},
"required": [
"PCID",
"id"
]
}
activetrail_management_get_automation_activation
Get automation activation status
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Automation ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Automation ID"
}
},
"required": [
"PCID",
"id"
]
}
Get contacts that finished an automation
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Automation ID |
FromDate | string | No | — | Start date for filtering (inclusive) |
ToDate | string | No | — | End date for filtering (inclusive) |
Filter | string | No | — | The filter value |
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": "Automation ID"
},
"FromDate": {
"type": "string",
"description": "Start date for filtering (inclusive)"
},
"ToDate": {
"type": "string",
"description": "End date for filtering (inclusive)"
},
"Filter": {
"type": "string",
"description": "The filter value"
},
"Page": {
"type": "integer",
"description": "Page number for pagination"
},
"Limit": {
"type": "integer",
"description": "Maximum number of results to return"
}
},
"required": [
"PCID",
"id"
]
}
Get contacts that started an automation
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Automation ID |
FromDate | string | No | — | Start date for filtering (inclusive) |
ToDate | string | No | — | End date for filtering (inclusive) |
Filter | string | No | — | The filter value |
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": "Automation ID"
},
"FromDate": {
"type": "string",
"description": "Start date for filtering (inclusive)"
},
"ToDate": {
"type": "string",
"description": "End date for filtering (inclusive)"
},
"Filter": {
"type": "string",
"description": "The filter value"
},
"Page": {
"type": "integer",
"description": "Page number for pagination"
},
"Limit": {
"type": "integer",
"description": "Maximum number of results to return"
}
},
"required": [
"PCID",
"id"
]
}
activetrail_management_get_automation_design
Get complete automation design
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Automation ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Automation ID"
}
},
"required": [
"PCID",
"id"
]
}
activetrail_management_get_automation_overview_report
Get summary report for an automation
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Automation ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Automation ID"
}
},
"required": [
"PCID",
"id"
]
}
activetrail_management_get_automation_trigger_info
Get automation trigger information
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Automation ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Automation ID"
}
},
"required": [
"PCID",
"id"
]
}
Get account contact fields filtered by type
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
FieldsType | string | No | — | Type of fields to filter |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"FieldsType": {
"type": "string",
"description": "Type of fields to filter"
}
},
"required": [
"PCID"
]
}
Get daily contact growth metrics (active/inactive)
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
FromDate | string | No | — | Start date |
ToDate | string | No | — | End date (default 3 months back) |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"FromDate": {
"type": "string",
"description": "Start date"
},
"ToDate": {
"type": "string",
"description": "End date (default 3 months back)"
}
},
"required": [
"PCID"
]
}
activetrail_management_get_content_category
Get a specific content category by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Category ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Category ID"
}
},
"required": [
"PCID",
"id"
]
}
activetrail_management_get_executive_report
Get executive-level account reports
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
activetrail_management_get_sending_profiles
Get email sending profiles configured for account
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
activetrail_management_get_sms_sending_profiles
Get SMS sending profiles for account
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
activetrail_management_get_webhook
Get a specific webhook by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Webhook ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Webhook ID"
}
},
"required": [
"PCID",
"id"
]
}
activetrail_management_list_automations
Get account automations
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
StateType | string | No | — | Filter by state |
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"
},
"StateType": {
"type": "string",
"description": "Filter by state"
},
"Page": {
"type": "integer",
"description": "Page number for pagination"
},
"Limit": {
"type": "integer",
"description": "Maximum number of results to return"
}
},
"required": [
"PCID"
]
}
activetrail_management_list_content_categories
Get all account content categories
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
activetrail_management_list_webhooks
Get account webhooks
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
EventType | string | No | — | Event Type |
StateType | string | No | — | State Type |
TargetType | string | No | — | Target Type |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"EventType": {
"type": "string",
"description": "Event Type"
},
"StateType": {
"type": "string",
"description": "State Type"
},
"TargetType": {
"type": "string",
"description": "Target Type"
}
},
"required": [
"PCID"
]
}
activetrail_management_update_automation_activation
Activate or deactivate an automation
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Automation ID |
active | boolean | Yes | — | Whether the automation should be active |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Automation ID"
},
"active": {
"type": "boolean",
"description": "Whether the automation should be active"
}
},
"required": [
"PCID",
"id",
"active"
]
}
activetrail_management_update_content_category
Update a content category
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Category ID |
description | string | No | — | The description 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": "Category ID"
},
"description": {
"type": "string",
"description": "The description value"
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"PCID",
"id"
]
}
activetrail_management_update_webhook
Update a webhook
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Webhook ID |
eventType | string | No | — | Event Type |
state | string | No | — | The state value |
url | string | No | — | The url value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Webhook ID"
},
"eventType": {
"type": "string",
"description": "Event Type"
},
"state": {
"type": "string",
"description": "The state value"
},
"url": {
"type": "string",
"description": "The url value"
}
},
"required": [
"PCID",
"id"
]
}