> ## 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.
# klaviyo-marketing
> Klaviyo Marketing - manage campaigns, flows, email templates, and performance reporting
**Server path:** `/klaviyo-marketing` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| --------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
| [`klaviyo_marketing_assign_template_to_campaign_message`](#klaviyo_marketing_assign_template_to_campaign_message) | Assign Template to Campaign Message |
| [`klaviyo_marketing_cancel_campaign_send`](#klaviyo_marketing_cancel_campaign_send) | Cancel Campaign Send |
| [`klaviyo_marketing_clone_template`](#klaviyo_marketing_clone_template) | Clone Template |
| [`klaviyo_marketing_create_campaign`](#klaviyo_marketing_create_campaign) | Create Campaign |
| [`klaviyo_marketing_create_campaign_clone`](#klaviyo_marketing_create_campaign_clone) | Create Campaign Clone |
| [`klaviyo_marketing_create_flow`](#klaviyo_marketing_create_flow) | Create Flow |
| [`klaviyo_marketing_create_template`](#klaviyo_marketing_create_template) | Create Template |
| [`klaviyo_marketing_delete_campaign`](#klaviyo_marketing_delete_campaign) | Delete Campaign |
| [`klaviyo_marketing_delete_flow`](#klaviyo_marketing_delete_flow) | Delete Flow |
| [`klaviyo_marketing_delete_template`](#klaviyo_marketing_delete_template) | Delete Template |
| [`klaviyo_marketing_get_actions_for_flow`](#klaviyo_marketing_get_actions_for_flow) | Get Actions for Flow |
| [`klaviyo_marketing_get_campaign`](#klaviyo_marketing_get_campaign) | Get Campaign |
| [`klaviyo_marketing_get_campaign_message`](#klaviyo_marketing_get_campaign_message) | Get Campaign Message |
| [`klaviyo_marketing_get_campaign_recipient_estimation`](#klaviyo_marketing_get_campaign_recipient_estimation) | Get Campaign Recipient Estimation |
| [`klaviyo_marketing_get_campaign_send_job`](#klaviyo_marketing_get_campaign_send_job) | Get Campaign Send Job |
| [`klaviyo_marketing_get_campaigns`](#klaviyo_marketing_get_campaigns) | Get Campaigns |
| [`klaviyo_marketing_get_flow`](#klaviyo_marketing_get_flow) | Get Flow |
| [`klaviyo_marketing_get_flow_action`](#klaviyo_marketing_get_flow_action) | Get Flow Action |
| [`klaviyo_marketing_get_flows`](#klaviyo_marketing_get_flows) | Get Flows |
| [`klaviyo_marketing_get_messages_for_campaign`](#klaviyo_marketing_get_messages_for_campaign) | Get Messages for Campaign |
| [`klaviyo_marketing_get_tags_for_campaign`](#klaviyo_marketing_get_tags_for_campaign) | Get Tags for Campaign |
| [`klaviyo_marketing_get_tags_for_flow`](#klaviyo_marketing_get_tags_for_flow) | Get Tags for Flow |
| [`klaviyo_marketing_get_template`](#klaviyo_marketing_get_template) | Get Template |
| [`klaviyo_marketing_get_templates`](#klaviyo_marketing_get_templates) | Get Templates |
| [`klaviyo_marketing_query_campaign_values`](#klaviyo_marketing_query_campaign_values) | Query Campaign Values |
| [`klaviyo_marketing_query_flow_series`](#klaviyo_marketing_query_flow_series) | Query Flow Series |
| [`klaviyo_marketing_query_flow_values`](#klaviyo_marketing_query_flow_values) | Query Flow Values |
| [`klaviyo_marketing_refresh_campaign_recipient_estimation`](#klaviyo_marketing_refresh_campaign_recipient_estimation) | Refresh Campaign Recipient Estimation |
| [`klaviyo_marketing_render_template`](#klaviyo_marketing_render_template) | Render Template |
| [`klaviyo_marketing_send_campaign`](#klaviyo_marketing_send_campaign) | Send Campaign |
| [`klaviyo_marketing_update_campaign`](#klaviyo_marketing_update_campaign) | Update Campaign |
| [`klaviyo_marketing_update_campaign_message`](#klaviyo_marketing_update_campaign_message) | Update Campaign Message |
| [`klaviyo_marketing_update_flow`](#klaviyo_marketing_update_flow) | Update Flow Status |
| [`klaviyo_marketing_update_flow_action`](#klaviyo_marketing_update_flow_action) | Update Flow Action |
| [`klaviyo_marketing_update_template`](#klaviyo_marketing_update_template) | Update Template |
***
## klaviyo\_marketing\_assign\_template\_to\_campaign\_message
Assign Template to Campaign Message
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
| `data` | object | Yes | — | The data value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"type": {
"type": "string",
"description": "The type value",
"enum": [
"campaign-message"
]
},
"id": {
"type": "string",
"description": "The message ID to be assigned to"
},
"relationships": {
"type": "object",
"description": "The relationships value"
}
},
"required": [
"type",
"id",
"relationships"
]
}
},
"required": [
"PCID",
"revision",
"data"
]
}
```
***
## klaviyo\_marketing\_cancel\_campaign\_send
Cancel Campaign Send
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------------------------------------------------ |
| `id` | string | Yes | — | The ID of the currently sending campaign to cancel or revert |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
| `data` | object | Yes | — | The data value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The ID of the currently sending campaign to cancel or revert"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"type": {
"type": "string",
"description": "The type value",
"enum": [
"campaign-send-job"
]
},
"id": {
"type": "string",
"description": "The ID of the currently sending campaign to cancel or revert"
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"id",
"attributes"
]
}
},
"required": [
"PCID",
"id",
"revision",
"data"
]
}
```
***
## klaviyo\_marketing\_clone\_template
Clone Template
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
| `data` | object | Yes | — | The data value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"type": {
"type": "string",
"description": "The type value",
"enum": [
"template"
]
},
"id": {
"type": "string",
"description": "The ID of template to be cloned"
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"id",
"attributes"
]
}
},
"required": [
"PCID",
"revision",
"data"
]
}
```
***
## klaviyo\_marketing\_create\_campaign
Create Campaign
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
| `data` | object | Yes | — | The data value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"type": {
"type": "string",
"description": "The type value",
"enum": [
"campaign"
]
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"PCID",
"revision",
"data"
]
}
```
***
## klaviyo\_marketing\_create\_campaign\_clone
Create Campaign Clone
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
| `data` | object | Yes | — | The data value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"type": {
"type": "string",
"description": "The type value",
"enum": [
"campaign"
]
},
"id": {
"type": "string",
"description": "The campaign ID to be cloned"
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"id",
"attributes"
]
}
},
"required": [
"PCID",
"revision",
"data"
]
}
```
***
## klaviyo\_marketing\_create\_flow
Create Flow
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------- |
| `additional-fields[flow]` | string\[] | No | — | Request additional fields not included by default in the response. Supported values: 'definition' |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
| `data` | object | Yes | — | The data value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"additional-fields[flow]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"definition"
]
},
"description": "Request additional fields not included by default in the response. Supported values: 'definition'"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"type": {
"type": "string",
"description": "The type value",
"enum": [
"flow"
]
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"PCID",
"revision",
"data"
]
}
```
***
## klaviyo\_marketing\_create\_template
Create Template
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
| `data` | object | Yes | — | The data value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"type": {
"type": "string",
"description": "The type value",
"enum": [
"template"
]
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"PCID",
"revision",
"data"
]
}
```
***
## klaviyo\_marketing\_delete\_campaign
Delete Campaign
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `id` | string | Yes | — | The campaign ID to be deleted |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The campaign ID to be deleted"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"id",
"revision"
]
}
```
***
## klaviyo\_marketing\_delete\_flow
Delete Flow
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `id` | string | Yes | — | ID of the Flow to delete. Ex: XVTP5Q |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "ID of the Flow to delete. Ex: XVTP5Q"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"id",
"revision"
]
}
```
***
## klaviyo\_marketing\_delete\_template
Delete Template
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `id` | string | Yes | — | The ID of template |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The ID of template"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"id",
"revision"
]
}
```
***
## klaviyo\_marketing\_get\_actions\_for\_flow
Get Actions for Flow
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | Yes | — | The id value |
| `fields[flow-action]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `filter` | string | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#filtering\<br\>Allowed](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#filtering\<br\>Allowed) field(s)/operator(s):\
`id`: `any`\
`action_type`: `any`, `equals`\
`status`: `equals`\
`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\
`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` |
| `page[cursor]` | string | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#pagination](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#pagination) |
| `page[size]` | integer | No | — | Default: 50. Min: 1. Max: 50. |
| `sort` | string | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sorting](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sorting) |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"fields[flow-action]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created",
"definition",
"definition.data",
"definition.data.action_output_filter",
"definition.data.action_output_filter.condition_groups",
"definition.data.branches",
"definition.data.current_experiment",
"definition.data.current_experiment.allocations",
"definition.data.current_experiment.automatic_winner_selection_settings",
"definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date",
"definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty",
"definition.data.current_experiment.automatic_winner_selection_settings.enabled",
"definition.data.current_experiment.id",
"definition.data.current_experiment.name",
"definition.data.current_experiment.started",
"definition.data.current_experiment.variations",
"definition.data.current_experiment.winner_metric",
"definition.data.delay_until_time",
"definition.data.delay_until_weekdays",
"definition.data.experiment_status",
"definition.data.list_id",
"definition.data.main_action",
"definition.data.main_action.data",
"definition.data.main_action.data.message",
"definition.data.main_action.data.message.add_info_link",
"definition.data.main_action.data.message.add_opt_out_language",
"definition.data.main_action.data.message.add_org_prefix",
"definition.data.main_action.data.message.add_tracking_params",
"definition.data.main_action.data.message.additional_filters",
"definition.data.main_action.data.message.additional_filters.condition_groups",
"definition.data.main_action.data.message.android_link",
"definition.data.main_action.data.message.badge",
"definition.data.main_action.data.message.badge_options",
"definition.data.main_action.data.message.badge_options.badge_config",
"definition.data.main_action.data.message.badge_options.set_from_property",
"definition.data.main_action.data.message.badge_options.value",
"definition.data.main_action.data.message.bcc_email",
"definition.data.main_action.data.message.body",
"definition.data.main_action.data.message.cc_email",
"definition.data.main_action.data.message.conversion_metric_id",
"definition.data.main_action.data.message.custom_tracking_params",
"definition.data.main_action.data.message.dynamic_image",
"definition.data.main_action.data.message.from_email",
"definition.data.main_action.data.message.from_label",
"definition.data.main_action.data.message.id",
"definition.data.main_action.data.message.image_id",
"definition.data.main_action.data.message.include_contact_card",
"definition.data.main_action.data.message.ios_link",
"definition.data.main_action.data.message.kv_pairs",
"definition.data.main_action.data.message.name",
"definition.data.main_action.data.message.on_open",
"definition.data.main_action.data.message.preview_text",
"definition.data.main_action.data.message.push_type",
"definition.data.main_action.data.message.reply_to_email",
"definition.data.main_action.data.message.shorten_links",
"definition.data.main_action.data.message.smart_sending_enabled",
"definition.data.main_action.data.message.sms_quiet_hours_enabled",
"definition.data.main_action.data.message.sound",
"definition.data.main_action.data.message.subject_line",
"definition.data.main_action.data.message.template_id",
"definition.data.main_action.data.message.title",
"definition.data.main_action.data.message.transactional",
"definition.data.main_action.data.message.video_asset_id",
"definition.data.main_action.data.status",
"definition.data.main_action.id",
"definition.data.main_action.links",
"definition.data.main_action.links.next",
"definition.data.main_action.temporary_id",
"definition.data.main_action.type",
"definition.data.message",
"definition.data.message.add_info_link",
"definition.data.message.add_opt_out_language",
"definition.data.message.add_org_prefix",
"definition.data.message.add_tracking_params",
"definition.data.message.additional_filters",
"definition.data.message.additional_filters.condition_groups",
"definition.data.message.android_link",
"definition.data.message.badge",
"definition.data.message.badge_options",
"definition.data.message.badge_options.badge_config",
"definition.data.message.badge_options.set_from_property",
"definition.data.message.badge_options.value",
"definition.data.message.bcc_email",
"definition.data.message.body",
"definition.data.message.cc_email",
"definition.data.message.conversion_metric_id",
"definition.data.message.custom_tracking_params",
"definition.data.message.dynamic_image",
"definition.data.message.from_email",
"definition.data.message.from_label",
"definition.data.message.headers",
"definition.data.message.id",
"definition.data.message.image_id",
"definition.data.message.include_contact_card",
"definition.data.message.ios_link",
"definition.data.message.kv_pairs",
"definition.data.message.name",
"definition.data.message.on_open",
"definition.data.message.preview_text",
"definition.data.message.push_type",
"definition.data.message.reply_to_email",
"definition.data.message.shorten_links",
"definition.data.message.smart_sending_enabled",
"definition.data.message.sms_quiet_hours_enabled",
"definition.data.message.sound",
"definition.data.message.subject_line",
"definition.data.message.template_id",
"definition.data.message.title",
"definition.data.message.to_emails",
"definition.data.message.transactional",
"definition.data.message.url",
"definition.data.message.vendor_id",
"definition.data.message.video_asset_id",
"definition.data.name",
"definition.data.on_execution",
"definition.data.profile_filter",
"definition.data.profile_filter.condition_groups",
"definition.data.profile_operations",
"definition.data.secondary_value",
"definition.data.service_configuration",
"definition.data.service_configuration.event_key",
"definition.data.service_configuration.event_payload",
"definition.data.service_configuration.report_id",
"definition.data.service_configuration.service_method_type",
"definition.data.service_configuration.tracking_company_id",
"definition.data.status",
"definition.data.target_days",
"definition.data.target_time",
"definition.data.timezone",
"definition.data.trigger_filter",
"definition.data.trigger_filter.condition_groups",
"definition.data.trigger_id",
"definition.data.trigger_subtype",
"definition.data.trigger_type",
"definition.data.unit",
"definition.data.value",
"definition.id",
"definition.links",
"definition.links.next",
"definition.links.next_if_false",
"definition.links.next_if_true",
"definition.temporary_id",
"definition.type",
"updated"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"filter": {
"type": "string",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`id`: `any`
`action_type`: `any`, `equals`
`status`: `equals`
`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`"
},
"page[cursor]": {
"type": "string",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#pagination"
},
"page[size]": {
"type": "integer",
"description": "Default: 50. Min: 1. Max: 50."
},
"sort": {
"type": "string",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sorting",
"enum": [
"action_type",
"-action_type",
"created",
"-created",
"id",
"-id",
"status",
"-status",
"updated",
"-updated"
]
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"id",
"revision"
]
}
```
***
## klaviyo\_marketing\_get\_campaign
Get Campaign
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | Yes | — | The campaign ID to be retrieved |
| `fields[campaign-message]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `fields[campaign]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `fields[tag]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `include` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships) |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The campaign ID to be retrieved"
},
"fields[campaign-message]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created_at",
"definition",
"definition.channel",
"definition.content",
"definition.content.bcc_email",
"definition.content.body",
"definition.content.cc_email",
"definition.content.dynamic_image",
"definition.content.from_email",
"definition.content.from_label",
"definition.content.media_url",
"definition.content.preview_text",
"definition.content.reply_to_email",
"definition.content.subject",
"definition.content.title",
"definition.kv_pairs",
"definition.label",
"definition.notification_type",
"definition.options",
"definition.options.badge",
"definition.options.badge.badge_options",
"definition.options.badge.badge_options.badge_config",
"definition.options.badge.badge_options.set_from_property",
"definition.options.badge.badge_options.value",
"definition.options.badge.display",
"definition.options.on_open",
"definition.options.on_open.android_deep_link",
"definition.options.on_open.ios_deep_link",
"definition.options.on_open.type",
"definition.options.play_sound",
"definition.render_options",
"definition.render_options.add_info_link",
"definition.render_options.add_opt_out_language",
"definition.render_options.add_org_prefix",
"definition.render_options.shorten_links",
"send_times",
"updated_at"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"fields[campaign]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"archived",
"audiences",
"audiences.excluded",
"audiences.included",
"created_at",
"name",
"scheduled_at",
"send_options",
"send_options.use_smart_sending",
"send_strategy",
"send_strategy.date",
"send_strategy.datetime",
"send_strategy.method",
"send_strategy.options",
"send_strategy.options.is_local",
"send_strategy.options.send_past_recipients_immediately",
"send_strategy.throttle_percentage",
"send_time",
"status",
"tracking_options",
"tracking_options.add_tracking_params",
"tracking_options.custom_tracking_params",
"tracking_options.is_tracking_clicks",
"tracking_options.is_tracking_opens",
"updated_at"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"fields[tag]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"name"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"campaign-messages",
"tags"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"id",
"revision"
]
}
```
***
## klaviyo\_marketing\_get\_campaign\_message
Get Campaign Message
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | Yes | — | The message ID to be retrieved |
| `fields[campaign-message]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `fields[campaign]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `fields[image]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `fields[template]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `include` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships) |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The message ID to be retrieved"
},
"fields[campaign-message]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created_at",
"definition",
"definition.channel",
"definition.content",
"definition.content.bcc_email",
"definition.content.body",
"definition.content.cc_email",
"definition.content.dynamic_image",
"definition.content.from_email",
"definition.content.from_label",
"definition.content.media_url",
"definition.content.preview_text",
"definition.content.reply_to_email",
"definition.content.subject",
"definition.content.title",
"definition.kv_pairs",
"definition.label",
"definition.notification_type",
"definition.options",
"definition.options.badge",
"definition.options.badge.badge_options",
"definition.options.badge.badge_options.badge_config",
"definition.options.badge.badge_options.set_from_property",
"definition.options.badge.badge_options.value",
"definition.options.badge.display",
"definition.options.on_open",
"definition.options.on_open.android_deep_link",
"definition.options.on_open.ios_deep_link",
"definition.options.on_open.type",
"definition.options.play_sound",
"definition.render_options",
"definition.render_options.add_info_link",
"definition.render_options.add_opt_out_language",
"definition.render_options.add_org_prefix",
"definition.render_options.shorten_links",
"send_times",
"updated_at"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"fields[campaign]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"archived",
"audiences",
"audiences.excluded",
"audiences.included",
"created_at",
"name",
"scheduled_at",
"send_options",
"send_options.use_smart_sending",
"send_strategy",
"send_strategy.date",
"send_strategy.datetime",
"send_strategy.method",
"send_strategy.options",
"send_strategy.options.is_local",
"send_strategy.options.send_past_recipients_immediately",
"send_strategy.throttle_percentage",
"send_time",
"status",
"tracking_options",
"tracking_options.add_tracking_params",
"tracking_options.custom_tracking_params",
"tracking_options.is_tracking_clicks",
"tracking_options.is_tracking_opens",
"updated_at"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"fields[image]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"format",
"hidden",
"image_url",
"name",
"size",
"updated_at"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"fields[template]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"amp",
"created",
"editor_type",
"html",
"name",
"text",
"updated"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"campaign",
"image",
"template"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"id",
"revision"
]
}
```
***
## klaviyo\_marketing\_get\_campaign\_recipient\_estimation
Get Campaign Recipient Estimation
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | Yes | — | The ID of the campaign for which to get the estimated number of recipients |
| `fields[campaign-recipient-estimation]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The ID of the campaign for which to get the estimated number of recipients"
},
"fields[campaign-recipient-estimation]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"estimated_recipient_count"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"id",
"revision"
]
}
```
***
## klaviyo\_marketing\_get\_campaign\_send\_job
Get Campaign Send Job
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | Yes | — | The ID of the campaign to send |
| `fields[campaign-send-job]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The ID of the campaign to send"
},
"fields[campaign-send-job]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"status"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"id",
"revision"
]
}
```
***
## klaviyo\_marketing\_get\_campaigns
Get Campaigns
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `fields[campaign-message]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `fields[campaign]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `fields[tag]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `filter` | string | Yes | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#filtering\<br\>Allowed](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#filtering\<br\>Allowed) field(s)/operator(s):\
`id`: `any`\
`messages.channel`: `equals`\
`name`: `contains`\
`status`: `any`, `equals`\
`archived`: `equals`\
`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\
`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\
`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` |
| `include` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships) |
| `page[cursor]` | string | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#pagination](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#pagination) |
| `sort` | string | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sorting](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sorting) |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields[campaign-message]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created_at",
"definition",
"definition.channel",
"definition.content",
"definition.content.bcc_email",
"definition.content.body",
"definition.content.cc_email",
"definition.content.dynamic_image",
"definition.content.from_email",
"definition.content.from_label",
"definition.content.media_url",
"definition.content.preview_text",
"definition.content.reply_to_email",
"definition.content.subject",
"definition.content.title",
"definition.kv_pairs",
"definition.label",
"definition.notification_type",
"definition.options",
"definition.options.badge",
"definition.options.badge.badge_options",
"definition.options.badge.badge_options.badge_config",
"definition.options.badge.badge_options.set_from_property",
"definition.options.badge.badge_options.value",
"definition.options.badge.display",
"definition.options.on_open",
"definition.options.on_open.android_deep_link",
"definition.options.on_open.ios_deep_link",
"definition.options.on_open.type",
"definition.options.play_sound",
"definition.render_options",
"definition.render_options.add_info_link",
"definition.render_options.add_opt_out_language",
"definition.render_options.add_org_prefix",
"definition.render_options.shorten_links",
"send_times",
"updated_at"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"fields[campaign]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"archived",
"audiences",
"audiences.excluded",
"audiences.included",
"created_at",
"name",
"scheduled_at",
"send_options",
"send_options.use_smart_sending",
"send_strategy",
"send_strategy.date",
"send_strategy.datetime",
"send_strategy.method",
"send_strategy.options",
"send_strategy.options.is_local",
"send_strategy.options.send_past_recipients_immediately",
"send_strategy.throttle_percentage",
"send_time",
"status",
"tracking_options",
"tracking_options.add_tracking_params",
"tracking_options.custom_tracking_params",
"tracking_options.is_tracking_clicks",
"tracking_options.is_tracking_opens",
"updated_at"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"fields[tag]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"name"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"filter": {
"type": "string",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`id`: `any`
`messages.channel`: `equals`
`name`: `contains`
`status`: `any`, `equals`
`archived`: `equals`
`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`"
},
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"campaign-messages",
"tags"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships"
},
"page[cursor]": {
"type": "string",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#pagination"
},
"sort": {
"type": "string",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sorting",
"enum": [
"created_at",
"-created_at",
"id",
"-id",
"name",
"-name",
"scheduled_at",
"-scheduled_at",
"updated_at",
"-updated_at"
]
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"filter",
"revision"
]
}
```
***
## klaviyo\_marketing\_get\_flow
Get Flow
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | Yes | — | The id value |
| `additional-fields[flow]` | string\[] | No | — | Request additional fields not included by default in the response. Supported values: 'definition' |
| `fields[flow-action]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `fields[flow]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `fields[tag]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `include` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships) |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"additional-fields[flow]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"definition"
]
},
"description": "Request additional fields not included by default in the response. Supported values: 'definition'"
},
"fields[flow-action]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created",
"definition",
"definition.data",
"definition.data.action_output_filter",
"definition.data.action_output_filter.condition_groups",
"definition.data.branches",
"definition.data.current_experiment",
"definition.data.current_experiment.allocations",
"definition.data.current_experiment.automatic_winner_selection_settings",
"definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date",
"definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty",
"definition.data.current_experiment.automatic_winner_selection_settings.enabled",
"definition.data.current_experiment.id",
"definition.data.current_experiment.name",
"definition.data.current_experiment.started",
"definition.data.current_experiment.variations",
"definition.data.current_experiment.winner_metric",
"definition.data.delay_until_time",
"definition.data.delay_until_weekdays",
"definition.data.experiment_status",
"definition.data.list_id",
"definition.data.main_action",
"definition.data.main_action.data",
"definition.data.main_action.data.message",
"definition.data.main_action.data.message.add_info_link",
"definition.data.main_action.data.message.add_opt_out_language",
"definition.data.main_action.data.message.add_org_prefix",
"definition.data.main_action.data.message.add_tracking_params",
"definition.data.main_action.data.message.additional_filters",
"definition.data.main_action.data.message.additional_filters.condition_groups",
"definition.data.main_action.data.message.android_link",
"definition.data.main_action.data.message.badge",
"definition.data.main_action.data.message.badge_options",
"definition.data.main_action.data.message.badge_options.badge_config",
"definition.data.main_action.data.message.badge_options.set_from_property",
"definition.data.main_action.data.message.badge_options.value",
"definition.data.main_action.data.message.bcc_email",
"definition.data.main_action.data.message.body",
"definition.data.main_action.data.message.cc_email",
"definition.data.main_action.data.message.conversion_metric_id",
"definition.data.main_action.data.message.custom_tracking_params",
"definition.data.main_action.data.message.dynamic_image",
"definition.data.main_action.data.message.from_email",
"definition.data.main_action.data.message.from_label",
"definition.data.main_action.data.message.id",
"definition.data.main_action.data.message.image_id",
"definition.data.main_action.data.message.include_contact_card",
"definition.data.main_action.data.message.ios_link",
"definition.data.main_action.data.message.kv_pairs",
"definition.data.main_action.data.message.name",
"definition.data.main_action.data.message.on_open",
"definition.data.main_action.data.message.preview_text",
"definition.data.main_action.data.message.push_type",
"definition.data.main_action.data.message.reply_to_email",
"definition.data.main_action.data.message.shorten_links",
"definition.data.main_action.data.message.smart_sending_enabled",
"definition.data.main_action.data.message.sms_quiet_hours_enabled",
"definition.data.main_action.data.message.sound",
"definition.data.main_action.data.message.subject_line",
"definition.data.main_action.data.message.template_id",
"definition.data.main_action.data.message.title",
"definition.data.main_action.data.message.transactional",
"definition.data.main_action.data.message.video_asset_id",
"definition.data.main_action.data.status",
"definition.data.main_action.id",
"definition.data.main_action.links",
"definition.data.main_action.links.next",
"definition.data.main_action.temporary_id",
"definition.data.main_action.type",
"definition.data.message",
"definition.data.message.add_info_link",
"definition.data.message.add_opt_out_language",
"definition.data.message.add_org_prefix",
"definition.data.message.add_tracking_params",
"definition.data.message.additional_filters",
"definition.data.message.additional_filters.condition_groups",
"definition.data.message.android_link",
"definition.data.message.badge",
"definition.data.message.badge_options",
"definition.data.message.badge_options.badge_config",
"definition.data.message.badge_options.set_from_property",
"definition.data.message.badge_options.value",
"definition.data.message.bcc_email",
"definition.data.message.body",
"definition.data.message.cc_email",
"definition.data.message.conversion_metric_id",
"definition.data.message.custom_tracking_params",
"definition.data.message.dynamic_image",
"definition.data.message.from_email",
"definition.data.message.from_label",
"definition.data.message.headers",
"definition.data.message.id",
"definition.data.message.image_id",
"definition.data.message.include_contact_card",
"definition.data.message.ios_link",
"definition.data.message.kv_pairs",
"definition.data.message.name",
"definition.data.message.on_open",
"definition.data.message.preview_text",
"definition.data.message.push_type",
"definition.data.message.reply_to_email",
"definition.data.message.shorten_links",
"definition.data.message.smart_sending_enabled",
"definition.data.message.sms_quiet_hours_enabled",
"definition.data.message.sound",
"definition.data.message.subject_line",
"definition.data.message.template_id",
"definition.data.message.title",
"definition.data.message.to_emails",
"definition.data.message.transactional",
"definition.data.message.url",
"definition.data.message.vendor_id",
"definition.data.message.video_asset_id",
"definition.data.name",
"definition.data.on_execution",
"definition.data.profile_filter",
"definition.data.profile_filter.condition_groups",
"definition.data.profile_operations",
"definition.data.secondary_value",
"definition.data.service_configuration",
"definition.data.service_configuration.event_key",
"definition.data.service_configuration.event_payload",
"definition.data.service_configuration.report_id",
"definition.data.service_configuration.service_method_type",
"definition.data.service_configuration.tracking_company_id",
"definition.data.status",
"definition.data.target_days",
"definition.data.target_time",
"definition.data.timezone",
"definition.data.trigger_filter",
"definition.data.trigger_filter.condition_groups",
"definition.data.trigger_id",
"definition.data.trigger_subtype",
"definition.data.trigger_type",
"definition.data.unit",
"definition.data.value",
"definition.id",
"definition.links",
"definition.links.next",
"definition.links.next_if_false",
"definition.links.next_if_true",
"definition.temporary_id",
"definition.type",
"updated"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"fields[flow]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"archived",
"created",
"definition",
"definition.actions",
"definition.entry_action_id",
"definition.profile_filter",
"definition.profile_filter.condition_groups",
"definition.reentry_criteria",
"definition.reentry_criteria.duration",
"definition.reentry_criteria.unit",
"definition.triggers",
"name",
"status",
"trigger_type",
"updated"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"fields[tag]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"name"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"flow-actions",
"tags"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"id",
"revision"
]
}
```
***
## klaviyo\_marketing\_get\_flow\_action
Get Flow Action
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | Yes | — | The id value |
| `fields[flow-action]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `fields[flow-message]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `fields[flow]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `include` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships) |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"fields[flow-action]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created",
"definition",
"definition.data",
"definition.data.action_output_filter",
"definition.data.action_output_filter.condition_groups",
"definition.data.branches",
"definition.data.current_experiment",
"definition.data.current_experiment.allocations",
"definition.data.current_experiment.automatic_winner_selection_settings",
"definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date",
"definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty",
"definition.data.current_experiment.automatic_winner_selection_settings.enabled",
"definition.data.current_experiment.id",
"definition.data.current_experiment.name",
"definition.data.current_experiment.started",
"definition.data.current_experiment.variations",
"definition.data.current_experiment.winner_metric",
"definition.data.delay_until_time",
"definition.data.delay_until_weekdays",
"definition.data.experiment_status",
"definition.data.list_id",
"definition.data.main_action",
"definition.data.main_action.data",
"definition.data.main_action.data.message",
"definition.data.main_action.data.message.add_info_link",
"definition.data.main_action.data.message.add_opt_out_language",
"definition.data.main_action.data.message.add_org_prefix",
"definition.data.main_action.data.message.add_tracking_params",
"definition.data.main_action.data.message.additional_filters",
"definition.data.main_action.data.message.additional_filters.condition_groups",
"definition.data.main_action.data.message.android_link",
"definition.data.main_action.data.message.badge",
"definition.data.main_action.data.message.badge_options",
"definition.data.main_action.data.message.badge_options.badge_config",
"definition.data.main_action.data.message.badge_options.set_from_property",
"definition.data.main_action.data.message.badge_options.value",
"definition.data.main_action.data.message.bcc_email",
"definition.data.main_action.data.message.body",
"definition.data.main_action.data.message.cc_email",
"definition.data.main_action.data.message.conversion_metric_id",
"definition.data.main_action.data.message.custom_tracking_params",
"definition.data.main_action.data.message.dynamic_image",
"definition.data.main_action.data.message.from_email",
"definition.data.main_action.data.message.from_label",
"definition.data.main_action.data.message.id",
"definition.data.main_action.data.message.image_id",
"definition.data.main_action.data.message.include_contact_card",
"definition.data.main_action.data.message.ios_link",
"definition.data.main_action.data.message.kv_pairs",
"definition.data.main_action.data.message.name",
"definition.data.main_action.data.message.on_open",
"definition.data.main_action.data.message.preview_text",
"definition.data.main_action.data.message.push_type",
"definition.data.main_action.data.message.reply_to_email",
"definition.data.main_action.data.message.shorten_links",
"definition.data.main_action.data.message.smart_sending_enabled",
"definition.data.main_action.data.message.sms_quiet_hours_enabled",
"definition.data.main_action.data.message.sound",
"definition.data.main_action.data.message.subject_line",
"definition.data.main_action.data.message.template_id",
"definition.data.main_action.data.message.title",
"definition.data.main_action.data.message.transactional",
"definition.data.main_action.data.message.video_asset_id",
"definition.data.main_action.data.status",
"definition.data.main_action.id",
"definition.data.main_action.links",
"definition.data.main_action.links.next",
"definition.data.main_action.temporary_id",
"definition.data.main_action.type",
"definition.data.message",
"definition.data.message.add_info_link",
"definition.data.message.add_opt_out_language",
"definition.data.message.add_org_prefix",
"definition.data.message.add_tracking_params",
"definition.data.message.additional_filters",
"definition.data.message.additional_filters.condition_groups",
"definition.data.message.android_link",
"definition.data.message.badge",
"definition.data.message.badge_options",
"definition.data.message.badge_options.badge_config",
"definition.data.message.badge_options.set_from_property",
"definition.data.message.badge_options.value",
"definition.data.message.bcc_email",
"definition.data.message.body",
"definition.data.message.cc_email",
"definition.data.message.conversion_metric_id",
"definition.data.message.custom_tracking_params",
"definition.data.message.dynamic_image",
"definition.data.message.from_email",
"definition.data.message.from_label",
"definition.data.message.headers",
"definition.data.message.id",
"definition.data.message.image_id",
"definition.data.message.include_contact_card",
"definition.data.message.ios_link",
"definition.data.message.kv_pairs",
"definition.data.message.name",
"definition.data.message.on_open",
"definition.data.message.preview_text",
"definition.data.message.push_type",
"definition.data.message.reply_to_email",
"definition.data.message.shorten_links",
"definition.data.message.smart_sending_enabled",
"definition.data.message.sms_quiet_hours_enabled",
"definition.data.message.sound",
"definition.data.message.subject_line",
"definition.data.message.template_id",
"definition.data.message.title",
"definition.data.message.to_emails",
"definition.data.message.transactional",
"definition.data.message.url",
"definition.data.message.vendor_id",
"definition.data.message.video_asset_id",
"definition.data.name",
"definition.data.on_execution",
"definition.data.profile_filter",
"definition.data.profile_filter.condition_groups",
"definition.data.profile_operations",
"definition.data.secondary_value",
"definition.data.service_configuration",
"definition.data.service_configuration.event_key",
"definition.data.service_configuration.event_payload",
"definition.data.service_configuration.report_id",
"definition.data.service_configuration.service_method_type",
"definition.data.service_configuration.tracking_company_id",
"definition.data.status",
"definition.data.target_days",
"definition.data.target_time",
"definition.data.timezone",
"definition.data.trigger_filter",
"definition.data.trigger_filter.condition_groups",
"definition.data.trigger_id",
"definition.data.trigger_subtype",
"definition.data.trigger_type",
"definition.data.unit",
"definition.data.value",
"definition.id",
"definition.links",
"definition.links.next",
"definition.links.next_if_false",
"definition.links.next_if_true",
"definition.temporary_id",
"definition.type",
"updated"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"fields[flow-message]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"channel",
"created",
"definition",
"definition.add_info_link",
"definition.add_opt_out_language",
"definition.add_org_prefix",
"definition.add_tracking_params",
"definition.additional_filters",
"definition.additional_filters.condition_groups",
"definition.android_link",
"definition.badge",
"definition.badge_options",
"definition.badge_options.badge_config",
"definition.badge_options.set_from_property",
"definition.badge_options.value",
"definition.bcc_email",
"definition.body",
"definition.cc_email",
"definition.conversion_metric_id",
"definition.custom_tracking_params",
"definition.dynamic_image",
"definition.from_email",
"definition.from_label",
"definition.headers",
"definition.id",
"definition.image_id",
"definition.include_contact_card",
"definition.ios_link",
"definition.kv_pairs",
"definition.name",
"definition.on_open",
"definition.preview_text",
"definition.push_type",
"definition.reply_to_email",
"definition.shorten_links",
"definition.smart_sending_enabled",
"definition.sms_quiet_hours_enabled",
"definition.sound",
"definition.subject_line",
"definition.template_id",
"definition.title",
"definition.to_emails",
"definition.transactional",
"definition.url",
"definition.vendor_id",
"definition.video_asset_id",
"updated"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"fields[flow]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"archived",
"created",
"name",
"status",
"trigger_type",
"updated"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"flow",
"flow-messages"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"id",
"revision"
]
}
```
***
## klaviyo\_marketing\_get\_flows
Get Flows
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `fields[flow-action]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `fields[flow]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `fields[tag]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `filter` | string | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#filtering\<br\>Allowed](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#filtering\<br\>Allowed) field(s)/operator(s):\
`id`: `any`\
`name`: `contains`, `ends-with`, `equals`, `starts-with`\
`status`: `equals`\
`archived`: `equals`\
`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\
`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\
`trigger_type`: `equals` |
| `include` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships) |
| `page[cursor]` | string | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#pagination](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#pagination) |
| `page[size]` | integer | No | — | Default: 50. Min: 1. Max: 50. |
| `sort` | string | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sorting](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sorting) |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields[flow-action]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created",
"definition",
"definition.data",
"definition.data.action_output_filter",
"definition.data.action_output_filter.condition_groups",
"definition.data.branches",
"definition.data.current_experiment",
"definition.data.current_experiment.allocations",
"definition.data.current_experiment.automatic_winner_selection_settings",
"definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date",
"definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty",
"definition.data.current_experiment.automatic_winner_selection_settings.enabled",
"definition.data.current_experiment.id",
"definition.data.current_experiment.name",
"definition.data.current_experiment.started",
"definition.data.current_experiment.variations",
"definition.data.current_experiment.winner_metric",
"definition.data.delay_until_time",
"definition.data.delay_until_weekdays",
"definition.data.experiment_status",
"definition.data.list_id",
"definition.data.main_action",
"definition.data.main_action.data",
"definition.data.main_action.data.message",
"definition.data.main_action.data.message.add_info_link",
"definition.data.main_action.data.message.add_opt_out_language",
"definition.data.main_action.data.message.add_org_prefix",
"definition.data.main_action.data.message.add_tracking_params",
"definition.data.main_action.data.message.additional_filters",
"definition.data.main_action.data.message.additional_filters.condition_groups",
"definition.data.main_action.data.message.android_link",
"definition.data.main_action.data.message.badge",
"definition.data.main_action.data.message.badge_options",
"definition.data.main_action.data.message.badge_options.badge_config",
"definition.data.main_action.data.message.badge_options.set_from_property",
"definition.data.main_action.data.message.badge_options.value",
"definition.data.main_action.data.message.bcc_email",
"definition.data.main_action.data.message.body",
"definition.data.main_action.data.message.cc_email",
"definition.data.main_action.data.message.conversion_metric_id",
"definition.data.main_action.data.message.custom_tracking_params",
"definition.data.main_action.data.message.dynamic_image",
"definition.data.main_action.data.message.from_email",
"definition.data.main_action.data.message.from_label",
"definition.data.main_action.data.message.id",
"definition.data.main_action.data.message.image_id",
"definition.data.main_action.data.message.include_contact_card",
"definition.data.main_action.data.message.ios_link",
"definition.data.main_action.data.message.kv_pairs",
"definition.data.main_action.data.message.name",
"definition.data.main_action.data.message.on_open",
"definition.data.main_action.data.message.preview_text",
"definition.data.main_action.data.message.push_type",
"definition.data.main_action.data.message.reply_to_email",
"definition.data.main_action.data.message.shorten_links",
"definition.data.main_action.data.message.smart_sending_enabled",
"definition.data.main_action.data.message.sms_quiet_hours_enabled",
"definition.data.main_action.data.message.sound",
"definition.data.main_action.data.message.subject_line",
"definition.data.main_action.data.message.template_id",
"definition.data.main_action.data.message.title",
"definition.data.main_action.data.message.transactional",
"definition.data.main_action.data.message.video_asset_id",
"definition.data.main_action.data.status",
"definition.data.main_action.id",
"definition.data.main_action.links",
"definition.data.main_action.links.next",
"definition.data.main_action.temporary_id",
"definition.data.main_action.type",
"definition.data.message",
"definition.data.message.add_info_link",
"definition.data.message.add_opt_out_language",
"definition.data.message.add_org_prefix",
"definition.data.message.add_tracking_params",
"definition.data.message.additional_filters",
"definition.data.message.additional_filters.condition_groups",
"definition.data.message.android_link",
"definition.data.message.badge",
"definition.data.message.badge_options",
"definition.data.message.badge_options.badge_config",
"definition.data.message.badge_options.set_from_property",
"definition.data.message.badge_options.value",
"definition.data.message.bcc_email",
"definition.data.message.body",
"definition.data.message.cc_email",
"definition.data.message.conversion_metric_id",
"definition.data.message.custom_tracking_params",
"definition.data.message.dynamic_image",
"definition.data.message.from_email",
"definition.data.message.from_label",
"definition.data.message.headers",
"definition.data.message.id",
"definition.data.message.image_id",
"definition.data.message.include_contact_card",
"definition.data.message.ios_link",
"definition.data.message.kv_pairs",
"definition.data.message.name",
"definition.data.message.on_open",
"definition.data.message.preview_text",
"definition.data.message.push_type",
"definition.data.message.reply_to_email",
"definition.data.message.shorten_links",
"definition.data.message.smart_sending_enabled",
"definition.data.message.sms_quiet_hours_enabled",
"definition.data.message.sound",
"definition.data.message.subject_line",
"definition.data.message.template_id",
"definition.data.message.title",
"definition.data.message.to_emails",
"definition.data.message.transactional",
"definition.data.message.url",
"definition.data.message.vendor_id",
"definition.data.message.video_asset_id",
"definition.data.name",
"definition.data.on_execution",
"definition.data.profile_filter",
"definition.data.profile_filter.condition_groups",
"definition.data.profile_operations",
"definition.data.secondary_value",
"definition.data.service_configuration",
"definition.data.service_configuration.event_key",
"definition.data.service_configuration.event_payload",
"definition.data.service_configuration.report_id",
"definition.data.service_configuration.service_method_type",
"definition.data.service_configuration.tracking_company_id",
"definition.data.status",
"definition.data.target_days",
"definition.data.target_time",
"definition.data.timezone",
"definition.data.trigger_filter",
"definition.data.trigger_filter.condition_groups",
"definition.data.trigger_id",
"definition.data.trigger_subtype",
"definition.data.trigger_type",
"definition.data.unit",
"definition.data.value",
"definition.id",
"definition.links",
"definition.links.next",
"definition.links.next_if_false",
"definition.links.next_if_true",
"definition.temporary_id",
"definition.type",
"updated"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"fields[flow]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"archived",
"created",
"name",
"status",
"trigger_type",
"updated"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"fields[tag]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"name"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"filter": {
"type": "string",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`id`: `any`
`name`: `contains`, `ends-with`, `equals`, `starts-with`
`status`: `equals`
`archived`: `equals`
`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`trigger_type`: `equals`"
},
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"flow-actions",
"tags"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships"
},
"page[cursor]": {
"type": "string",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#pagination"
},
"page[size]": {
"type": "integer",
"description": "Default: 50. Min: 1. Max: 50."
},
"sort": {
"type": "string",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sorting",
"enum": [
"created",
"-created",
"id",
"-id",
"name",
"-name",
"status",
"-status",
"trigger_type",
"-trigger_type",
"updated",
"-updated"
]
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"revision"
]
}
```
***
## klaviyo\_marketing\_get\_messages\_for\_campaign
Get Messages for Campaign
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | Yes | — | The id value |
| `fields[campaign-message]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `fields[campaign]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `fields[image]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `fields[template]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `include` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships) |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"fields[campaign-message]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created_at",
"definition",
"definition.channel",
"definition.content",
"definition.content.bcc_email",
"definition.content.body",
"definition.content.cc_email",
"definition.content.dynamic_image",
"definition.content.from_email",
"definition.content.from_label",
"definition.content.media_url",
"definition.content.preview_text",
"definition.content.reply_to_email",
"definition.content.subject",
"definition.content.title",
"definition.kv_pairs",
"definition.label",
"definition.notification_type",
"definition.options",
"definition.options.badge",
"definition.options.badge.badge_options",
"definition.options.badge.badge_options.badge_config",
"definition.options.badge.badge_options.set_from_property",
"definition.options.badge.badge_options.value",
"definition.options.badge.display",
"definition.options.on_open",
"definition.options.on_open.android_deep_link",
"definition.options.on_open.ios_deep_link",
"definition.options.on_open.type",
"definition.options.play_sound",
"definition.render_options",
"definition.render_options.add_info_link",
"definition.render_options.add_opt_out_language",
"definition.render_options.add_org_prefix",
"definition.render_options.shorten_links",
"send_times",
"updated_at"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"fields[campaign]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"archived",
"audiences",
"audiences.excluded",
"audiences.included",
"created_at",
"name",
"scheduled_at",
"send_options",
"send_options.use_smart_sending",
"send_strategy",
"send_strategy.date",
"send_strategy.datetime",
"send_strategy.method",
"send_strategy.options",
"send_strategy.options.is_local",
"send_strategy.options.send_past_recipients_immediately",
"send_strategy.throttle_percentage",
"send_time",
"status",
"tracking_options",
"tracking_options.add_tracking_params",
"tracking_options.custom_tracking_params",
"tracking_options.is_tracking_clicks",
"tracking_options.is_tracking_opens",
"updated_at"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"fields[image]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"format",
"hidden",
"image_url",
"name",
"size",
"updated_at"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"fields[template]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"amp",
"created",
"editor_type",
"html",
"name",
"text",
"updated"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"campaign",
"image",
"template"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"id",
"revision"
]
}
```
***
## klaviyo\_marketing\_get\_tags\_for\_campaign
Get Tags for Campaign
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | Yes | — | The id value |
| `fields[tag]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"fields[tag]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"name"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"id",
"revision"
]
}
```
***
## klaviyo\_marketing\_get\_tags\_for\_flow
Get Tags for Flow
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | Yes | — | The id value |
| `fields[tag]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"fields[tag]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"name"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"id",
"revision"
]
}
```
***
## klaviyo\_marketing\_get\_template
Get Template
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | Yes | — | The ID of template |
| `fields[template]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The ID of template"
},
"fields[template]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"amp",
"created",
"editor_type",
"html",
"name",
"text",
"updated"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"id",
"revision"
]
}
```
***
## klaviyo\_marketing\_get\_templates
Get Templates
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `fields[template]` | string\[] | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets) |
| `filter` | string | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#filtering\<br\>Allowed](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#filtering\<br\>Allowed) field(s)/operator(s):\
`id`: `any`, `equals`\
`name`: `any`, `contains`, `equals`\
`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`\
`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` |
| `page[cursor]` | string | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#pagination](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#pagination) |
| `sort` | string | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sorting](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sorting) |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields[template]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"amp",
"created",
"editor_type",
"html",
"name",
"text",
"updated"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"filter": {
"type": "string",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`id`: `any`, `equals`
`name`: `any`, `contains`, `equals`
`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`"
},
"page[cursor]": {
"type": "string",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#pagination"
},
"sort": {
"type": "string",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sorting",
"enum": [
"created",
"-created",
"id",
"-id",
"name",
"-name",
"updated",
"-updated"
]
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"revision"
]
}
```
***
## klaviyo\_marketing\_query\_campaign\_values
Query Campaign Values
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `page_cursor` | string | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#pagination](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#pagination) |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
| `data` | object | Yes | — | The data value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page_cursor": {
"type": "string",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#pagination"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"type": {
"type": "string",
"description": "The type value",
"enum": [
"campaign-values-report"
]
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"PCID",
"revision",
"data"
]
}
```
***
## klaviyo\_marketing\_query\_flow\_series
Query Flow Series
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `page_cursor` | string | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#pagination](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#pagination) |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
| `data` | object | Yes | — | The data value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page_cursor": {
"type": "string",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#pagination"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"type": {
"type": "string",
"description": "The type value",
"enum": [
"flow-series-report"
]
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"PCID",
"revision",
"data"
]
}
```
***
## klaviyo\_marketing\_query\_flow\_values
Query Flow Values
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `page_cursor` | string | No | — | For more information please visit [https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#pagination](https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#pagination) |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
| `data` | object | Yes | — | The data value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page_cursor": {
"type": "string",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#pagination"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"type": {
"type": "string",
"description": "The type value",
"enum": [
"flow-values-report"
]
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"PCID",
"revision",
"data"
]
}
```
***
## klaviyo\_marketing\_refresh\_campaign\_recipient\_estimation
Refresh Campaign Recipient Estimation
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
| `data` | object | Yes | — | The data value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"type": {
"type": "string",
"description": "The type value",
"enum": [
"campaign-recipient-estimation-job"
]
},
"id": {
"type": "string",
"description": "The ID of the campaign to perform recipient estimation"
}
},
"required": [
"type",
"id"
]
}
},
"required": [
"PCID",
"revision",
"data"
]
}
```
***
## klaviyo\_marketing\_render\_template
Render Template
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
| `data` | object | Yes | — | The data value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"type": {
"type": "string",
"description": "The type value",
"enum": [
"template"
]
},
"id": {
"type": "string",
"description": "The ID of template"
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"id",
"attributes"
]
}
},
"required": [
"PCID",
"revision",
"data"
]
}
```
***
## klaviyo\_marketing\_send\_campaign
Send Campaign
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
| `data` | object | Yes | — | The data value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"type": {
"type": "string",
"description": "The type value",
"enum": [
"campaign-send-job"
]
},
"id": {
"type": "string",
"description": "The ID of the campaign to send"
}
},
"required": [
"type",
"id"
]
}
},
"required": [
"PCID",
"revision",
"data"
]
}
```
***
## klaviyo\_marketing\_update\_campaign
Update Campaign
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `id` | string | Yes | — | The campaign ID to be retrieved |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
| `data` | object | Yes | — | The data value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The campaign ID to be retrieved"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"type": {
"type": "string",
"description": "The type value",
"enum": [
"campaign"
]
},
"id": {
"type": "string",
"description": "The campaign ID to be retrieved"
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"id",
"attributes"
]
}
},
"required": [
"PCID",
"id",
"revision",
"data"
]
}
```
***
## klaviyo\_marketing\_update\_campaign\_message
Update Campaign Message
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `id` | string | Yes | — | The message ID to be retrieved |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
| `data` | object | Yes | — | The data value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The message ID to be retrieved"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"type": {
"type": "string",
"description": "The type value",
"enum": [
"campaign-message"
]
},
"id": {
"type": "string",
"description": "The message ID to be retrieved"
},
"attributes": {
"type": "object",
"description": "The attributes value"
},
"relationships": {
"type": "object",
"description": "The relationships value"
}
},
"required": [
"type",
"id",
"attributes"
]
}
},
"required": [
"PCID",
"id",
"revision",
"data"
]
}
```
***
## klaviyo\_marketing\_update\_flow
Update Flow Status
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `id` | string | Yes | — | ID of the Flow to update. Ex: XVTP5Q |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
| `data` | object | Yes | — | The data value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "ID of the Flow to update. Ex: XVTP5Q"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"type": {
"type": "string",
"description": "The type value",
"enum": [
"flow"
]
},
"id": {
"type": "string",
"description": "ID of the Flow to update. Ex: XVTP5Q"
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"id",
"attributes"
]
}
},
"required": [
"PCID",
"id",
"revision",
"data"
]
}
```
***
## klaviyo\_marketing\_update\_flow\_action
Update Flow Action
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `id` | string | Yes | — | The id value |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
| `data` | object | Yes | — | The data value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"type": {
"type": "string",
"description": "The type value",
"enum": [
"flow-action"
]
},
"id": {
"type": "string",
"description": "The id value"
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"id",
"attributes"
]
}
},
"required": [
"PCID",
"id",
"revision",
"data"
]
}
```
***
## klaviyo\_marketing\_update\_template
Update Template
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `id` | string | Yes | — | The ID of template |
| `revision` | string | Yes | — | API endpoint revision (format: YYYY-MM-DD\[.suffix]) |
| `data` | object | Yes | — | The data value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The ID of template"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"type": {
"type": "string",
"description": "The type value",
"enum": [
"template"
]
},
"id": {
"type": "string",
"description": "The ID of template"
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"id",
"attributes"
]
}
},
"required": [
"PCID",
"id",
"revision",
"data"
]
}
```