Documentation Index
Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /klaviyo-settings | Type: Application | PCID required: Yes
klaviyo_settings_create_tag
Create Tag
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
data | object | Yes | — | The data value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"type": {
"type": "string",
"description": "The type value"
},
"attributes": {
"type": "object",
"description": "The attributes value"
},
"relationships": {
"type": "object",
"description": "The relationships value"
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"PCID",
"data"
]
}
klaviyo_settings_create_tag_group
Create Tag Group
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
data | object | Yes | — | The data value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"type": {
"type": "string",
"description": "The type value"
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"PCID",
"data"
]
}
klaviyo_settings_create_webhook
Create Webhook
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
data | object | Yes | — | The data value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"type": {
"type": "string",
"description": "The type value"
},
"attributes": {
"type": "object",
"description": "The attributes value"
},
"relationships": {
"type": "object",
"description": "The relationships value"
}
},
"required": [
"type",
"attributes",
"relationships"
]
}
},
"required": [
"PCID",
"data"
]
}
klaviyo_settings_delete_tag
Delete Tag
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | The Tag ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The Tag ID"
}
},
"required": [
"PCID",
"id"
]
}
klaviyo_settings_delete_tag_group
Delete Tag Group
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | The Tag Group ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The Tag Group ID"
}
},
"required": [
"PCID",
"id"
]
}
klaviyo_settings_get_account
Get Account
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | The ID of the account |
fields[account] | string[] | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The ID of the account"
},
"fields[account]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"contact_information",
"contact_information.default_sender_email",
"contact_information.default_sender_name",
"contact_information.organization_name",
"contact_information.street_address",
"contact_information.street_address.address1",
"contact_information.street_address.address2",
"contact_information.street_address.city",
"contact_information.street_address.country",
"contact_information.street_address.region",
"contact_information.street_address.zip",
"contact_information.website_url",
"industry",
"locale",
"preferred_currency",
"public_api_key",
"test_account",
"timezone"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
}
},
"required": [
"PCID",
"id"
]
}
klaviyo_settings_get_accounts
Get Accounts
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
fields[account] | string[] | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields[account]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"contact_information",
"contact_information.default_sender_email",
"contact_information.default_sender_name",
"contact_information.organization_name",
"contact_information.street_address",
"contact_information.street_address.address1",
"contact_information.street_address.address2",
"contact_information.street_address.city",
"contact_information.street_address.country",
"contact_information.street_address.region",
"contact_information.street_address.zip",
"contact_information.website_url",
"industry",
"locale",
"preferred_currency",
"public_api_key",
"test_account",
"timezone"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
}
},
"required": [
"PCID"
]
}
Get Form
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | The ID of the form |
fields[form] | string[] | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The ID of the form"
},
"fields[form]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ab_test",
"created_at",
"definition",
"definition.versions",
"name",
"status",
"updated_at"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
}
},
"required": [
"PCID",
"id"
]
}
Get Forms
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
fields[form] | string[] | No | — | For more information please visit 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 field(s)/operator(s):<br>id: any, equals<br>name: any, contains, equals<br>ab_test: equals<br>updated_at: greater-or-equal, greater-than, less-or-equal, less-than<br>created_at: greater-or-equal, greater-than, less-or-equal, less-than<br>status: equals |
page[cursor] | string | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#pagination |
page[size] | integer | No | — | Default: 20. Min: 1. Max: 100. |
sort | string | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sorting |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields[form]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ab_test",
"created_at",
"name",
"status",
"updated_at"
]
},
"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<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `contains`, `equals`<br>`ab_test`: `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`"
},
"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: 20. Min: 1. Max: 100."
},
"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",
"updated_at",
"-updated_at"
]
}
},
"required": [
"PCID"
]
}
klaviyo_settings_get_tag
Get Tag
Parameters:
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The Tag ID"
},
"fields[tag-group]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"default",
"exclusive",
"name"
]
},
"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": [
"tag-group"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships"
}
},
"required": [
"PCID",
"id"
]
}
klaviyo_settings_get_tag_group
Get Tag Group
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | The Tag Group ID |
fields[tag-group] | string[] | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The Tag Group ID"
},
"fields[tag-group]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"default",
"exclusive",
"name"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
}
},
"required": [
"PCID",
"id"
]
}
klaviyo_settings_get_tag_groups
Get Tag Groups
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
fields[tag-group] | string[] | No | — | For more information please visit 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 field(s)/operator(s):<br>name: contains, ends-with, equals, starts-with<br>exclusive: equals<br>default: equals |
page[cursor] | string | No | — | For more information please visit 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 |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields[tag-group]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"default",
"exclusive",
"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<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals`"
},
"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": [
"id",
"-id",
"name",
"-name"
]
}
},
"required": [
"PCID"
]
}
Get Tags
Parameters:
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields[tag-group]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"default",
"exclusive",
"name"
]
},
"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<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`"
},
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"tag-group"
]
},
"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": [
"id",
"-id",
"name",
"-name"
]
}
},
"required": [
"PCID"
]
}
klaviyo_settings_get_webhook
Get Webhook
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | The ID of the webhook. |
fields[webhook] | string[] | No | — | For more information please visit 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 |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The ID of the webhook."
},
"fields[webhook]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created_at",
"description",
"enabled",
"endpoint_url",
"name",
"updated_at"
]
},
"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": [
"webhook-topics"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships"
}
},
"required": [
"PCID",
"id"
]
}
klaviyo_settings_get_webhooks
Get Webhooks
Parameters:
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields[webhook]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created_at",
"description",
"enabled",
"endpoint_url",
"name",
"updated_at"
]
},
"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": [
"webhook-topics"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships"
}
},
"required": [
"PCID"
]
}
klaviyo_settings_tag_campaigns
Tag Campaigns
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | The Tag ID |
data | object[] | Yes | — | The data value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The Tag ID"
},
"data": {
"type": "array",
"items": {
"type": "object"
},
"description": "The data value"
}
},
"required": [
"PCID",
"id",
"data"
]
}
klaviyo_settings_tag_flows
Tag Flows
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | The Tag ID |
data | object[] | Yes | — | The data value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The Tag ID"
},
"data": {
"type": "array",
"items": {
"type": "object"
},
"description": "The data value"
}
},
"required": [
"PCID",
"id",
"data"
]
}
klaviyo_settings_tag_lists
Tag Lists
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | The Tag ID |
data | object[] | Yes | — | The data value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The Tag ID"
},
"data": {
"type": "array",
"items": {
"type": "object"
},
"description": "The data value"
}
},
"required": [
"PCID",
"id",
"data"
]
}
klaviyo_settings_tag_segments
Tag Segments
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | The Tag ID |
data | object[] | Yes | — | The data value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The Tag ID"
},
"data": {
"type": "array",
"items": {
"type": "object"
},
"description": "The data value"
}
},
"required": [
"PCID",
"id",
"data"
]
}
klaviyo_settings_update_tag
Update Tag
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | The Tag ID |
data | object | Yes | — | The data value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The Tag ID"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"type": {
"type": "string",
"description": "The type value"
},
"id": {
"type": "string",
"description": "The Tag ID"
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"id",
"attributes"
]
}
},
"required": [
"PCID",
"id",
"data"
]
}
klaviyo_settings_update_tag_group
Update Tag Group
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | The Tag Group ID |
data | object | Yes | — | The data value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The Tag Group ID"
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"type": {
"type": "string",
"description": "The type value"
},
"id": {
"type": "string",
"description": "The Tag Group ID"
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"id",
"attributes"
]
}
},
"required": [
"PCID",
"id",
"data"
]
}
klaviyo_settings_update_webhook
Update Webhook
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | The ID of the webhook. |
data | object | Yes | — | The data value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The ID of the webhook."
},
"data": {
"type": "object",
"description": "The data value",
"properties": {
"type": {
"type": "string",
"description": "The type value"
},
"id": {
"type": "string",
"description": "The ID of the webhook."
},
"attributes": {
"type": "object",
"description": "The attributes value"
},
"relationships": {
"type": "object",
"description": "The relationships value"
}
},
"required": [
"type",
"id",
"attributes"
]
}
},
"required": [
"PCID",
"id",
"data"
]
}