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-contacts | Type: Application | PCID required: Yes
Add a contact to a group
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Group ID |
contactId | string | Yes | — | Contact ID to add |
status | string | No | — | Subscription status |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Group ID"
},
"contactId": {
"type": "string",
"description": "Contact ID to add"
},
"status": {
"type": "string",
"description": "Subscription status"
}
},
"required": [
"PCID",
"id",
"contactId"
]
}
Add a member to a mailing list
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Mailing list ID |
contactId | string | Yes | — | Contact ID to add |
status | string | No | — | Subscription status |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Mailing list ID"
},
"contactId": {
"type": "string",
"description": "Contact ID to add"
},
"status": {
"type": "string",
"description": "Subscription status"
}
},
"required": [
"PCID",
"id",
"contactId"
]
}
Create a new contact
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
customFields | object | No | — | Custom field values |
email | string | No | — | Contact email address |
firstName | string | No | — | Contact first name |
lastName | string | No | — | Contact last name |
phone | string | No | — | Contact phone number |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customFields": {
"type": "object",
"description": "Custom field values"
},
"email": {
"type": "string",
"description": "Contact email address"
},
"firstName": {
"type": "string",
"description": "Contact first name"
},
"lastName": {
"type": "string",
"description": "Contact last name"
},
"phone": {
"type": "string",
"description": "Contact phone number"
}
},
"required": [
"PCID"
]
}
Create a new group
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
description | string | No | — | Group description |
name | string | Yes | — | Group name |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"description": {
"type": "string",
"description": "Group description"
},
"name": {
"type": "string",
"description": "Group name"
}
},
"required": [
"PCID",
"name"
]
}
Create a new mailing list
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
description | string | No | — | Mailing list description |
name | string | Yes | — | Mailing list name |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"description": {
"type": "string",
"description": "Mailing list description"
},
"name": {
"type": "string",
"description": "Mailing list name"
}
},
"required": [
"PCID",
"name"
]
}
Remove a contact from account
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Contact ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Contact ID"
}
},
"required": [
"PCID",
"id"
]
}
Delete a group
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Group ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Group ID"
}
},
"required": [
"PCID",
"id"
]
}
Delete a mailing list
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Mailing list ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Mailing list ID"
}
},
"required": [
"PCID",
"id"
]
}
Get individual contact details
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Contact ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Contact ID"
}
},
"required": [
"PCID",
"id"
]
}
Get contact activity on emails sent to them
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Contact ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Contact ID"
}
},
"required": [
"PCID",
"id"
]
}
Get groups membership for a contact
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Contact ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Contact ID"
}
},
"required": [
"PCID",
"id"
]
}
Get contact mailing list memberships
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Contact ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Contact ID"
}
},
"required": [
"PCID",
"id"
]
}
Get a specific group by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Group ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Group ID"
}
},
"required": [
"PCID",
"id"
]
}
Get a mailing list by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Mailing list ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Mailing list ID"
}
},
"required": [
"PCID",
"id"
]
}
Import contacts to a group (max 1000 per call)
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
contacts | object[] | Yes | — | Contact objects to import |
groupId | integer | Yes | — | Target group ID |
status | string | No | — | Subscription status for imported contacts |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contacts": {
"type": "array",
"items": {
"type": "object"
},
"description": "Contact objects to import"
},
"groupId": {
"type": "integer",
"description": "Target group ID"
},
"status": {
"type": "string",
"description": "Subscription status for imported contacts"
}
},
"required": [
"PCID",
"contacts",
"groupId"
]
}
Get contact subscription status and source
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
FromDate | string | No | — | Start date |
ToDate | string | No | — | End date |
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"
},
"ToDate": {
"type": "string",
"description": "End date"
},
"Page": {
"type": "integer",
"description": "Page number for pagination"
},
"Limit": {
"type": "integer",
"description": "Maximum number of results to return"
}
},
"required": [
"PCID"
]
}
Get account contacts list with filtering
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
CustomerStates | string | No | — | Filter by status: active, unsubscribed, bounced |
SearchTerm | string | No | — | Search criteria |
FromDate | string | No | — | Date range start |
ToDate | string | No | — | Date range end |
Page | integer | No | — | Pagination page number |
Limit | integer | No | — | Results per page |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"CustomerStates": {
"type": "string",
"description": "Filter by status: active, unsubscribed, bounced"
},
"SearchTerm": {
"type": "string",
"description": "Search criteria"
},
"FromDate": {
"type": "string",
"description": "Date range start"
},
"ToDate": {
"type": "string",
"description": "Date range end"
},
"Page": {
"type": "integer",
"description": "Pagination page number"
},
"Limit": {
"type": "integer",
"description": "Results per page"
}
},
"required": [
"PCID"
]
}
Get all group member contacts
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Group ID |
CustomerStates | string | No | — | Customer States |
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"
},
"id": {
"type": "integer",
"description": "Group ID"
},
"CustomerStates": {
"type": "string",
"description": "Customer States"
},
"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",
"id"
]
}
Get all account groups
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
SearchTerm | string | No | — | Group name filter |
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"
},
"SearchTerm": {
"type": "string",
"description": "Group name filter"
},
"Page": {
"type": "integer",
"description": "Page number for pagination"
},
"Limit": {
"type": "integer",
"description": "Maximum number of results to return"
}
},
"required": [
"PCID"
]
}
Get all mailing list members
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Mailing list ID |
CustomerStates | string | No | — | Customer States |
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": "Mailing list ID"
},
"CustomerStates": {
"type": "string",
"description": "Customer States"
},
"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"
]
}
Get account mailing lists
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
Get subscribed contacts with status source
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"
]
}
Get unsubscribed contacts with status source
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"
]
}
Remove a contact from a group
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Group ID |
memberId | string | Yes | — | Contact ID to remove |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Group ID"
},
"memberId": {
"type": "string",
"description": "Contact ID to remove"
}
},
"required": [
"PCID",
"id",
"memberId"
]
}
Remove a member from a mailing list
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Mailing list ID |
memberId | string | Yes | — | Contact ID to remove |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Mailing list ID"
},
"memberId": {
"type": "string",
"description": "Contact ID to remove"
}
},
"required": [
"PCID",
"id",
"memberId"
]
}
Update an existing contact
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Contact ID |
customFields | object | No | — | Custom Fields |
email | string | No | — | The email value |
firstName | string | No | — | First Name |
lastName | string | No | — | Last Name |
phone | string | No | — | The phone value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Contact ID"
},
"customFields": {
"type": "object",
"description": "Custom Fields"
},
"email": {
"type": "string",
"description": "The email value"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"phone": {
"type": "string",
"description": "The phone value"
}
},
"required": [
"PCID",
"id"
]
}
Update a group
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Group 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": "Group ID"
},
"description": {
"type": "string",
"description": "The description value"
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"PCID",
"id"
]
}