/klaviyo-audiences | Type: Application | PCID required: Yes
Tools
klaviyo_audiences_add_profiles_to_list
Add Profiles to List 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 |
Show inputSchema
Show inputSchema
{
"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": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"profile"
],
"description": "The type value"
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"type",
"id"
]
},
"description": "The data value"
}
},
"required": [
"PCID",
"id",
"revision",
"data"
]
}
klaviyo_audiences_bulk_subscribe_profiles
Bulk Subscribe Profiles Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
data | object | Yes | — | The data value |
Show inputSchema
Show inputSchema
{
"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": [
"profile-subscription-bulk-create-job"
]
},
"attributes": {
"type": "object",
"description": "The attributes value"
},
"relationships": {
"type": "object",
"description": "The relationships value"
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"PCID",
"revision",
"data"
]
}
klaviyo_audiences_bulk_unsubscribe_profiles
Bulk Unsubscribe Profiles Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
data | object | Yes | — | The data value |
Show inputSchema
Show inputSchema
{
"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": [
"profile-subscription-bulk-delete-job"
]
},
"attributes": {
"type": "object",
"description": "The attributes value"
},
"relationships": {
"type": "object",
"description": "The relationships value"
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"PCID",
"revision",
"data"
]
}
klaviyo_audiences_create_event
Create Event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
data | object | Yes | — | The data value |
Show inputSchema
Show inputSchema
{
"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": [
"event"
]
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"PCID",
"revision",
"data"
]
}
klaviyo_audiences_create_list
Create List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
data | object | Yes | — | The data value |
Show inputSchema
Show inputSchema
{
"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": [
"list"
]
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"PCID",
"revision",
"data"
]
}
klaviyo_audiences_create_or_update_profile
Create or Update Profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
additional-fields[profile] | string[] | No | — | Request additional fields not included by default in the response. Supported values: ‘subscriptions’, ‘predictive_analytics’ |
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
data | object | Yes | — | The data value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"additional-fields[profile]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"subscriptions",
"predictive_analytics"
]
},
"description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'"
},
"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": [
"profile"
]
},
"id": {
"type": "string",
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo."
},
"attributes": {
"type": "object",
"description": "The attributes value"
},
"meta": {
"type": "object",
"description": "The meta value"
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"PCID",
"revision",
"data"
]
}
klaviyo_audiences_create_profile
Create Profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
additional-fields[profile] | string[] | No | — | Request additional fields not included by default in the response. Supported values: ‘subscriptions’, ‘predictive_analytics’ |
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
data | object | Yes | — | The data value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"additional-fields[profile]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"subscriptions",
"predictive_analytics"
]
},
"description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'"
},
"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": [
"profile"
]
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"PCID",
"revision",
"data"
]
}
klaviyo_audiences_create_segment
Create Segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
data | object | Yes | — | The data value |
Show inputSchema
Show inputSchema
{
"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": [
"segment"
]
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"PCID",
"revision",
"data"
]
}
klaviyo_audiences_delete_list
Delete List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Primary key that uniquely identifies this list. Generated by Klaviyo. |
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo."
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"id",
"revision"
]
}
klaviyo_audiences_delete_segment
Delete Segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
Show inputSchema
Show inputSchema
{
"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])"
}
},
"required": [
"PCID",
"id",
"revision"
]
}
klaviyo_audiences_get_event
Get Event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | ID of the event |
fields[event] | string[] | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets |
fields[metric] | string[] | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets |
fields[profile] | 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 |
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "ID of the event"
},
"fields[event]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"datetime",
"event_properties",
"timestamp",
"uuid"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"fields[metric]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created",
"integration",
"name",
"updated"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"fields[profile]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created",
"email",
"external_id",
"first_name",
"image",
"last_event_date",
"last_name",
"locale",
"location",
"location.address1",
"location.address2",
"location.city",
"location.country",
"location.ip",
"location.latitude",
"location.longitude",
"location.region",
"location.timezone",
"location.zip",
"organization",
"phone_number",
"properties",
"title",
"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": [
"attributions",
"metric",
"profile"
]
},
"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_audiences_get_events
Get Events Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields[event] | string[] | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets |
fields[metric] | string[] | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets |
fields[profile] | 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>metric_id: equals<br>profile_id: equals<br>profile: has<br>datetime: greater-or-equal, greater-than, less-or-equal, less-than<br>timestamp: 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 |
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: 200. Min: 1. Max: 1000. |
sort | string | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sorting |
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields[event]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"datetime",
"event_properties",
"timestamp",
"uuid"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"fields[metric]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created",
"integration",
"name",
"updated"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"fields[profile]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created",
"email",
"external_id",
"first_name",
"image",
"last_event_date",
"last_name",
"locale",
"location",
"location.address1",
"location.address2",
"location.city",
"location.country",
"location.ip",
"location.latitude",
"location.longitude",
"location.region",
"location.timezone",
"location.zip",
"organization",
"phone_number",
"properties",
"title",
"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<br>Allowed field(s)/operator(s):<br>`metric_id`: `equals`<br>`profile_id`: `equals`<br>`profile`: `has`<br>`datetime`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`"
},
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"attributions",
"metric",
"profile"
]
},
"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: 200. Min: 1. Max: 1000."
},
"sort": {
"type": "string",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sorting",
"enum": [
"datetime",
"-datetime",
"timestamp",
"-timestamp"
]
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"revision"
]
}
klaviyo_audiences_get_list
Get List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Primary key that uniquely identifies this list. Generated by Klaviyo. |
additional-fields[list] | string[] | No | — | Request additional fields not included by default in the response. Supported values: ‘profile_count’ |
fields[flow] | string[] | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets |
fields[list] | string[] | No | — | For more information please visit 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 |
include | string[] | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships |
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo."
},
"additional-fields[list]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"profile_count"
]
},
"description": "Request additional fields not included by default in the response. Supported values: 'profile_count'"
},
"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[list]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created",
"name",
"opt_in_process",
"profile_count",
"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-triggers",
"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_audiences_get_lists
Get Lists Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields[flow] | string[] | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets |
fields[list] | string[] | No | — | For more information please visit 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 |
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: any, equals<br>id: any, equals<br>created: greater-than<br>updated: greater-than |
include | string[] | No | — | For more information please visit 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 |
sort | string | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sorting |
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"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[list]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created",
"name",
"opt_in_process",
"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<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`"
},
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"flow-triggers",
"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",
"-created",
"id",
"-id",
"name",
"-name",
"updated",
"-updated"
]
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"revision"
]
}
klaviyo_audiences_get_lists_for_profile
Get Lists for Profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
fields[list] | string[] | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets |
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"fields[list]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created",
"name",
"opt_in_process",
"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_audiences_get_metric
Get Metric Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Metric ID |
fields[flow] | string[] | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets |
fields[metric] | 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 |
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Metric ID"
},
"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[metric]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created",
"integration",
"name",
"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-triggers"
]
},
"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_audiences_get_metrics
Get Metrics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields[flow] | string[] | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets |
fields[metric] | 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>integration.name: equals<br>integration.category: equals |
include | string[] | No | — | For more information please visit 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 |
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"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[metric]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created",
"integration",
"name",
"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<br>Allowed field(s)/operator(s):<br>`integration.name`: `equals`<br>`integration.category`: `equals`"
},
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"flow-triggers"
]
},
"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"
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"revision"
]
}
klaviyo_audiences_get_profile
Get Profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
additional-fields[profile] | string[] | No | — | Request additional fields not included by default in the response. Supported values: ‘subscriptions’, ‘predictive_analytics’ |
fields[list] | string[] | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets |
fields[profile] | string[] | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets |
fields[push-token] | string[] | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets |
fields[segment] | 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 |
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"additional-fields[profile]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"subscriptions",
"predictive_analytics"
]
},
"description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'"
},
"fields[list]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created",
"name",
"opt_in_process",
"updated"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"fields[profile]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created",
"email",
"external_id",
"first_name",
"image",
"last_event_date",
"last_name",
"locale",
"location",
"location.address1",
"location.address2",
"location.city",
"location.country",
"location.ip",
"location.latitude",
"location.longitude",
"location.region",
"location.timezone",
"location.zip",
"organization",
"phone_number",
"predictive_analytics",
"predictive_analytics.average_days_between_orders",
"predictive_analytics.average_order_value",
"predictive_analytics.churn_probability",
"predictive_analytics.expected_date_of_next_order",
"predictive_analytics.historic_clv",
"predictive_analytics.historic_number_of_orders",
"predictive_analytics.predicted_clv",
"predictive_analytics.predicted_number_of_orders",
"predictive_analytics.ranked_channel_affinity",
"predictive_analytics.total_clv",
"properties",
"subscriptions",
"subscriptions.email",
"subscriptions.email.marketing",
"subscriptions.email.marketing.can_receive_email_marketing",
"subscriptions.email.marketing.consent",
"subscriptions.email.marketing.consent_timestamp",
"subscriptions.email.marketing.custom_method_detail",
"subscriptions.email.marketing.double_optin",
"subscriptions.email.marketing.last_updated",
"subscriptions.email.marketing.list_suppressions",
"subscriptions.email.marketing.method",
"subscriptions.email.marketing.method_detail",
"subscriptions.email.marketing.suppression",
"subscriptions.mobile_push",
"subscriptions.mobile_push.marketing",
"subscriptions.mobile_push.marketing.can_receive_push_marketing",
"subscriptions.mobile_push.marketing.consent",
"subscriptions.mobile_push.marketing.consent_timestamp",
"subscriptions.sms",
"subscriptions.sms.marketing",
"subscriptions.sms.marketing.can_receive_sms_marketing",
"subscriptions.sms.marketing.consent",
"subscriptions.sms.marketing.consent_timestamp",
"subscriptions.sms.marketing.last_updated",
"subscriptions.sms.marketing.method",
"subscriptions.sms.marketing.method_detail",
"subscriptions.sms.transactional",
"subscriptions.sms.transactional.can_receive_sms_transactional",
"subscriptions.sms.transactional.consent",
"subscriptions.sms.transactional.consent_timestamp",
"subscriptions.sms.transactional.last_updated",
"subscriptions.sms.transactional.method",
"subscriptions.sms.transactional.method_detail",
"subscriptions.whatsapp",
"subscriptions.whatsapp.conversational",
"subscriptions.whatsapp.conversational.can_receive",
"subscriptions.whatsapp.conversational.consent",
"subscriptions.whatsapp.conversational.consent_timestamp",
"subscriptions.whatsapp.conversational.created_timestamp",
"subscriptions.whatsapp.conversational.last_updated",
"subscriptions.whatsapp.conversational.metadata",
"subscriptions.whatsapp.conversational.phone_number",
"subscriptions.whatsapp.conversational.valid_until",
"subscriptions.whatsapp.marketing",
"subscriptions.whatsapp.marketing.can_receive",
"subscriptions.whatsapp.marketing.consent",
"subscriptions.whatsapp.marketing.consent_timestamp",
"subscriptions.whatsapp.marketing.created_timestamp",
"subscriptions.whatsapp.marketing.last_updated",
"subscriptions.whatsapp.marketing.metadata",
"subscriptions.whatsapp.marketing.phone_number",
"subscriptions.whatsapp.marketing.valid_until",
"subscriptions.whatsapp.transactional",
"subscriptions.whatsapp.transactional.can_receive",
"subscriptions.whatsapp.transactional.consent",
"subscriptions.whatsapp.transactional.consent_timestamp",
"subscriptions.whatsapp.transactional.created_timestamp",
"subscriptions.whatsapp.transactional.last_updated",
"subscriptions.whatsapp.transactional.metadata",
"subscriptions.whatsapp.transactional.phone_number",
"subscriptions.whatsapp.transactional.valid_until",
"title",
"updated"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"fields[push-token]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"background",
"created",
"enablement_status",
"metadata",
"metadata.app_build",
"metadata.app_id",
"metadata.app_name",
"metadata.app_version",
"metadata.device_id",
"metadata.device_model",
"metadata.environment",
"metadata.klaviyo_sdk",
"metadata.manufacturer",
"metadata.os_name",
"metadata.os_version",
"metadata.sdk_version",
"platform",
"recorded_date",
"token",
"vendor"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"fields[segment]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created",
"definition",
"definition.condition_groups",
"is_active",
"is_processing",
"is_starred",
"name",
"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": [
"lists",
"push-tokens",
"segments"
]
},
"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_audiences_get_profiles
Get Profiles Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
additional-fields[profile] | string[] | No | — | Request additional fields not included by default in the response. Supported values: ‘subscriptions’, ‘predictive_analytics’ |
fields[profile] | string[] | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets |
fields[push-token] | 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>email: any, equals<br>phone_number: any, equals<br>external_id: any, equals<br>_kx: equals<br>created: greater-than, less-than<br>updated: greater-than, less-than<br>subscriptions.email.marketing.list_suppressions.reason: equals<br>subscriptions.email.marketing.list_suppressions.timestamp: greater-or-equal, greater-than, less-or-equal, less-than<br>subscriptions.email.marketing.list_suppressions.list_id: equals<br>subscriptions.email.marketing.suppression.reason: equals<br>subscriptions.email.marketing.suppression.timestamp: 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 |
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 |
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"additional-fields[profile]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"subscriptions",
"predictive_analytics"
]
},
"description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'"
},
"fields[profile]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created",
"email",
"external_id",
"first_name",
"image",
"last_event_date",
"last_name",
"locale",
"location",
"location.address1",
"location.address2",
"location.city",
"location.country",
"location.ip",
"location.latitude",
"location.longitude",
"location.region",
"location.timezone",
"location.zip",
"organization",
"phone_number",
"predictive_analytics",
"predictive_analytics.average_days_between_orders",
"predictive_analytics.average_order_value",
"predictive_analytics.churn_probability",
"predictive_analytics.expected_date_of_next_order",
"predictive_analytics.historic_clv",
"predictive_analytics.historic_number_of_orders",
"predictive_analytics.predicted_clv",
"predictive_analytics.predicted_number_of_orders",
"predictive_analytics.ranked_channel_affinity",
"predictive_analytics.total_clv",
"properties",
"subscriptions",
"subscriptions.email",
"subscriptions.email.marketing",
"subscriptions.email.marketing.can_receive_email_marketing",
"subscriptions.email.marketing.consent",
"subscriptions.email.marketing.consent_timestamp",
"subscriptions.email.marketing.custom_method_detail",
"subscriptions.email.marketing.double_optin",
"subscriptions.email.marketing.last_updated",
"subscriptions.email.marketing.list_suppressions",
"subscriptions.email.marketing.method",
"subscriptions.email.marketing.method_detail",
"subscriptions.email.marketing.suppression",
"subscriptions.mobile_push",
"subscriptions.mobile_push.marketing",
"subscriptions.mobile_push.marketing.can_receive_push_marketing",
"subscriptions.mobile_push.marketing.consent",
"subscriptions.mobile_push.marketing.consent_timestamp",
"subscriptions.sms",
"subscriptions.sms.marketing",
"subscriptions.sms.marketing.can_receive_sms_marketing",
"subscriptions.sms.marketing.consent",
"subscriptions.sms.marketing.consent_timestamp",
"subscriptions.sms.marketing.last_updated",
"subscriptions.sms.marketing.method",
"subscriptions.sms.marketing.method_detail",
"subscriptions.sms.transactional",
"subscriptions.sms.transactional.can_receive_sms_transactional",
"subscriptions.sms.transactional.consent",
"subscriptions.sms.transactional.consent_timestamp",
"subscriptions.sms.transactional.last_updated",
"subscriptions.sms.transactional.method",
"subscriptions.sms.transactional.method_detail",
"subscriptions.whatsapp",
"subscriptions.whatsapp.conversational",
"subscriptions.whatsapp.conversational.can_receive",
"subscriptions.whatsapp.conversational.consent",
"subscriptions.whatsapp.conversational.consent_timestamp",
"subscriptions.whatsapp.conversational.created_timestamp",
"subscriptions.whatsapp.conversational.last_updated",
"subscriptions.whatsapp.conversational.metadata",
"subscriptions.whatsapp.conversational.phone_number",
"subscriptions.whatsapp.conversational.valid_until",
"subscriptions.whatsapp.marketing",
"subscriptions.whatsapp.marketing.can_receive",
"subscriptions.whatsapp.marketing.consent",
"subscriptions.whatsapp.marketing.consent_timestamp",
"subscriptions.whatsapp.marketing.created_timestamp",
"subscriptions.whatsapp.marketing.last_updated",
"subscriptions.whatsapp.marketing.metadata",
"subscriptions.whatsapp.marketing.phone_number",
"subscriptions.whatsapp.marketing.valid_until",
"subscriptions.whatsapp.transactional",
"subscriptions.whatsapp.transactional.can_receive",
"subscriptions.whatsapp.transactional.consent",
"subscriptions.whatsapp.transactional.consent_timestamp",
"subscriptions.whatsapp.transactional.created_timestamp",
"subscriptions.whatsapp.transactional.last_updated",
"subscriptions.whatsapp.transactional.metadata",
"subscriptions.whatsapp.transactional.phone_number",
"subscriptions.whatsapp.transactional.valid_until",
"title",
"updated"
]
},
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets"
},
"fields[push-token]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"background",
"created",
"enablement_status",
"metadata",
"metadata.app_build",
"metadata.app_id",
"metadata.app_name",
"metadata.app_version",
"metadata.device_id",
"metadata.device_model",
"metadata.environment",
"metadata.klaviyo_sdk",
"metadata.manufacturer",
"metadata.os_name",
"metadata.os_version",
"metadata.sdk_version",
"platform",
"recorded_date",
"token",
"vendor"
]
},
"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>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`external_id`: `any`, `equals`<br>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`<br>`updated`: `greater-than`, `less-than`<br>`subscriptions.email.marketing.list_suppressions.reason`: `equals`<br>`subscriptions.email.marketing.list_suppressions.timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`subscriptions.email.marketing.list_suppressions.list_id`: `equals`<br>`subscriptions.email.marketing.suppression.reason`: `equals`<br>`subscriptions.email.marketing.suppression.timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`"
},
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"push-tokens"
]
},
"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: 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",
"-created",
"email",
"-email",
"id",
"-id",
"subscriptions.email.marketing.list_suppressions.timestamp",
"-subscriptions.email.marketing.list_suppressions.timestamp",
"subscriptions.email.marketing.suppression.timestamp",
"-subscriptions.email.marketing.suppression.timestamp",
"updated",
"-updated"
]
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"revision"
]
}
klaviyo_audiences_get_profiles_for_list
Get Profiles for List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Primary key that uniquely identifies this list. Generated by Klaviyo. |
additional-fields[profile] | string[] | No | — | Request additional fields not included by default in the response. Supported values: ‘subscriptions’, ‘predictive_analytics’ |
fields[profile] | 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>email: any, equals<br>phone_number: any, equals<br>push_token: any, equals<br>_kx: equals<br>joined_group_at: 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 |
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 |
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo."
},
"additional-fields[profile]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"subscriptions",
"predictive_analytics"
]
},
"description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'"
},
"fields[profile]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created",
"email",
"external_id",
"first_name",
"image",
"joined_group_at",
"last_event_date",
"last_name",
"locale",
"location",
"location.address1",
"location.address2",
"location.city",
"location.country",
"location.ip",
"location.latitude",
"location.longitude",
"location.region",
"location.timezone",
"location.zip",
"organization",
"phone_number",
"predictive_analytics",
"predictive_analytics.average_days_between_orders",
"predictive_analytics.average_order_value",
"predictive_analytics.churn_probability",
"predictive_analytics.expected_date_of_next_order",
"predictive_analytics.historic_clv",
"predictive_analytics.historic_number_of_orders",
"predictive_analytics.predicted_clv",
"predictive_analytics.predicted_number_of_orders",
"predictive_analytics.ranked_channel_affinity",
"predictive_analytics.total_clv",
"properties",
"subscriptions",
"subscriptions.email",
"subscriptions.email.marketing",
"subscriptions.email.marketing.can_receive_email_marketing",
"subscriptions.email.marketing.consent",
"subscriptions.email.marketing.consent_timestamp",
"subscriptions.email.marketing.custom_method_detail",
"subscriptions.email.marketing.double_optin",
"subscriptions.email.marketing.last_updated",
"subscriptions.email.marketing.list_suppressions",
"subscriptions.email.marketing.method",
"subscriptions.email.marketing.method_detail",
"subscriptions.email.marketing.suppression",
"subscriptions.mobile_push",
"subscriptions.mobile_push.marketing",
"subscriptions.mobile_push.marketing.can_receive_push_marketing",
"subscriptions.mobile_push.marketing.consent",
"subscriptions.mobile_push.marketing.consent_timestamp",
"subscriptions.sms",
"subscriptions.sms.marketing",
"subscriptions.sms.marketing.can_receive_sms_marketing",
"subscriptions.sms.marketing.consent",
"subscriptions.sms.marketing.consent_timestamp",
"subscriptions.sms.marketing.last_updated",
"subscriptions.sms.marketing.method",
"subscriptions.sms.marketing.method_detail",
"subscriptions.sms.transactional",
"subscriptions.sms.transactional.can_receive_sms_transactional",
"subscriptions.sms.transactional.consent",
"subscriptions.sms.transactional.consent_timestamp",
"subscriptions.sms.transactional.last_updated",
"subscriptions.sms.transactional.method",
"subscriptions.sms.transactional.method_detail",
"subscriptions.whatsapp",
"subscriptions.whatsapp.conversational",
"subscriptions.whatsapp.conversational.can_receive",
"subscriptions.whatsapp.conversational.consent",
"subscriptions.whatsapp.conversational.consent_timestamp",
"subscriptions.whatsapp.conversational.created_timestamp",
"subscriptions.whatsapp.conversational.last_updated",
"subscriptions.whatsapp.conversational.metadata",
"subscriptions.whatsapp.conversational.phone_number",
"subscriptions.whatsapp.conversational.valid_until",
"subscriptions.whatsapp.marketing",
"subscriptions.whatsapp.marketing.can_receive",
"subscriptions.whatsapp.marketing.consent",
"subscriptions.whatsapp.marketing.consent_timestamp",
"subscriptions.whatsapp.marketing.created_timestamp",
"subscriptions.whatsapp.marketing.last_updated",
"subscriptions.whatsapp.marketing.metadata",
"subscriptions.whatsapp.marketing.phone_number",
"subscriptions.whatsapp.marketing.valid_until",
"subscriptions.whatsapp.transactional",
"subscriptions.whatsapp.transactional.can_receive",
"subscriptions.whatsapp.transactional.consent",
"subscriptions.whatsapp.transactional.consent_timestamp",
"subscriptions.whatsapp.transactional.created_timestamp",
"subscriptions.whatsapp.transactional.last_updated",
"subscriptions.whatsapp.transactional.metadata",
"subscriptions.whatsapp.transactional.phone_number",
"subscriptions.whatsapp.transactional.valid_until",
"title",
"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<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `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: 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": [
"joined_group_at",
"-joined_group_at"
]
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"id",
"revision"
]
}
klaviyo_audiences_get_profiles_for_segment
Get Profiles for Segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Primary key that uniquely identifies this segment. Generated by Klaviyo. |
additional-fields[profile] | string[] | No | — | Request additional fields not included by default in the response. Supported values: ‘subscriptions’, ‘predictive_analytics’ |
fields[profile] | 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>profile_id: any, equals<br>email: any, equals<br>phone_number: any, equals<br>push_token: any, equals<br>_kx: equals<br>joined_group_at: 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 |
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 |
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Primary key that uniquely identifies this segment. Generated by Klaviyo."
},
"additional-fields[profile]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"subscriptions",
"predictive_analytics"
]
},
"description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'"
},
"fields[profile]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created",
"email",
"external_id",
"first_name",
"image",
"joined_group_at",
"last_event_date",
"last_name",
"locale",
"location",
"location.address1",
"location.address2",
"location.city",
"location.country",
"location.ip",
"location.latitude",
"location.longitude",
"location.region",
"location.timezone",
"location.zip",
"organization",
"phone_number",
"predictive_analytics",
"predictive_analytics.average_days_between_orders",
"predictive_analytics.average_order_value",
"predictive_analytics.churn_probability",
"predictive_analytics.expected_date_of_next_order",
"predictive_analytics.historic_clv",
"predictive_analytics.historic_number_of_orders",
"predictive_analytics.predicted_clv",
"predictive_analytics.predicted_number_of_orders",
"predictive_analytics.ranked_channel_affinity",
"predictive_analytics.total_clv",
"properties",
"subscriptions",
"subscriptions.email",
"subscriptions.email.marketing",
"subscriptions.email.marketing.can_receive_email_marketing",
"subscriptions.email.marketing.consent",
"subscriptions.email.marketing.consent_timestamp",
"subscriptions.email.marketing.custom_method_detail",
"subscriptions.email.marketing.double_optin",
"subscriptions.email.marketing.last_updated",
"subscriptions.email.marketing.list_suppressions",
"subscriptions.email.marketing.method",
"subscriptions.email.marketing.method_detail",
"subscriptions.email.marketing.suppression",
"subscriptions.mobile_push",
"subscriptions.mobile_push.marketing",
"subscriptions.mobile_push.marketing.can_receive_push_marketing",
"subscriptions.mobile_push.marketing.consent",
"subscriptions.mobile_push.marketing.consent_timestamp",
"subscriptions.sms",
"subscriptions.sms.marketing",
"subscriptions.sms.marketing.can_receive_sms_marketing",
"subscriptions.sms.marketing.consent",
"subscriptions.sms.marketing.consent_timestamp",
"subscriptions.sms.marketing.last_updated",
"subscriptions.sms.marketing.method",
"subscriptions.sms.marketing.method_detail",
"subscriptions.sms.transactional",
"subscriptions.sms.transactional.can_receive_sms_transactional",
"subscriptions.sms.transactional.consent",
"subscriptions.sms.transactional.consent_timestamp",
"subscriptions.sms.transactional.last_updated",
"subscriptions.sms.transactional.method",
"subscriptions.sms.transactional.method_detail",
"subscriptions.whatsapp",
"subscriptions.whatsapp.conversational",
"subscriptions.whatsapp.conversational.can_receive",
"subscriptions.whatsapp.conversational.consent",
"subscriptions.whatsapp.conversational.consent_timestamp",
"subscriptions.whatsapp.conversational.created_timestamp",
"subscriptions.whatsapp.conversational.last_updated",
"subscriptions.whatsapp.conversational.metadata",
"subscriptions.whatsapp.conversational.phone_number",
"subscriptions.whatsapp.conversational.valid_until",
"subscriptions.whatsapp.marketing",
"subscriptions.whatsapp.marketing.can_receive",
"subscriptions.whatsapp.marketing.consent",
"subscriptions.whatsapp.marketing.consent_timestamp",
"subscriptions.whatsapp.marketing.created_timestamp",
"subscriptions.whatsapp.marketing.last_updated",
"subscriptions.whatsapp.marketing.metadata",
"subscriptions.whatsapp.marketing.phone_number",
"subscriptions.whatsapp.marketing.valid_until",
"subscriptions.whatsapp.transactional",
"subscriptions.whatsapp.transactional.can_receive",
"subscriptions.whatsapp.transactional.consent",
"subscriptions.whatsapp.transactional.consent_timestamp",
"subscriptions.whatsapp.transactional.created_timestamp",
"subscriptions.whatsapp.transactional.last_updated",
"subscriptions.whatsapp.transactional.metadata",
"subscriptions.whatsapp.transactional.phone_number",
"subscriptions.whatsapp.transactional.valid_until",
"title",
"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<br>Allowed field(s)/operator(s):<br>`profile_id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `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: 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": [
"joined_group_at",
"-joined_group_at"
]
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"id",
"revision"
]
}
klaviyo_audiences_get_segment
Get Segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
additional-fields[segment] | string[] | No | — | Request additional fields not included by default in the response. Supported values: ‘profile_count’ |
fields[flow] | string[] | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets |
fields[segment] | string[] | No | — | For more information please visit 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 |
include | string[] | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#relationships |
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"additional-fields[segment]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"profile_count"
]
},
"description": "Request additional fields not included by default in the response. Supported values: 'profile_count'"
},
"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[segment]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created",
"definition",
"definition.condition_groups",
"is_active",
"is_processing",
"is_starred",
"name",
"profile_count",
"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-triggers",
"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_audiences_get_segments
Get Segments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields[flow] | string[] | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets |
fields[segment] | string[] | No | — | For more information please visit 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 |
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: any, equals<br>id: any, equals<br>created: greater-than<br>updated: greater-than<br>is_active: any, equals<br>is_starred: equals |
include | string[] | No | — | For more information please visit 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 |
sort | string | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sorting |
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"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[segment]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created",
"definition",
"definition.condition_groups",
"is_active",
"is_processing",
"is_starred",
"name",
"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<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`<br>`is_active`: `any`, `equals`<br>`is_starred`: `equals`"
},
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"flow-triggers",
"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",
"-created",
"id",
"-id",
"name",
"-name",
"updated",
"-updated"
]
},
"revision": {
"type": "string",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])"
}
},
"required": [
"PCID",
"revision"
]
}
klaviyo_audiences_get_segments_for_profile
Get Segments for Profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
fields[segment] | string[] | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets |
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"fields[segment]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"created",
"definition",
"definition.condition_groups",
"is_active",
"is_processing",
"is_starred",
"name",
"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_audiences_get_tags_for_list
Get Tags for List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Primary key that uniquely identifies this list. Generated by Klaviyo. |
fields[tag] | string[] | No | — | For more information please visit https://developers.klaviyo.com/en/v2026-01-15/reference/api-overview#sparse-fieldsets |
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo."
},
"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_audiences_get_tags_for_segment
Get Tags for Segment 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 |
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
Show inputSchema
Show inputSchema
{
"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_audiences_merge_profiles
Merge Profiles Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
data | object | Yes | — | The data value |
Show inputSchema
Show inputSchema
{
"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": [
"profile-merge"
]
},
"id": {
"type": "string",
"description": "The ID of the destination profile to merge into"
},
"relationships": {
"type": "object",
"description": "The relationships value"
}
},
"required": [
"type",
"id",
"relationships"
]
}
},
"required": [
"PCID",
"revision",
"data"
]
}
klaviyo_audiences_query_metric_aggregates
Query Metric Aggregates Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
data | object | Yes | — | The data value |
Show inputSchema
Show inputSchema
{
"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": [
"metric-aggregate"
]
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"PCID",
"revision",
"data"
]
}
klaviyo_audiences_query_segment_values
Query Segment Values Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
data | object | Yes | — | The data value |
Show inputSchema
Show inputSchema
{
"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": [
"segment-values-report"
]
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"PCID",
"revision",
"data"
]
}
klaviyo_audiences_remove_profiles_from_list
Remove Profiles from List 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 |
Show inputSchema
Show inputSchema
{
"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": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"profile"
],
"description": "The type value"
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"type",
"id"
]
},
"description": "The data value"
}
},
"required": [
"PCID",
"id",
"revision",
"data"
]
}
klaviyo_audiences_update_list
Update List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Primary key that uniquely identifies this list. Generated by Klaviyo. |
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
data | object | Yes | — | The data value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo."
},
"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": [
"list"
]
},
"id": {
"type": "string",
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo."
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"id",
"attributes"
]
}
},
"required": [
"PCID",
"id",
"revision",
"data"
]
}
klaviyo_audiences_update_profile
Update Profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Primary key that uniquely identifies this profile. Generated by Klaviyo. |
additional-fields[profile] | string[] | No | — | Request additional fields not included by default in the response. Supported values: ‘subscriptions’, ‘predictive_analytics’ |
revision | string | Yes | — | API endpoint revision (format: YYYY-MM-DD[.suffix]) |
data | object | Yes | — | The data value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo."
},
"additional-fields[profile]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"subscriptions",
"predictive_analytics"
]
},
"description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'"
},
"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": [
"profile"
]
},
"id": {
"type": "string",
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo."
},
"attributes": {
"type": "object",
"description": "The attributes value"
},
"meta": {
"type": "object",
"description": "The meta value"
}
},
"required": [
"type",
"id",
"attributes"
]
}
},
"required": [
"PCID",
"id",
"revision",
"data"
]
}
klaviyo_audiences_update_segment
Update Segment 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 |
Show inputSchema
Show inputSchema
{
"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": [
"segment"
]
},
"id": {
"type": "string",
"description": "The id value"
},
"attributes": {
"type": "object",
"description": "The attributes value"
}
},
"required": [
"type",
"id",
"attributes"
]
}
},
"required": [
"PCID",
"id",
"revision",
"data"
]
}

