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: /iterable | Type: Application | PCID required: Yes
| Tool | Description |
|---|
iterable_create_campaign | Create a new blast or triggered campaign from an existing template for messaging channels |
iterable_get_web_inapp_messages | Retrieve a user’s web in-app messages, both general and app-specific, including read status |
iterable_create_campaign
Create a new blast or triggered campaign from an existing template for messaging channels
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
name | string | Yes | — | Campaign name |
templateId | number | Yes | — | ID of the existing template to use |
listIds | number[] | Yes | — | Array of list IDs to target |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"name": {
"type": "string",
"description": "Campaign name"
},
"templateId": {
"type": "number",
"description": "ID of the existing template to use"
},
"listIds": {
"type": "array",
"items": {
"type": "number"
},
"description": "Array of list IDs to target"
}
},
"required": [
"PCID",
"name",
"templateId",
"listIds"
]
}
iterable_get_web_inapp_messages
Retrieve a user’s web in-app messages, both general and app-specific, including read status
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
email | string | Yes | — | User email to retrieve messages for |
count | number | No | 10 | Number of messages to retrieve (default: 10) |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"email": {
"type": "string",
"description": "User email to retrieve messages for"
},
"count": {
"type": "number",
"default": 10,
"description": "Number of messages to retrieve (default: 10)"
}
},
"required": [
"PCID",
"email"
]
}
